Create Subscription
curl --request POST \
--url https://api-sandbox.revolv3.com/api/Subscriptions \
--header 'Content-Type: application/json-patch+json' \
--header 'x-revolv3-token: <api-key>' \
--data '
{
"paymentMethods": [
{
"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
},
"ach": null,
"googlePay": null,
"applePay": null,
"merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-44d",
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": null
},
{
"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
},
"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": "Days",
"intervalCount": 1
},
"subscriptionStatusType": "current",
"subscriptionCancelType": "immediate",
"startDate": "2026-07-01T00:00:00Z",
"trialDuration": 0,
"trialDurationType": "Days",
"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": "USD"
}
'import requests
url = "https://api-sandbox.revolv3.com/api/Subscriptions"
payload = {
"paymentMethods": [
{
"priority": 0,
"taxAmount": 2.56,
"originalNetworkTransactionId": "102656693ac3ca6e0cdafbfe89ab99",
"billingAddress": {
"addressId": None,
"addressLine1": "100 Main Street",
"addressLine2": None,
"city": "Irvine",
"state": "CA",
"postalCode": "92602",
"phoneNumber": None,
"email": None,
"country": "US"
},
"creditCard": {
"paymentAccountNumber": "4111111111111111",
"expirationDate": "1025",
"securityCode": None,
"networkToken": None
},
"ach": None,
"googlePay": None,
"applePay": None,
"merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-44d",
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": None
},
{
"priority": 1,
"taxAmount": 1.34,
"originalNetworkTransactionId": None,
"billingAddress": {
"addressId": None,
"addressLine1": "100 Main Street 2",
"addressLine2": None,
"city": "Irvine ",
"state": "CA",
"postalCode": "9260e",
"phoneNumber": None,
"email": None,
"country": "US"
},
"creditCard": {
"paymentAccountNumber": "5555555555554444",
"expirationDate": "03/2030",
"securityCode": None,
"networkToken": None
},
"ach": None,
"googlePay": None,
"applePay": None,
"merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-4rf4344",
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": None
}
],
"existingPaymentMethod": None,
"merchantSubscriptionRefId": "1234-5678-9101",
"billingFrequency": {
"intervalType": "Days",
"intervalCount": 1
},
"subscriptionStatusType": "current",
"subscriptionCancelType": "immediate",
"startDate": "2026-07-01T00:00:00Z",
"trialDuration": 0,
"trialDurationType": "Days",
"taxAddress": {
"addressId": None,
"addressLine1": "101 Update Street",
"addressLine2": None,
"city": "Irvine",
"state": "CA",
"postalCode": "92602",
"phoneNumber": None,
"email": None,
"country": "US"
},
"includeRawProcessorResponse": False,
"customer": {
"id": 1,
"firstName": None,
"lastName": None
},
"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": "USD"
}
headers = {
"x-revolv3-token": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-revolv3-token': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
paymentMethods: [
{
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
},
ach: null,
googlePay: null,
applePay: null,
merchantPaymentMethodRefId: 'payment-method-ref-id_hgays-213-44d',
billingFirstName: 'John',
billingLastName: 'Doe',
billingFullName: null
},
{
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
},
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: 'Days', intervalCount: 1},
subscriptionStatusType: 'current',
subscriptionCancelType: 'immediate',
startDate: '2026-07-01T00:00:00Z',
trialDuration: 0,
trialDurationType: 'Days',
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: 'USD'
})
};
fetch('https://api-sandbox.revolv3.com/api/Subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.revolv3.com/api/Subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'paymentMethods' => [
[
'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
],
'ach' => null,
'googlePay' => null,
'applePay' => null,
'merchantPaymentMethodRefId' => 'payment-method-ref-id_hgays-213-44d',
'billingFirstName' => 'John',
'billingLastName' => 'Doe',
'billingFullName' => null
],
[
'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
],
'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' => 'Days',
'intervalCount' => 1
],
'subscriptionStatusType' => 'current',
'subscriptionCancelType' => 'immediate',
'startDate' => '2026-07-01T00:00:00Z',
'trialDuration' => 0,
'trialDurationType' => 'Days',
'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' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"x-revolv3-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.revolv3.com/api/Subscriptions"
payload := strings.NewReader("{\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": 2.56,\n \"originalNetworkTransactionId\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"4111111111111111\",\n \"expirationDate\": \"1025\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-44d\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n },\n {\n \"priority\": 1,\n \"taxAmount\": 1.34,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street 2\",\n \"addressLine2\": null,\n \"city\": \"Irvine \",\n \"state\": \"CA\",\n \"postalCode\": \"9260e\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"5555555555554444\",\n \"expirationDate\": \"03/2030\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-4rf4344\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n }\n ],\n \"existingPaymentMethod\": null,\n \"merchantSubscriptionRefId\": \"1234-5678-9101\",\n \"billingFrequency\": {\n \"intervalType\": \"Days\",\n \"intervalCount\": 1\n },\n \"subscriptionStatusType\": \"current\",\n \"subscriptionCancelType\": \"immediate\",\n \"startDate\": \"2026-07-01T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": {\n \"id\": 1,\n \"firstName\": null,\n \"lastName\": null\n },\n \"subscriptionBillingPlans\": [\n {\n \"name\": \"Billing Plan 1\",\n \"value\": 10.99,\n \"cycleCount\": -1,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 0\n },\n {\n \"name\": \"Billing Plan 2\",\n \"value\": 14.99,\n \"cycleCount\": 12,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 1\n }\n ],\n \"recycleImmediatePayment\": false,\n \"currency\": \"USD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-revolv3-token", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.revolv3.com/api/Subscriptions")
.header("x-revolv3-token", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": 2.56,\n \"originalNetworkTransactionId\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"4111111111111111\",\n \"expirationDate\": \"1025\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-44d\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n },\n {\n \"priority\": 1,\n \"taxAmount\": 1.34,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street 2\",\n \"addressLine2\": null,\n \"city\": \"Irvine \",\n \"state\": \"CA\",\n \"postalCode\": \"9260e\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"5555555555554444\",\n \"expirationDate\": \"03/2030\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-4rf4344\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n }\n ],\n \"existingPaymentMethod\": null,\n \"merchantSubscriptionRefId\": \"1234-5678-9101\",\n \"billingFrequency\": {\n \"intervalType\": \"Days\",\n \"intervalCount\": 1\n },\n \"subscriptionStatusType\": \"current\",\n \"subscriptionCancelType\": \"immediate\",\n \"startDate\": \"2026-07-01T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": {\n \"id\": 1,\n \"firstName\": null,\n \"lastName\": null\n },\n \"subscriptionBillingPlans\": [\n {\n \"name\": \"Billing Plan 1\",\n \"value\": 10.99,\n \"cycleCount\": -1,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 0\n },\n {\n \"name\": \"Billing Plan 2\",\n \"value\": 14.99,\n \"cycleCount\": 12,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 1\n }\n ],\n \"recycleImmediatePayment\": false,\n \"currency\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.revolv3.com/api/Subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-revolv3-token"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": 2.56,\n \"originalNetworkTransactionId\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"4111111111111111\",\n \"expirationDate\": \"1025\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-44d\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n },\n {\n \"priority\": 1,\n \"taxAmount\": 1.34,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street 2\",\n \"addressLine2\": null,\n \"city\": \"Irvine \",\n \"state\": \"CA\",\n \"postalCode\": \"9260e\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"5555555555554444\",\n \"expirationDate\": \"03/2030\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-4rf4344\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n }\n ],\n \"existingPaymentMethod\": null,\n \"merchantSubscriptionRefId\": \"1234-5678-9101\",\n \"billingFrequency\": {\n \"intervalType\": \"Days\",\n \"intervalCount\": 1\n },\n \"subscriptionStatusType\": \"current\",\n \"subscriptionCancelType\": \"immediate\",\n \"startDate\": \"2026-07-01T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": {\n \"id\": 1,\n \"firstName\": null,\n \"lastName\": null\n },\n \"subscriptionBillingPlans\": [\n {\n \"name\": \"Billing Plan 1\",\n \"value\": 10.99,\n \"cycleCount\": -1,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 0\n },\n {\n \"name\": \"Billing Plan 2\",\n \"value\": 14.99,\n \"cycleCount\": 12,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 1\n }\n ],\n \"recycleImmediatePayment\": false,\n \"currency\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"subscriptionId": 1,
"customerId": 1,
"merchantSubscriptionRefId": "1234-5678-9101",
"networkTransactionId": null,
"billingIntervalType": "Months",
"billingIntervalCount": 1,
"subscriptionStatusType": "Current",
"subscriptionCancelType": "Immediate",
"initialBillDate": "01.07.2026",
"nextBillDate": "01.08.2026",
"taxAddress": null,
"paymentMethodIds": [
1,
2
],
"cancelledAt": null,
"billingPlans": [
{
"subscriptionBillingPlanId": 1,
"subscriptionId": 0,
"name": "Billing Plan 1",
"value": 10.99,
"startDate": "01.07.2026",
"cyclesRemaining": -1,
"cycleCount": 0,
"valueType": "Standard"
},
{
"subscriptionBillingPlanId": 2,
"subscriptionId": 0,
"name": "Billing Plan 2",
"value": 14.99,
"startDate": "01.08.2026",
"cyclesRemaining": 12,
"cycleCount": 0,
"valueType": "Standard"
}
],
"message": null,
"paymentProcessor": null,
"processorMerchantId": null,
"processorRawResponse": null,
"currency": null,
"responseMessage": null,
"responseCode": null
}{
"message": "Unable to perform the request action with provided data."
}{
"message": "Attempted to perform an unauthorized operation."
}{
"message": "Unable to find an entity with the provided data."
}{
"message": "PaymentMethodAuthorizationId is being processed in another request."
}Subscriptions
Create Subscription
Creates a new subscription for a customer, linking a recurring billing plan to their payment method. You must provide details such as the customer, start date, and payment method.
Once created, the system will automatically generate invoices and process payments based on the defined billing interval. Optional settings may include trial periods or metadata for internal tracking.
This endpoint is typically used during customer onboarding, upgrades, or checkout flows that involve recurring services.
POST
/
api
/
Subscriptions
Create Subscription
curl --request POST \
--url https://api-sandbox.revolv3.com/api/Subscriptions \
--header 'Content-Type: application/json-patch+json' \
--header 'x-revolv3-token: <api-key>' \
--data '
{
"paymentMethods": [
{
"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
},
"ach": null,
"googlePay": null,
"applePay": null,
"merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-44d",
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": null
},
{
"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
},
"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": "Days",
"intervalCount": 1
},
"subscriptionStatusType": "current",
"subscriptionCancelType": "immediate",
"startDate": "2026-07-01T00:00:00Z",
"trialDuration": 0,
"trialDurationType": "Days",
"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": "USD"
}
'import requests
url = "https://api-sandbox.revolv3.com/api/Subscriptions"
payload = {
"paymentMethods": [
{
"priority": 0,
"taxAmount": 2.56,
"originalNetworkTransactionId": "102656693ac3ca6e0cdafbfe89ab99",
"billingAddress": {
"addressId": None,
"addressLine1": "100 Main Street",
"addressLine2": None,
"city": "Irvine",
"state": "CA",
"postalCode": "92602",
"phoneNumber": None,
"email": None,
"country": "US"
},
"creditCard": {
"paymentAccountNumber": "4111111111111111",
"expirationDate": "1025",
"securityCode": None,
"networkToken": None
},
"ach": None,
"googlePay": None,
"applePay": None,
"merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-44d",
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": None
},
{
"priority": 1,
"taxAmount": 1.34,
"originalNetworkTransactionId": None,
"billingAddress": {
"addressId": None,
"addressLine1": "100 Main Street 2",
"addressLine2": None,
"city": "Irvine ",
"state": "CA",
"postalCode": "9260e",
"phoneNumber": None,
"email": None,
"country": "US"
},
"creditCard": {
"paymentAccountNumber": "5555555555554444",
"expirationDate": "03/2030",
"securityCode": None,
"networkToken": None
},
"ach": None,
"googlePay": None,
"applePay": None,
"merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-4rf4344",
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": None
}
],
"existingPaymentMethod": None,
"merchantSubscriptionRefId": "1234-5678-9101",
"billingFrequency": {
"intervalType": "Days",
"intervalCount": 1
},
"subscriptionStatusType": "current",
"subscriptionCancelType": "immediate",
"startDate": "2026-07-01T00:00:00Z",
"trialDuration": 0,
"trialDurationType": "Days",
"taxAddress": {
"addressId": None,
"addressLine1": "101 Update Street",
"addressLine2": None,
"city": "Irvine",
"state": "CA",
"postalCode": "92602",
"phoneNumber": None,
"email": None,
"country": "US"
},
"includeRawProcessorResponse": False,
"customer": {
"id": 1,
"firstName": None,
"lastName": None
},
"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": "USD"
}
headers = {
"x-revolv3-token": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-revolv3-token': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
paymentMethods: [
{
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
},
ach: null,
googlePay: null,
applePay: null,
merchantPaymentMethodRefId: 'payment-method-ref-id_hgays-213-44d',
billingFirstName: 'John',
billingLastName: 'Doe',
billingFullName: null
},
{
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
},
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: 'Days', intervalCount: 1},
subscriptionStatusType: 'current',
subscriptionCancelType: 'immediate',
startDate: '2026-07-01T00:00:00Z',
trialDuration: 0,
trialDurationType: 'Days',
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: 'USD'
})
};
fetch('https://api-sandbox.revolv3.com/api/Subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.revolv3.com/api/Subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'paymentMethods' => [
[
'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
],
'ach' => null,
'googlePay' => null,
'applePay' => null,
'merchantPaymentMethodRefId' => 'payment-method-ref-id_hgays-213-44d',
'billingFirstName' => 'John',
'billingLastName' => 'Doe',
'billingFullName' => null
],
[
'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
],
'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' => 'Days',
'intervalCount' => 1
],
'subscriptionStatusType' => 'current',
'subscriptionCancelType' => 'immediate',
'startDate' => '2026-07-01T00:00:00Z',
'trialDuration' => 0,
'trialDurationType' => 'Days',
'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' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"x-revolv3-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.revolv3.com/api/Subscriptions"
payload := strings.NewReader("{\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": 2.56,\n \"originalNetworkTransactionId\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"4111111111111111\",\n \"expirationDate\": \"1025\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-44d\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n },\n {\n \"priority\": 1,\n \"taxAmount\": 1.34,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street 2\",\n \"addressLine2\": null,\n \"city\": \"Irvine \",\n \"state\": \"CA\",\n \"postalCode\": \"9260e\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"5555555555554444\",\n \"expirationDate\": \"03/2030\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-4rf4344\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n }\n ],\n \"existingPaymentMethod\": null,\n \"merchantSubscriptionRefId\": \"1234-5678-9101\",\n \"billingFrequency\": {\n \"intervalType\": \"Days\",\n \"intervalCount\": 1\n },\n \"subscriptionStatusType\": \"current\",\n \"subscriptionCancelType\": \"immediate\",\n \"startDate\": \"2026-07-01T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": {\n \"id\": 1,\n \"firstName\": null,\n \"lastName\": null\n },\n \"subscriptionBillingPlans\": [\n {\n \"name\": \"Billing Plan 1\",\n \"value\": 10.99,\n \"cycleCount\": -1,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 0\n },\n {\n \"name\": \"Billing Plan 2\",\n \"value\": 14.99,\n \"cycleCount\": 12,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 1\n }\n ],\n \"recycleImmediatePayment\": false,\n \"currency\": \"USD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-revolv3-token", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.revolv3.com/api/Subscriptions")
.header("x-revolv3-token", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": 2.56,\n \"originalNetworkTransactionId\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"4111111111111111\",\n \"expirationDate\": \"1025\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-44d\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n },\n {\n \"priority\": 1,\n \"taxAmount\": 1.34,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street 2\",\n \"addressLine2\": null,\n \"city\": \"Irvine \",\n \"state\": \"CA\",\n \"postalCode\": \"9260e\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"5555555555554444\",\n \"expirationDate\": \"03/2030\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-4rf4344\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n }\n ],\n \"existingPaymentMethod\": null,\n \"merchantSubscriptionRefId\": \"1234-5678-9101\",\n \"billingFrequency\": {\n \"intervalType\": \"Days\",\n \"intervalCount\": 1\n },\n \"subscriptionStatusType\": \"current\",\n \"subscriptionCancelType\": \"immediate\",\n \"startDate\": \"2026-07-01T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": {\n \"id\": 1,\n \"firstName\": null,\n \"lastName\": null\n },\n \"subscriptionBillingPlans\": [\n {\n \"name\": \"Billing Plan 1\",\n \"value\": 10.99,\n \"cycleCount\": -1,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 0\n },\n {\n \"name\": \"Billing Plan 2\",\n \"value\": 14.99,\n \"cycleCount\": 12,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 1\n }\n ],\n \"recycleImmediatePayment\": false,\n \"currency\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.revolv3.com/api/Subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-revolv3-token"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": 2.56,\n \"originalNetworkTransactionId\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"4111111111111111\",\n \"expirationDate\": \"1025\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-44d\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n },\n {\n \"priority\": 1,\n \"taxAmount\": 1.34,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street 2\",\n \"addressLine2\": null,\n \"city\": \"Irvine \",\n \"state\": \"CA\",\n \"postalCode\": \"9260e\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"creditCard\": {\n \"paymentAccountNumber\": \"5555555555554444\",\n \"expirationDate\": \"03/2030\",\n \"securityCode\": null,\n \"networkToken\": null\n },\n \"ach\": null,\n \"googlePay\": null,\n \"applePay\": null,\n \"merchantPaymentMethodRefId\": \"payment-method-ref-id_hgays-213-4rf4344\",\n \"billingFirstName\": \"John\",\n \"billingLastName\": \"Doe\",\n \"billingFullName\": null\n }\n ],\n \"existingPaymentMethod\": null,\n \"merchantSubscriptionRefId\": \"1234-5678-9101\",\n \"billingFrequency\": {\n \"intervalType\": \"Days\",\n \"intervalCount\": 1\n },\n \"subscriptionStatusType\": \"current\",\n \"subscriptionCancelType\": \"immediate\",\n \"startDate\": \"2026-07-01T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": null,\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": {\n \"id\": 1,\n \"firstName\": null,\n \"lastName\": null\n },\n \"subscriptionBillingPlans\": [\n {\n \"name\": \"Billing Plan 1\",\n \"value\": 10.99,\n \"cycleCount\": -1,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 0\n },\n {\n \"name\": \"Billing Plan 2\",\n \"value\": 14.99,\n \"cycleCount\": 12,\n \"valueType\": \"Standard\",\n \"startCycleDelay\": 1\n }\n ],\n \"recycleImmediatePayment\": false,\n \"currency\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"subscriptionId": 1,
"customerId": 1,
"merchantSubscriptionRefId": "1234-5678-9101",
"networkTransactionId": null,
"billingIntervalType": "Months",
"billingIntervalCount": 1,
"subscriptionStatusType": "Current",
"subscriptionCancelType": "Immediate",
"initialBillDate": "01.07.2026",
"nextBillDate": "01.08.2026",
"taxAddress": null,
"paymentMethodIds": [
1,
2
],
"cancelledAt": null,
"billingPlans": [
{
"subscriptionBillingPlanId": 1,
"subscriptionId": 0,
"name": "Billing Plan 1",
"value": 10.99,
"startDate": "01.07.2026",
"cyclesRemaining": -1,
"cycleCount": 0,
"valueType": "Standard"
},
{
"subscriptionBillingPlanId": 2,
"subscriptionId": 0,
"name": "Billing Plan 2",
"value": 14.99,
"startDate": "01.08.2026",
"cyclesRemaining": 12,
"cycleCount": 0,
"valueType": "Standard"
}
],
"message": null,
"paymentProcessor": null,
"processorMerchantId": null,
"processorRawResponse": null,
"currency": null,
"responseMessage": null,
"responseCode": null
}{
"message": "Unable to perform the request action with provided data."
}{
"message": "Attempted to perform an unauthorized operation."
}{
"message": "Unable to find an entity with the provided data."
}{
"message": "PaymentMethodAuthorizationId is being processed in another request."
}Authorizations
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Show child attributes
Show child attributes
Maximum string length:
50Maximum string length:
50Maximum string length:
40Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
100Available options:
Days, Weeks, Months, Years Show child attributes
Show child attributes
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
Required range:
1 <= x <= 1000000000Required range:
1 <= x <= 1000000000Maximum string length:
100Maximum string length:
100Maximum string length:
50Required range:
1 <= x <= 1000000000Maximum string length:
50Maximum string length:
50Maximum string length:
20Maximum string length:
20Show child attributes
Show child attributes
Maximum string length:
40Show child attributes
Show child attributes
Maximum string length:
500Maximum string length:
100Maximum string length:
100Maximum string length:
10000Maximum string length:
3Maximum string length:
500Maximum string length:
10⌘I