v1

latestOpenAPI 3.1.02026-07-26490301.4 KB

Subscription

Change subscription recurrent plan

put/subscription/{id}

Path parameters

idstring required

Gateway subscription ID

Subscription ID

Headers

X-Request-IDstring

Unique ID of request

Request body

metadataobject

Use to add additional information and related data

Example request

{
  "price": [
    {
      "offset": "5d",
      "amount": 9.99,
      "currency": "USD"
    }
  ]
}

Response

Updated

idstring

Gateway subscription ID

status'active' | 'canceled'

type'trial' | 'free-trial' | 'regular'

cyclenumber

value	description
0	subscription has an initial payment
n	subscription 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"
}