API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

AppSubscriptionStatus enum

Version unstable

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus

Version 2021-01 (Release candidate)

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus

Version 2020-10 (Latest)

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus

Version 2020-07

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus

Version 2020-04

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus

Version 2020-01

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus

Version 2019-10 (Unsupported)

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus

Version 2019-07 (Unsupported)

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus

Version 2019-04 (Unsupported)

The status of the app subscription.

Values

ACCEPTED

The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval.

ACTIVE

The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.

CANCELLED

The app subscription was cancelled by the app.

DECLINED

The app subscription was declined by the merchant.

EXPIRED

The app subscription was not accepted within 2 days of being created.

FROZEN

The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.

PENDING

The app subscription is pending approval by the merchant.

Types that return AppSubscriptionStatus