SubscriptionStatus

Enumeration Members

Activated

Activated: "ACTIVATED";

The subscription has completed signup process and has been activated. Active subscription.

---

CancellationInProgress

CancellationInProgress: "CANCELLATION_IN_PROGRESS";

The subscription started but has not completed. cancellation process yet (only for projects with two-step cancellation feature enabled).

---

Cancelled

Cancelled: "CANCELLED";

The subscription has been cancelled.

---

CustomerUnsubscribed

CustomerUnsubscribed: "CUSTOMER_UNSUBSCRIBED";

Deprecated.

Deprecated

Replaced with CANCELLED and CANCELLATION_IN_PROGRESS statuses.

---

Draft

Draft: "DRAFT";

The subscription (or a cart) created on checkout that has not completed signup process.

---

Inactive

Inactive: "INACTIVE";

The subscription has completed signup process by has not yet been activated (for manual activation strategy).

---

OneTimePurchase

OneTimePurchase: "ONE_TIME_PURCHASE";

This status can be assigned to customers that do a one-time purchase.

---

Paused

Paused: "PAUSED";

The subscription has been paused.

---

PendingCancellation

PendingCancellation: "PENDING_CANCELLATION";

The subscription is marked to be automatically cancelled on the next billing moment after the prepaid commitment ends.

---

PendingCustomerCompletion

PendingCustomerCompletion: "PENDING_CUSTOMER_COMPLETION";

The subscription completed first step of two step signup process.

---

PendingInitialPayment

PendingInitialPayment: "PENDING_INITIAL_PAYMENT";

This subscription is currently in the process of completing the initial payment.

---

Rejected

Rejected: "REJECTED";

The subscription has been rejected (for manual activation strategy).

---

Stopped

Stopped: "STOPPED";

The subscription was automatically stopped because the maximum plan commitment was reached