App Subscription Status
The status of the app subscription.
Anchor to Valid valuesValid values
- Anchor to ACTIVEACTIVE
The app subscription has been approved by the merchant. Active app subscriptions are billed to the shop. After payment, partners receive payouts.
- Anchor to CANCELLEDCANCELLED
The app subscription was cancelled by the app. This could be caused by the app being uninstalled, a new app subscription being activated, or a direct cancellation by the app. This is a terminal state.
- Anchor to DECLINEDDECLINED
The app subscription was declined by the merchant. This is a terminal state.
- Anchor to EXPIREDEXPIRED
The app subscription wasn't approved by the merchant within two days of being created. This is a terminal state.
- Anchor to FROZENFROZEN
The app subscription is on hold due to non-payment. The subscription re-activates after payments resume.
- Anchor to PENDINGPENDING
The app subscription is pending approval by the merchant.
- Anchor to ACCEPTEDACCEPTED•Deprecated
Anchor to FieldsFields
- •OBJECT
A recurring billing agreement that associates an
Appwith a merchant's shop. Each subscription contains one or moreobjects that define the pricing structure. The pricing structure can include recurring charges, usage-based pricing, or both.The subscription tracks billing details including the current period end date, trial days, and
.Merchants must approve subscriptions through a confirmation URL before billing begins. Test subscriptions allow developers to verify billing flows without actual charges.
Learn more about subscription billing and testing charges.