Pause subscription

[ { "title":"Testing", "link":"https://docs.solidgate.com/payments/testing/", "text":"Simulate payments to test your integration before launching in production.", "imgSrc":"https://solidgate.com/wp-content/uploads/2022/06/icon-customizable.svg" } , { "title":"Create your payment form", "link":"https://docs.solidgate.com/payments/integrate/payment-form/create-your-payment-form/", "text":"Understand how to integrate the payment form into your product.", "imgSrc":"https://solidgate.com/wp-content/uploads/2022/06/icon-payments.svg" } , { "title":"Subscriptions", "link":"https://docs.solidgate.com/subscriptions/", "text":"Create and maintain a stable and healthy business subscription model.", "imgSrc":"https://solidgate.com/wp-content/uploads/2022/06/icon-global.svg" } ]

Get started
Sign In
Pause subscription
Discover how to pause, resume, and manage subscriptions, including handling renewals

In certain situations, customers might choose to pause their subscription temporarily. This decision can be driven by various factors, such as:

  • inability to use the product for a specific period
  • temporary absence from their usual location

You have the option to pause the subscription via the API, and such paused subscriptions are identified by a distinct status - paused.

Subscriptions can be put on hold for a defined period, but it is important to specify a resume date and time for them. It is not possible to pause the subscription indefinitely.

The API provides functionalities to create, update, delete, and manage the paused status for customer subscriptions. This allows you to set a pause period from a specific point to a designated date and make changes or cancel the pause if needed.

Manage subscription pause
anchor

The subscription pause functionality provides businesses with the ability to temporarily halt an active subscription, allowing customers to suspend their subscription for a defined period. This functionality facilitates a seamless transition between the active status and pause status, giving customers the option to reactivate their subscription or proceed with a permanent cancellation. The subscription details include essential fields such as start_point:date and stop_point:date, which accurately track the duration of the pause period.

Use the subscription pause API request API to pause the subscription, and modify the pause interval with the change subscription pause API request API . If the pause has already started, only the stop_point:date can be modified. Otherwise, both the start_point:date and stop_point:date are available for changes.
To pause the subscription

  1. Go to the Subscriptions page.
  2. Filter subscriptions by the active status to find the needed one.
  3. Click on the ➡️ icon to go to the Subscription details page.
  4. Click on the Create pause button and set the end and start dates.
  5. Click on Apply to confirm changes.

To modify the pause interval

  1. Go to the Subscriptions page.
  2. Filter subscriptions by the paused status to find the needed one.
  3. Click on the ➡️ icon to go to the Subscription details page.
  4. In the Cancel subscription section, change the pause dates considering the following:
    • If the pause is not activated, you can edit both the start and end dates of the pause.
    • If the pause is already activated, you can only edit the end date of the pause.
  5. Click on Apply to confirm changes.
During the subscription pause, no renewals or charges occur, and Guide
Effortlessly receive automatic notifications by subscribing to updates. notifications about status changes are sent with the paused type.

Subscription renewal flows
anchor

When a subscription is paused, it does not renew on its scheduled date.

  • The next billing date is equal to the expired_at field in subscription status Webhook + days of pause:from_date - pause:to_date.
  • In case of resuming the paused subscription manually, Solidgate recalculates the next billing date as expired_at field in subscription status Webhook + days of the current date - pause:from_date.
The next billing date is now calculated with precision down to seconds in addition to days, ensuring a higher level of accuracy in the calculation.

Subscription cancellation
anchor

When a subscription is paused, only the option to Guide
This cancellation type allows the subscriber to continue using the services until the end of the paid period while maintaining the subscription in an active status. hard cancel is available. The option for a Guide
This cancellation type involves an immediate change of the subscription status to cancel. soft cancel is not applicable.

The functionality to pause a subscription is not accessible if the subscription is in a soft cancel status.

Resume a subscription
anchor

Only subscriptions in the paused status can be resumed.

Use the remove subscription pause API request functionality to delete a scheduled pause and revert the subscription to its previous active state.
To resume a subscription

  1. Go to the Subscriptions page.
  2. Filter subscriptions by the paused status to find the needed one.
  3. Click on the ➡️ icon to go to the Subscription details page.
  4. Click on Delete pause to resume the subscription.

Constraints and limitations
anchor

If the settings required for the subscription pause are incomplete or do not meet the pause conditions, an error occurs, and you receive a response with the Guide
Understand why the payment is declined and how you can resolve it. 2.01 error code. The error takes place when:

  • pause from/to date is:
    • absent in the request
    • lower than the current date
  • pause period is lower than 1 day
  • subscription:
    • does not exist
    • status is not equal to active
    • is planned to be cancelled or paused
    • pause:from_date is greater than the subscription expired_at date
    • pause schedule does not exist, start_point:date is null
Looking for help? Contact us
Stay informed with Changelog