Skip to main content
POST
Pause Subscription

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

Flow diagram image

Api Parameters

Authorizations

Authorization
string
header
required

API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'

x-api-key
string
header
required

API Key specific to x-api-key.

Path Parameters

subscription_id
string
required

The Subscription ID of the subscription. Example: 664dc930-88bd-4696-8807-5e0f1fedba0b. The unique Subscription ID of the subscription.

Maximum string length: 36

Response

200 - application/json

A successful response indicating the subscription has been paused.

success
boolean

Indicates whether the operation was successful.

Example:

true

status_code
integer

The HTTP status code of the response.

Example:

200

is_live
boolean

Indicates if the transaction is live or a test transaction.

Example:

false

gateway_response
object

Response details from the gateway.

subscription_details
object

Details of the subscription.