Types > SubscriptionState
Commerce APITypesSubscriptionState
SubscriptionState

Values

ValueDescription
activeThe subscription is active and it will proceed with actions at "next_at"
canceledSubscription was explicitly canceled
doneThe subscription is complete (due to subscription limits)
errorThere was an error with subscription actions, a retry is scheduled
failedAll "error" retries failed
past_dueA subscription in "pending" state is switched to "past_due" once it crosses the deadline
pausedThe subscription was manually paused and will not do anything until unpaused
pendingSubscription created a scheduled fulfillment and is awaiting for fulfillment
pending_paymentPayment requires customer confirmation
skip_nextThe subscription is instructed to skip next tick, will become "active" after that

Used By

Types

Subscription

Preview (typescript)

Loading module