Skip to main content
POST
Cancel Subscription

Authorizations

x-api-key
string
header
required

Merchant API Key

x-signature
string
header
required

Generated request signature

Body

application/json
subscriptionId
string<MongoId>
required

Subscription Id of the subscription for which update is needed.

cancelAtEnd
boolean
required

Subscriptions will be canceled at the end of the cycle. If cancelAtEnd is used to cancel a subscription. In response to this API, the subscription remains in the ACTIVE state and cancelAtEnd the parameter is changed to true.Mandatory if cancelNow is not passed

cancelNow
boolean

Subscriptions will be canceled immediately.Manadatory if cancelAtEnd is not passed

Response

200 - application/json

Cancel subscription.

status
string

The response from the API

sub_status
string

Used for internal purposes only

data
object

Contains the updated subscription details.