SubscriptionStatus

The status of the subscription.

• PENDING - Created and not activated yet. The customer activates it from the activation link, or you call activateSubscription.
• EXPIRED - Ended. No more payments are made, and activateSubscription rejects it.
• TRIALING - In the trial period. With trialAmount, each trial billing period is charged at that amount. Without it, the first payment is made when the trial ends.
• ACTIVE - Active. A payment is made at the end of each billing period.
• PAST_DUE - The most recent payment failed and a retry is scheduled (see retrySchedule). A successful retry makes the subscription ACTIVE again. When the last retry fails, the subscription becomes CANCELED.
• PAUSED - Payments are suspended. The subscription becomes ACTIVE again after pauseIntervalCount billing periods, or when you call resumeSubscription.
• CANCELED - Ended. No more payments are made. A cancellation, a failed last retry or a suspended account sets it. In test mode, a subscription is also canceled at its 12th scheduled payment.

enum SubscriptionStatus {
  PENDING
  EXPIRED
  TRIALING
  ACTIVE
  PAST_DUE
  PAUSED
  CANCELED
}

Values

SubscriptionStatus.PENDING

SubscriptionStatus.EXPIRED

SubscriptionStatus.TRIALING

SubscriptionStatus.ACTIVE

SubscriptionStatus.PAST_DUE

SubscriptionStatus.PAUSED

SubscriptionStatus.CANCELED

Member Of

Subscription object ● SubscriptionEventObject object