Skip to main content

Pause subscription

CREATE Pause​

You can pause only subscription, not the one-time-order. If you want to pause a subscription please 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 list of subscription pauses related to your organization please use a request similar to this one:

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 please use a request similar to this one:

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 please use a request similar to this one:

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​

To delete a particular subscription pause please use a request similar to this one:

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