Skip to main content

SubscriptionStatus

The possible statuses of a subscription.

enum SubscriptionStatus {
  ACTIVE
  CANCELLED
  EXPIRED
  FAILED
  PAUSED
  PENDING
  STALE
}

Values​

SubscriptionStatus.ACTIVE​

The subscription is active and generates orders.

SubscriptionStatus.CANCELLED​

The subscription was cancelled.

SubscriptionStatus.EXPIRED​

The subscription has expired.

SubscriptionStatus.FAILED​

The subscription has failed.

SubscriptionStatus.PAUSED​

The subscription is paused until it's resumed.

SubscriptionStatus.PENDING​

The subscription is being set up. It becomes active once its next order is priced.

SubscriptionStatus.STALE​

The subscription is stale.

Member Of​

searchSubscriptions query ● Subscription object ● SubscriptionExportFilters input ● SubscriptionFilter input ● SubscriptionOrderExportFilters input ● SubscriptionOrderFilter input ● subscriptionPagination query