Choose a version:

AppEvent

interface

An event related to a Shopify app.

Anchor to FieldsFields

Anchor to appapp •App! non-null: A Shopify app.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! 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

CreditApplied

•OBJECT

An event that marks that an app credit was applied.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to appCreditappCredit •AppCredit! non-null: A credit issued to a merchant for an app. Merchants are entitled to app credits under certain circumstances, such as when a paid app subscription is downgraded partway through its billing cycle.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

CreditFailed

•OBJECT

An event that marks that an app credit failed to apply.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to appCreditappCredit •AppCredit! non-null: A credit issued to a merchant for an app. Merchants are entitled to app credits under certain circumstances, such as when a paid app subscription is downgraded partway through its billing cycle.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

CreditPending

•OBJECT

An event that marks that an app credit is pending.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to appCreditappCredit •AppCredit! non-null: A credit issued to a merchant for an app. Merchants are entitled to app credits under certain circumstances, such as when a paid app subscription is downgraded partway through its billing cycle.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

OneTimeChargeAccepted

•OBJECT

An event that marks that a one-time app charge was accepted by the merchant.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppPurchaseOneTime! non-null: A one-time app charge for services and features purchased once by a store. For example, a one-time migration of a merchant's data from one platform to another.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

OneTimeChargeActivated

•OBJECT

An event that marks that a one-time app charge was activated.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppPurchaseOneTime! non-null: A one-time app charge for services and features purchased once by a store. For example, a one-time migration of a merchant's data from one platform to another.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

OneTimeChargeDeclined

•OBJECT

An event that marks that a one-time app charge was declined by the merchant.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppPurchaseOneTime! non-null: A one-time app charge for services and features purchased once by a store. For example, a one-time migration of a merchant's data from one platform to another.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

OneTimeChargeExpired

•OBJECT

An event that marks that a one-time app charge expired before the merchant could accept it.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppPurchaseOneTime! non-null: A one-time app charge for services and features purchased once by a store. For example, a one-time migration of a merchant's data from one platform to another.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

RelationshipDeactivated

•OBJECT

An event that marks that an app was deactivated.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

RelationshipInstalled

•OBJECT

An event that marks that an app was installed.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

RelationshipReactivated

•OBJECT

An event that marks that an app was reactivated.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

RelationshipUninstalled

•OBJECT

An event that marks that an app was uninstalled.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to descriptiondescription •String: More details from the merchant about why they uninstalled the app.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to reasonreason •String: A comma separated list of reasons why the merchant uninstalled the app.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

SubscriptionApproachingCappedAmount

•OBJECT

An event that marks that a subscription is approaching its capped amount.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

SubscriptionCappedAmountUpdated

•OBJECT

An event that marks that a subscription had its capped amount updated.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

SubscriptionChargeAccepted

•OBJECT

An event that marks that a recurring app charge was accepted.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

SubscriptionChargeActivated

•OBJECT

An event that marks that a recurring app charge was activated.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

SubscriptionChargeCanceled

•OBJECT

An event that marks that a recurring app charge was cancelled.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

SubscriptionChargeDeclined

•OBJECT

An event that marks that a recurring app charge was declined.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

SubscriptionChargeExpired

•OBJECT

An event that marks that a recurring app charge has expired.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

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 appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

SubscriptionChargeUnfrozen

•OBJECT

An event that marks that a recurring app charge was unfrozen.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppSubscription! non-null: A recurring charge for use of an app, such as a monthly subscription charge.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

UsageChargeApplied

•OBJECT

An event that marks that an app usage charge was applied.

Anchor to appapp •App! non-null: A Shopify app.
Anchor to chargecharge •AppUsageRecord! non-null: An app charge. This charge varies based on how much the merchant uses the app or a service that the app integrates with.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the event took place.
Anchor to shopshop •Shop! non-null: A Shopify shop.
Anchor to typetype •AppEventTypes! non-null: The type of app event.

Was this section helpful?