Skip to main content
POST
Create Subscription

Authorizations

x-revolv3-token
string
header
required

Headers

Client-Request-Id
string

Optional identifier generated by the client to match its own logs with this request.

Allowed values: 1 to 128 characters, letters, digits and ., _, :, -.

Examples: order-12345, 3f2b8c1e-9d4a-4e7b-a1c5-6b0d2e8f7a91 (GUID), checkout:2026-11-02.17, retry_1.order-12345.

A valid value is returned in the Client-Request-Id response header and is stored with Revolv3 request logs, so it can be used when contacting support. An invalid value is ignored and the request is processed normally. Do not send sensitive data in this header.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]{1,128}$

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> | null
default:Today's date
required

Evaluated in UTC (not the merchant timezone). A date (YYYY-MM-DD) or datetime (YYYY-MM-DDThh:mm:ss) is accepted; a trailing Z is not required. Treat today as the current UTC date when deciding bill-on-create vs later.

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
reportGroup
string | null

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