Sign in

v1

latestOpenAPI 3.1.02026-07-26490301.4 KB
Subscription

Cancel subscription

put/subscription/{id}/cancel

Path parameters

idstring required

Gateway subscription ID

Subscription ID

Headers

X-Request-IDstring

Unique ID of request

Request body

cancelDatestring date-time nullable

If <b>cancelDate</b> is not passed or is set to <b>null</b>, subscription will be canceled immediately

reasonstring nullable

Provide the reason for subscription cancellation

sendEmailboolean

Send an email upon subscription cancellation. Set to <b>true</b> by default

keepActiveUntilNextRebillboolean

If passed, <b>cancelDate</b> will be set to 1 hour before the expected rebill date, overriding any previously passed <b>cancelDate</b> value

Example request

{
  "cancelDate": "2020-11-17 13:43:02",
  "reason": "Request from customer"
}

Response

OK

idstring

Gateway subscription ID

status'active' | 'canceled'
type'trial' | 'free-trial' | 'regular'
cyclenumber
valuedescription
0subscription has an initial payment
nsubscription has n recurrent payments
skuNamestring
siteIdstring

Gateway site ID (created on the Merchant portal)

renewalDatestring date-time
cancelDatestring date-time nullable
consumerIdstring

Gateway consumer ID (user ID)

Example response

{
  "status": "active",
  "skuName": "TEST_EN",
  "siteId": "983759353",
  "renewalDate": "2020-04-17 13:43:02",
  "cancelDate": "2020-11-17 13:43:02"
}