Skip to main content

Choose a version:

Anchor to AppEvent

AppEvent

interface

An event related to a Shopify app.

Anchor to FieldsFields

Anchor to appapp

non-null

A Shopify app.

Anchor to occurredAtoccurredAt

non-null

The date and time when the event took place.

Anchor to shopshop

non-null

A Shopify shop.

Anchor to typetype

•AppEventTypes!

non-null

The type of app event.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to CreditApplied CreditApplied •OBJECT: An event that marks that an app credit was applied.
Anchor to CreditFailed CreditFailed •OBJECT: An event that marks that an app credit failed to apply.
Anchor to CreditPending CreditPending •OBJECT: An event that marks that an app credit is pending.
Anchor to OneTimeChargeAccepted OneTimeChargeAccepted •OBJECT: An event that marks that a one-time app charge was accepted by the merchant.
Anchor to OneTimeChargeActivated OneTimeChargeActivated •OBJECT: An event that marks that a one-time app charge was activated.
Anchor to OneTimeChargeDeclined OneTimeChargeDeclined •OBJECT: An event that marks that a one-time app charge was declined by the merchant.
Anchor to OneTimeChargeExpired OneTimeChargeExpired •OBJECT: An event that marks that a one-time app charge expired before the merchant could accept it.
Anchor to RelationshipDeactivated RelationshipDeactivated •OBJECT: An event that marks that an app was deactivated.
Anchor to RelationshipInstalled RelationshipInstalled •OBJECT: An event that marks that an app was installed.
Anchor to RelationshipReactivated RelationshipReactivated •OBJECT: An event that marks that an app was reactivated.
Anchor to RelationshipUninstalled RelationshipUninstalled •OBJECT: An event that marks that an app was uninstalled.
Anchor to SubscriptionApproachingCappedAmount SubscriptionApproachingCappedAmount •OBJECT: An event that marks that a subscription is approaching its capped amount.
Anchor to SubscriptionCappedAmountUpdated SubscriptionCappedAmountUpdated •OBJECT: An event that marks that a subscription had its capped amount updated.
Anchor to SubscriptionChargeAccepted SubscriptionChargeAccepted •OBJECT: An event that marks that a recurring app charge was accepted.
Anchor to SubscriptionChargeActivated SubscriptionChargeActivated •OBJECT: An event that marks that a recurring app charge was activated.
Anchor to SubscriptionChargeCanceled SubscriptionChargeCanceled •OBJECT: An event that marks that a recurring app charge was cancelled.
Anchor to SubscriptionChargeDeclined SubscriptionChargeDeclined •OBJECT: An event that marks that a recurring app charge was declined.
Anchor to SubscriptionChargeExpired SubscriptionChargeExpired •OBJECT: An event that marks that a recurring app charge has expired.
Anchor to SubscriptionChargeFrozen SubscriptionChargeFrozen •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 SubscriptionChargeUnfrozen •OBJECT: An event that marks that a recurring app charge was unfrozen.
Anchor to UsageChargeApplied UsageChargeApplied •OBJECT: An event that marks that an app usage charge was applied.

Was this section helpful?

{

"app": "",

"occurredAt": "",

"shop": "",

"type": ""

}