On Hold Subscriptions

A Subscription in the on_hold state is not billed by Chargify. There are three ways a Subscription can be put on hold.

  1. From the Subscription Summary page
  2. From the Billing Portal (depending on your settings)
  3. via the API

Put on Hold from Subscription Summary

You can request that a subscription be put on hold by clicking “Put On Hold” from the Actions menu.

Put On Hold

After clicking “Put On Hold”, you will have the opportunity to choose whether to leave the subscription on hold indefinitely, or to enter a date and time at which it should automatically resume. If entered, the date must be at least an hour in the future.

You can later resume a Subscription that is on hold. Please see the section below titled Resume to learn more.

Put On Hold from Billing Portal

If you have configured the “Allow customers to put their subscriptions on hold” setting in Settings -> Billing Portal, then customers with an Active subscription will be given the option to put their billing on hold.

You can find more information about this action in the Billing Portal Interface documentation.

Put On Hold via API

Please consult the Subscription Hold API documentation for more information.

Resume Overview

If a Subscription is in the on_hold state, it can be resumed so that billing will begin again. There are four ways a Subscription can be resumed.

  1. from the Subscription Summary page
  2. from the Billing Portal (depending on your settings)
  3. automatically upon reaching the specified date and time
  4. via the API

Resume from Subscription Summary

You can request that a subscription be resumed by clicking “Resume” from the Actions menu, or from the button on the summary.

After clicking “Resume”, you will have the opportunity to review what is going to happen before confirming.

A Subscription must have been previously put on hold before it can be resumed.

If the subscription is being resumed prior to its normal next renewal date, then it will be made Active and nothing will happen until the renewal date arrives.

If the subscription is being resumed after its normal next renewal date, then resuming will behave like a reactivation, changing the billing date to “now” and charging for the billing period.

Resume from Billing Portal

If you have configured the “Allow Customers Resume Subscriptions” setting in Settings -> Billing Portal, then customers with an On Hold subscription will be given the option to resume their billing.

You can find more information about this action in the Billing Portal Interface documentation.

Resume Automatically

If a date and time to resume was specified when the subscription was put on hold, then the subscription will be automatically resumed around that time.

Resume via API

Please consult the Subscription Resume API documentation for more information.

Examples

Jane has a monthly subscription that renews on March 28th. It is March 21st, and she is about to leave for a two-week vacation. Knowing she will not be at home to receive the package, she puts her subscription on hold until April 4th.

Scenario A: Jane enjoys her vacation and returns as scheduled on April 4th. The system automatically resumes her subscription that day. Since her normal renewal date (the 28th) has passed, the system “reactivates” her subscription. She will be charged for a full billing period on April 4th, and her next renewal date will be May 4th.

Scenario B: Unfortunately, something happens and she has to return early on March 26th. She uses the Billing Portal to manually resume her subscription. Her subscription is returned to Active status, and nothing will happen until her normal renewal on the 28th.