Pause Subscription API
The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.
Key Points
Pause a Subscription
-
Merchants can use this API to pause a subscription, which stops future billing for the customer until the subscription is resumed.
-
During the paused period, the subscription remains active but will not trigger billing or provide services unless resumed.
Subscription Status
-
The subscription will change to paused status in the system.
-
No billing cycles will be processed while the subscription is paused, but the merchant retains control over when to resume the subscription.
Required Parameters
- Subscription ID: The unique identifier of the subscription to be paused.
Flow diagram
Api Parameters
Authorizations
API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'
API Key specific to x-api-key.
Path Parameters
The Subscription ID of the subscription. Example: 664dc930-88bd-4696-8807-5e0f1fedba0b.
36
Response
Indicates whether the operation was successful.
true
The HTTP status code of the response.
200
Indicates if the transaction is live or a test transaction.
false
Response details from the gateway.
Details of the subscription.