The state of a subscription is reported in the state attribute of a subscription. The valid states are:
- trialing
- assessing
- active
- soft_failure
- past_due
- suspended
- canceled
- unpaid
- expired
These states may be further broken down in to 3 categories: Live, Problem, and End of Life.
You should plan on delivering services for any state except an End of Life state.
A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.
An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.
A normal, active subscription. It is not in a trial, and is paid and up to date. This is where you want all your Customers to be :)
Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway, or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action, when needed.
Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.
Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your Dunning settings to have a Final Action of “mark the subscription unpaid”.
While a subscription is marked as unpaid, its period still advances and new charges continue to accrue. However, Chargify does not attempt to automatically collect any overdue balance. Collecting the balance, or eliminating the balance through an Adjustment is your responsibility.
Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to an expiration of the dunning process without payment. See the Reactivation documentation for info on how to restart a canceled subscription.
While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Chargify will not attempt to collect the overdue balance.
Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then, is one that stayed active until it fulfilled its full period.
Reserved and currently unused. May be used in the future for subscriptions that may be restarted (i.e. after being suspended due to non-payment, then payment resumes)