Skip to main content

Pause a subscription

Pausing a subscription temporarily stops renewals from running. When the pause is resumed (by deleting it), the subscription returns to active. Confirm the resulting renewal schedule on the subscription after resuming.

For the concept, status values, and the effect on billing, see Subscription pauses.

CREATE pause​

You can pause only a subscription — not a one-time-order. Only active subscriptions can be paused.

If you want to pause a subscription, use a request similar to this one:

curl -i -X POST \
  'https://staging-api.payments.ai/v1/public-api/organizations/:organizationId/subscription-pauses' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: ApiKey <keyValue>' \
  -d '{
        subscriptionId: "example-id",
        description: "new description"
  }' -v

READ pauses​

To get a list of subscription pauses related to your organization:

curl -X 'GET' \
 'https://staging-api.payments.ai/v1/public-api/organizations/:organizationId/subscription-pauses' \
 -H 'accept: application/json' \
 -H 'Authorization: ApiKey <keyValue>'

READ pause by ID​

To get a particular subscription pause:

curl -X 'GET' \
 'https://staging-api.payments.ai/v1/public-api/organizations/:organizationId/subscription-pauses/:subscriptionPauseId' \
 -H 'accept: application/json' \
 -H 'Authorization: ApiKey <keyValue>'

UPDATE pause​

To update a particular subscription pause:

curl -i -X PATCH \
  'https://staging-api.payments.ai/v1/public-api/organizations/:organizationId/subscription-pauses/:subscriptionPauseId' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: ApiKey <keyValue>' \
  -d '{
        description: "new description"
  }' -v

DELETE pause by ID (resume the subscription)​

Deleting a pause resumes the subscription. The pause transitions to revoked and the subscription returns to active. Confirm the resulting renewal schedule via the API response.

curl -X 'DELETE' \
 'https://staging-api.payments.ai/v1/public-api/organizations/:organizationId/subscription-pauses/:subscriptionPauseId' \
 -H 'accept: application/json' \
 -H 'Authorization: ApiKey <keyValue>'