When the customer cancels their subscriptions you have a few choices to make. Typically you want to consider if the customers' accesses are revoked immediately or if the customer should have the remainder of his pre-paid period before the subscription becomes inactive.

Typically you would maybe want to present the options to Pausing their subscription as well.

Cancelling the subscription

You find the cancel options in the action menu on an active or on hold subscription.

The options are:

Name	Description	Recommendation
At renewal	At the current next end date of the subscription	Use this if you have termed subscriptions and the end date is when the customer is allowed to terminate
Immediately	Immediately sets the status of the subscription to inactive	Use this if you always put customer cancellations in effect immediately. Be aware the subscription is considered inactive.
Just before next billing	Sets the end date to be just before the next billing on the subscription	Use this if you just want it to find the next charge date. Useful if you use evergreen subscriptions.
On a specific date	Input a specific date on which the subscription will cancel

If you want to cancel the subscription via the API you make a call to the /cancel endpoint:

curl --request PUT \
     --url https://api-front.upodi.io/Subscriptions/subscriptionId/cancel \
     --header 'Authorization: Bearer {ApiKey}' \
     --header 'X-version: {version}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"CancelOption":2}'

Regretting the cancel

If the choice for the cancellation was at renewal or Just before next billing the subscription will be in a pending end state. During this time there is still an option to reactive the subscription. Click the actions of the subscription to reactive it.

You can also do it using the API:

curl --request PUT \
     --url https://api-front.upodi.io/Subscriptions/subscriptionId/activate \
     --header 'Authorization: Bearer {ApiKey}' \
     --header 'X-version: {version}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "ReactivationOptions": {
    "ReactivateOption": 2
  }
}
'

Once cancelled

When the subscription has reached the final cancelled state there is no way to reactivate the subscription. Create a new subscription for the customer to correctly indicate a resubscription.