Skip to main content
POST
/
api
/
Subscriptions
Error
A valid request URL is required to generate request examples
{
  "subscriptionId": 1,
  "customerId": 1,
  "merchantSubscriptionRefId": "1234-5678-9101",
  "networkTransactionId": null,
  "billingIntervalType": "Months",
  "billingIntervalCount": 1,
  "subscriptionStatusType": "Current",
  "subscriptionCancelType": "Immediate",
  "initialBillDate": "22-Jun-26",
  "nextBillDate": "22-Jul-26",
  "taxAddress": null,
  "paymentMethodIds": [
    1,
    2
  ],
  "cancelledAt": null,
  "billingPlans": [
    {
      "subscriptionBillingPlanId": 1,
      "subscriptionId": 0,
      "name": "Billing Plan 1",
      "value": 10.99,
      "startDate": "22-Jun-26",
      "cyclesRemaining": -1,
      "cycleCount": 0,
      "valueType": "Standard"
    },
    {
      "subscriptionBillingPlanId": 2,
      "subscriptionId": 0,
      "name": "Billing Plan 2",
      "value": 14.99,
      "startDate": "22-Jul-26",
      "cyclesRemaining": 12,
      "cycleCount": 0,
      "valueType": "Standard"
    }
  ],
  "message": null,
  "paymentProcessor": null,
  "processorMerchantId": null,
  "processorRawResponse": null,
  "currency": null,
  "responseMessage": null,
  "responseCode": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

​
billingFrequency
object
required
​
subscriptionStatusType
string
default:Current
required
Maximum string length: 50
​
subscriptionCancelType
string
default:EndOfCycle
required
Maximum string length: 50
​
startDate
string<date-time>
default:Today's date
required
Maximum string length: 40
​
trialDuration
integer<int32>
default:0
required
Required range: x >= 0
​
customer
object
required
​
subscriptionBillingPlans
object[]
required
​
paymentMethods
object[] | null
​
existingPaymentMethod
object
​
merchantSubscriptionRefId
string | null
Maximum string length: 100
​
trialDurationType
enum<string>
Available options:
Days,
Weeks,
Months,
Years
​
taxAddress
object
​
includeRawProcessorResponse
boolean | null
default:false
​
recycleImmediatePayment
boolean | null
default:false
​
currency
enum<string>
Available options:
USD,
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNH,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LYD,
MAD,
MDL,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
UYU,
UZS,
VEF,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW,
AFN,
KPW,
LRD,
LSL,
STD,
SYP,
TJS,
ZMK,
ZWD,
SLL,
MGA,
HRK,
CDF,
BTN,
BIF

Response

Created

​
subscriptionId
integer<int64>
Required range: 1 <= x <= 1000000000
​
customerId
integer<int64>
Required range: 1 <= x <= 1000000000
​
merchantSubscriptionRefId
string | null
Maximum string length: 100
​
networkTransactionId
string | null
Maximum string length: 100
​
billingIntervalType
string | null
Maximum string length: 50
​
billingIntervalCount
integer<int32>
Required range: 1 <= x <= 1000000000
​
subscriptionStatusType
string | null
Maximum string length: 50
​
subscriptionCancelType
string | null
Maximum string length: 50
​
initialBillDate
string | null
Maximum string length: 20
​
nextBillDate
string | null
Maximum string length: 20
​
taxAddress
object
​
paymentMethodIds
integer<int64>[] | null
​
cancelledAt
string<date-time> | null
Maximum string length: 40
​
billingPlans
object[] | null
​
message
string | null
Maximum string length: 500
​
paymentProcessor
string | null
Maximum string length: 100
​
processorMerchantId
string | null
Maximum string length: 100
​
processorRawResponse
string | null
Maximum string length: 10000
​
currency
string | null
Maximum string length: 3
​
responseMessage
string | null
Maximum string length: 500
​
responseCode
string | null
Maximum string length: 10