Choose a version:

AppEventTypes

enum

The type of app event.

Anchor to Valid valuesValid values

Anchor to CREDIT_APPLIEDCREDIT_APPLIED: Credit applied
Anchor to CREDIT_FAILEDCREDIT_FAILED: Credit failed
Anchor to CREDIT_PENDINGCREDIT_PENDING: Credit pending
Anchor to ONE_TIME_CHARGE_ACCEPTEDONE_TIME_CHARGE_ACCEPTED: One time charge accepted
Anchor to ONE_TIME_CHARGE_ACTIVATEDONE_TIME_CHARGE_ACTIVATED: One time charge activated
Anchor to ONE_TIME_CHARGE_DECLINEDONE_TIME_CHARGE_DECLINED: One time charge declined
Anchor to ONE_TIME_CHARGE_EXPIREDONE_TIME_CHARGE_EXPIRED: One time charge expired
Anchor to RELATIONSHIP_DEACTIVATEDRELATIONSHIP_DEACTIVATED: Relationship deactivated
Anchor to RELATIONSHIP_INSTALLEDRELATIONSHIP_INSTALLED: Relationship installed
Anchor to RELATIONSHIP_REACTIVATEDRELATIONSHIP_REACTIVATED: Relationship reactivated
Anchor to RELATIONSHIP_UNINSTALLEDRELATIONSHIP_UNINSTALLED: Relationship uninstalled
Anchor to SUBSCRIPTION_APPROACHING_CAPPED_AMOUNTSUBSCRIPTION_APPROACHING_CAPPED_AMOUNT: Subscription is approaching capped amount.
Anchor to SUBSCRIPTION_CAPPED_AMOUNT_UPDATEDSUBSCRIPTION_CAPPED_AMOUNT_UPDATED: Subscription capped amount was updated.
Anchor to SUBSCRIPTION_CHARGE_ACCEPTEDSUBSCRIPTION_CHARGE_ACCEPTED: Subscription charge accepted
Anchor to SUBSCRIPTION_CHARGE_ACTIVATEDSUBSCRIPTION_CHARGE_ACTIVATED: Subscription charge activated
Anchor to SUBSCRIPTION_CHARGE_CANCELEDSUBSCRIPTION_CHARGE_CANCELED: Subscription charge canceled
Anchor to SUBSCRIPTION_CHARGE_DECLINEDSUBSCRIPTION_CHARGE_DECLINED: Subscription charge declined
Anchor to SUBSCRIPTION_CHARGE_EXPIREDSUBSCRIPTION_CHARGE_EXPIRED: Subscription charge expired
Anchor to SUBSCRIPTION_CHARGE_FROZENSUBSCRIPTION_CHARGE_FROZEN: Subscription charge frozen
Anchor to SUBSCRIPTION_CHARGE_UNFROZENSUBSCRIPTION_CHARGE_UNFROZEN: Subscription charge unfrozen
Anchor to USAGE_CHARGE_APPLIEDUSAGE_CHARGE_APPLIED: Usage charge applied

Was this section helpful?

Anchor to FieldsFields

Anchor to App.events App.events •ARGUMENT: A Shopify app.
Anchor to AppEvent.type AppEvent.type •INTERFACE: An event related to a Shopify app.
Anchor to CreditApplied.type CreditApplied.type •OBJECT: An event that marks that an app credit was applied.
Anchor to CreditFailed.type CreditFailed.type •OBJECT: An event that marks that an app credit failed to apply.
Anchor to CreditPending.type CreditPending.type •OBJECT: An event that marks that an app credit is pending.
Anchor to OneTimeChargeAccepted.type OneTimeChargeAccepted.type •OBJECT: An event that marks that a one-time app charge was accepted by the merchant.
Anchor to OneTimeChargeActivated.type OneTimeChargeActivated.type •OBJECT: An event that marks that a one-time app charge was activated.
Anchor to OneTimeChargeDeclined.type OneTimeChargeDeclined.type •OBJECT: An event that marks that a one-time app charge was declined by the merchant.
Anchor to OneTimeChargeExpired.type OneTimeChargeExpired.type •OBJECT: An event that marks that a one-time app charge expired before the merchant could accept it.
Anchor to RelationshipDeactivated.type RelationshipDeactivated.type •OBJECT: An event that marks that an app was deactivated.
Anchor to RelationshipInstalled.type RelationshipInstalled.type •OBJECT: An event that marks that an app was installed.
Anchor to RelationshipReactivated.type RelationshipReactivated.type •OBJECT: An event that marks that an app was reactivated.
Anchor to RelationshipUninstalled.type RelationshipUninstalled.type •OBJECT: An event that marks that an app was uninstalled.
Anchor to SubscriptionApproachingCappedAmount.type SubscriptionApproachingCappedAmount.type •OBJECT: An event that marks that a subscription is approaching its capped amount.
Anchor to SubscriptionCappedAmountUpdated.type SubscriptionCappedAmountUpdated.type •OBJECT: An event that marks that a subscription had its capped amount updated.
Anchor to SubscriptionChargeAccepted.type SubscriptionChargeAccepted.type •OBJECT: An event that marks that a recurring app charge was accepted.
Anchor to SubscriptionChargeActivated.type SubscriptionChargeActivated.type •OBJECT: An event that marks that a recurring app charge was activated.
Anchor to SubscriptionChargeCanceled.type SubscriptionChargeCanceled.type •OBJECT: An event that marks that a recurring app charge was cancelled.
Anchor to SubscriptionChargeDeclined.type SubscriptionChargeDeclined.type •OBJECT: An event that marks that a recurring app charge was declined.
Anchor to SubscriptionChargeExpired.type SubscriptionChargeExpired.type •OBJECT: An event that marks that a recurring app charge has expired.
Anchor to SubscriptionChargeFrozen.type SubscriptionChargeFrozen.type •OBJECT: An event that marks that a recurring app charge has been suspended. For example, if a merchant stops paying their bills, or closes their store, then Shopify suspends the recurring app charge.
Anchor to SubscriptionChargeUnfrozen.type SubscriptionChargeUnfrozen.type •OBJECT: An event that marks that a recurring app charge was unfrozen.
Anchor to UsageChargeApplied.type UsageChargeApplied.type •OBJECT: An event that marks that an app usage charge was applied.

Was this section helpful?