Initiate Subscription Cancelation

In order to cancel a subscription/unsubscribe a user from Centili platform using Centili Payment API, you need to send an HTTP POST request with Content-Type: application/json composed of parameters with associated values.

Before initiating a cancel subscription request you will need to obtain an access token

URL to which a request should be sent

https://capi.centili.com/payments/v3/subscriptions/{subscriptionid}/cancel

POST subscription cancel request

https://capi.centili.com/payments/v3/subscriptions/{subscriptionId}/cancel HTTP/1.1
Host: api.centili.com:443
Content type: application/json
Authorization: bearer token

Request parameters

Parameter	Description	Example	Required as
subscriptionid	Unique identifier of subscription in Centili system.	6000557067	mandatory

POST subscription cancel response

Once a request is received, Centili will synchronously respond with an appropriate HTTP response and a list of parameters and values in JSON format:

👍
200
Subscription cancel transaction created

HTTP/1.1 200 OK
Content-Type: application/json

{
    "transactionId": "17000002453",
    "subscriptionId": "6000557067",
    "clientData": {
        "clientUserId": null,
        "clientReference": null
    }
}

Response parameters:

Parameter	Description	Example
transactionId	Unique identifier of a transaction in Centili system.	17000002453
subscriptionId	Unique identifier of a subscription in Centili system.	6000557067
clientData	Client related parameters. See (https://dev.centili.com/docs/subscription-renew#client-data)	{ "clientUserId": "usrId1983", "clientReference": "appID1" }

Client data

Parameter	Description	Example
clientUserId	Identification of the customer.	usrId1983
clientReference	Unique identification parameter under your system (pass-through variable).	appID1

❗️
4xx client error / 5xx server error
400 - Subscription cannot be canceled - check message for details.
401 - Invalid credentials
404 - Subscription not found
429 - Number of attempts over the max retry limit, request can not be retried.
500 - Request can not be processed at the current time

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "code": "NOT_FOUND",
    "message": "Subscription does not exist"
}

Paramter	Description	Example
code	Error response code	NOT_FOUND
message	Error response message	Subscription does not exist