Skip to main content

Reactivate a subscription

Reactivation reverses a cancellation on a subscription. Whether a given subscription is reactivable depends on its state — confirm via the API response. If the reactivation call returns an error, create a new subscription instead.

For the concept, see Subscription reactivation.

CREATE reactivation​

The description field records the reason for reactivation — short free text.

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

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

READ reactivations​

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

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

READ reactivation by ID​

To get a particular subscription reactivation:

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