Skip to main content
Create Subscription
curl --request POST \
  --url https://api.revolv3.com/api/Subscriptions \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
  "paymentMethods": [
    {
      "paymentMethodTypes": [
        1
      ],
      "priority": 0,
      "taxAmount": 2.56,
      "originalNetworkTransactionId": "102656693ac3ca6e0cdafbfe89ab99",
      "billingAddress": {
        "addressId": null,
        "addressLine1": "100 Main Street",
        "addressLine2": null,
        "city": "Irvine",
        "state": "CA",
        "postalCode": "92602",
        "phoneNumber": null,
        "email": null,
        "country": "US"
      },
      "creditCard": {
        "paymentAccountNumber": "4111111111111111",
        "expirationDate": "1025",
        "securityCode": null,
        "networkToken": null,
        "processingMethodType": 5
      },
      "ach": null,
      "googlePay": null,
      "applePay": null,
      "merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-44d",
      "billingFirstName": "John",
      "billingLastName": "Doe",
      "billingFullName": null
    },
    {
      "paymentMethodTypes": [
        1
      ],
      "priority": 1,
      "taxAmount": 1.34,
      "originalNetworkTransactionId": null,
      "billingAddress": {
        "addressId": null,
        "addressLine1": "100 Main Street 2",
        "addressLine2": null,
        "city": "Irvine ",
        "state": "CA",
        "postalCode": "9260e",
        "phoneNumber": null,
        "email": null,
        "country": "US"
      },
      "creditCard": {
        "paymentAccountNumber": "5555555555554444",
        "expirationDate": "03/2030",
        "securityCode": null,
        "networkToken": null,
        "processingMethodType": 5
      },
      "ach": null,
      "googlePay": null,
      "applePay": null,
      "merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-4rf4344",
      "billingFirstName": "John",
      "billingLastName": "Doe",
      "billingFullName": null
    }
  ],
  "existingPaymentMethod": null,
  "merchantSubscriptionRefId": "1234-5678-9101",
  "billingFrequency": {
    "intervalType": 1,
    "intervalCount": 1
  },
  "subscriptionStatusType": "current",
  "subscriptionCancelType": "immediate",
  "startDate": "2025-09-08T00:00:00Z",
  "trialDuration": 0,
  "trialDurationType": 1,
  "taxAddress": {
    "addressId": null,
    "addressLine1": "101 Update Street",
    "addressLine2": null,
    "city": "Irvine",
    "state": "CA",
    "postalCode": "92602",
    "phoneNumber": null,
    "email": null,
    "country": "US"
  },
  "includeRawProcessorResponse": false,
  "customer": {
    "id": 1,
    "firstName": null,
    "lastName": null
  },
  "subscriptionBillingPlans": [
    {
      "name": "Billing Plan 1",
      "value": 10.99,
      "cycleCount": -1,
      "valueType": "Standard",
      "startCycleDelay": 0
    },
    {
      "name": "Billing Plan 2",
      "value": 14.99,
      "cycleCount": 12,
      "valueType": "Standard",
      "startCycleDelay": 1
    }
  ],
  "recycleImmediatePayment": false,
  "currency": 1
}'
{
  "subscriptionId": 1,
  "customerId": 1,
  "merchantSubscriptionRefId": "1234-5678-9101",
  "networkTransactionId": null,
  "billingIntervalType": "Months",
  "billingIntervalCount": 1,
  "subscriptionStatusType": "Current",
  "subscriptionCancelType": "Immediate",
  "initialBillDate": "08-Sep-25",
  "nextBillDate": "08-Oct-25",
  "taxAddress": null,
  "paymentMethodIds": [
    1,
    2
  ],
  "cancelledAt": null,
  "billingPlans": [
    {
      "subscriptionBillingPlanId": 1,
      "subscriptionId": 0,
      "name": "Billing Plan 1",
      "value": 10.99,
      "startDate": "08-Sep-25",
      "cyclesRemaining": -1,
      "cycleCount": 0,
      "valueType": "Standard"
    },
    {
      "subscriptionBillingPlanId": 2,
      "subscriptionId": 0,
      "name": "Billing Plan 2",
      "value": 14.99,
      "startDate": "08-Oct-25",
      "cyclesRemaining": 12,
      "cycleCount": 0,
      "valueType": "Standard"
    }
  ],
  "message": null,
  "paymentProcessor": null,
  "processorMerchantId": null,
  "processorRawResponse": null,
  "currency": null
}

Body

​
billingFrequency
object
required
​
customer
object
required
​
subscriptionBillingPlans
object[]
required
​
paymentMethods
object[] | null
​
existingPaymentMethod
object
​
merchantSubscriptionRefId
string | null
​
subscriptionStatusType
string | null
default:Current
​
subscriptionCancelType
string | null
default:EndOfCycle
​
startDate
string<date-time> | null
default:Today's date
​
trialDuration
integer | null
default:0
​
trialDurationType
enum<integer>
Available options:
1,
2,
3,
4
​
taxAddress
object
​
includeRawProcessorResponse
boolean | null
default:false
​
recycleImmediatePayment
boolean | null
default:false
​
currency
enum<integer>
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122,
123,
124,
125,
126,
127,
129,
130,
131,
132,
133,
134,
135,
136,
137,
138,
139,
140,
141,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
156

Response

Created

​
subscriptionId
integer
​
customerId
integer
​
merchantSubscriptionRefId
string | null
​
networkTransactionId
string | null
​
billingIntervalType
string | null
​
billingIntervalCount
integer
​
subscriptionStatusType
string | null
​
subscriptionCancelType
string | null
​
initialBillDate
string | null
​
nextBillDate
string | null
​
taxAddress
object
​
paymentMethodIds
integer[] | null
​
cancelledAt
string<date-time> | null
​
billingPlans
object[] | null
​
message
string | null
​
paymentProcessor
string | null
​
processorMerchantId
string | null
​
processorRawResponse
string | null
​
currency
string | null
⌘I