Create Customer
curl --request POST \
--url https://api-sandbox.revolv3.com/api/Customers \
--header 'Content-Type: application/json-patch+json' \
--header 'x-revolv3-token: <api-key>' \
--data '
{
"merchantCustomerRefId": null,
"firstName": "John",
"lastName": "Doe",
"email": null,
"billingAddresses": [
{
"addressId": null,
"addressLine1": "100 Main Street",
"addressLine2": "",
"city": "Santa Ana",
"state": "CA",
"postalCode": "90000",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"shippingAddresses": [
{
"addressId": null,
"addressLine1": "101 First Street",
"addressLine2": "",
"city": "Costa Mesa",
"state": "CA",
"postalCode": "90001",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"subscriptions": [
{
"paymentMethods": [
{
"priority": 0,
"taxAmount": null,
"originalNetworkTransactionId": null,
"billingAddress": {
"addressId": null,
"addressLine1": "100 Main Street",
"addressLine2": "",
"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": null,
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": null
}
],
"existingPaymentMethod": null,
"merchantSubscriptionRefId": "1234-5678-9101",
"billingFrequency": {
"intervalType": "Days",
"intervalCount": 1
},
"subscriptionStatusType": "current",
"subscriptionCancelType": "EndOfCycle",
"startDate": "2026-10-12T00:00:00Z",
"trialDuration": 0,
"trialDurationType": "Days",
"taxAddress": {
"addressId": null,
"addressLine1": "101 Update Street",
"addressLine2": "",
"city": "Irvine",
"state": "CA",
"postalCode": "92602",
"phoneNumber": null,
"email": null,
"country": "US"
},
"includeRawProcessorResponse": false,
"customer": 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",
"reportGroup": null
}
]
}
'import requests
url = "https://api-sandbox.revolv3.com/api/Customers"
payload = {
"merchantCustomerRefId": None,
"firstName": "John",
"lastName": "Doe",
"email": None,
"billingAddresses": [
{
"addressId": None,
"addressLine1": "100 Main Street",
"addressLine2": "",
"city": "Santa Ana",
"state": "CA",
"postalCode": "90000",
"phoneNumber": None,
"email": None,
"country": "US"
}
],
"shippingAddresses": [
{
"addressId": None,
"addressLine1": "101 First Street",
"addressLine2": "",
"city": "Costa Mesa",
"state": "CA",
"postalCode": "90001",
"phoneNumber": None,
"email": None,
"country": "US"
}
],
"subscriptions": [
{
"paymentMethods": [
{
"priority": 0,
"taxAmount": None,
"originalNetworkTransactionId": None,
"billingAddress": {
"addressId": None,
"addressLine1": "100 Main Street",
"addressLine2": "",
"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": None,
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": None
}
],
"existingPaymentMethod": None,
"merchantSubscriptionRefId": "1234-5678-9101",
"billingFrequency": {
"intervalType": "Days",
"intervalCount": 1
},
"subscriptionStatusType": "current",
"subscriptionCancelType": "EndOfCycle",
"startDate": "2026-10-12T00:00:00Z",
"trialDuration": 0,
"trialDurationType": "Days",
"taxAddress": {
"addressId": None,
"addressLine1": "101 Update Street",
"addressLine2": "",
"city": "Irvine",
"state": "CA",
"postalCode": "92602",
"phoneNumber": None,
"email": None,
"country": "US"
},
"includeRawProcessorResponse": False,
"customer": 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",
"reportGroup": None
}
]
}
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({
merchantCustomerRefId: null,
firstName: 'John',
lastName: 'Doe',
email: null,
billingAddresses: [
{
addressId: null,
addressLine1: '100 Main Street',
addressLine2: '',
city: 'Santa Ana',
state: 'CA',
postalCode: '90000',
phoneNumber: null,
email: null,
country: 'US'
}
],
shippingAddresses: [
{
addressId: null,
addressLine1: '101 First Street',
addressLine2: '',
city: 'Costa Mesa',
state: 'CA',
postalCode: '90001',
phoneNumber: null,
email: null,
country: 'US'
}
],
subscriptions: [
{
paymentMethods: [
{
priority: 0,
taxAmount: null,
originalNetworkTransactionId: null,
billingAddress: {
addressId: null,
addressLine1: '100 Main Street',
addressLine2: '',
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: null,
billingFirstName: 'John',
billingLastName: 'Doe',
billingFullName: null
}
],
existingPaymentMethod: null,
merchantSubscriptionRefId: '1234-5678-9101',
billingFrequency: {intervalType: 'Days', intervalCount: 1},
subscriptionStatusType: 'current',
subscriptionCancelType: 'EndOfCycle',
startDate: '2026-10-12T00:00:00Z',
trialDuration: 0,
trialDurationType: 'Days',
taxAddress: {
addressId: null,
addressLine1: '101 Update Street',
addressLine2: '',
city: 'Irvine',
state: 'CA',
postalCode: '92602',
phoneNumber: null,
email: null,
country: 'US'
},
includeRawProcessorResponse: false,
customer: 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',
reportGroup: null
}
]
})
};
fetch('https://api-sandbox.revolv3.com/api/Customers', 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/Customers",
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([
'merchantCustomerRefId' => null,
'firstName' => 'John',
'lastName' => 'Doe',
'email' => null,
'billingAddresses' => [
[
'addressId' => null,
'addressLine1' => '100 Main Street',
'addressLine2' => '',
'city' => 'Santa Ana',
'state' => 'CA',
'postalCode' => '90000',
'phoneNumber' => null,
'email' => null,
'country' => 'US'
]
],
'shippingAddresses' => [
[
'addressId' => null,
'addressLine1' => '101 First Street',
'addressLine2' => '',
'city' => 'Costa Mesa',
'state' => 'CA',
'postalCode' => '90001',
'phoneNumber' => null,
'email' => null,
'country' => 'US'
]
],
'subscriptions' => [
[
'paymentMethods' => [
[
'priority' => 0,
'taxAmount' => null,
'originalNetworkTransactionId' => null,
'billingAddress' => [
'addressId' => null,
'addressLine1' => '100 Main Street',
'addressLine2' => '',
'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' => null,
'billingFirstName' => 'John',
'billingLastName' => 'Doe',
'billingFullName' => null
]
],
'existingPaymentMethod' => null,
'merchantSubscriptionRefId' => '1234-5678-9101',
'billingFrequency' => [
'intervalType' => 'Days',
'intervalCount' => 1
],
'subscriptionStatusType' => 'current',
'subscriptionCancelType' => 'EndOfCycle',
'startDate' => '2026-10-12T00:00:00Z',
'trialDuration' => 0,
'trialDurationType' => 'Days',
'taxAddress' => [
'addressId' => null,
'addressLine1' => '101 Update Street',
'addressLine2' => '',
'city' => 'Irvine',
'state' => 'CA',
'postalCode' => '92602',
'phoneNumber' => null,
'email' => null,
'country' => 'US'
],
'includeRawProcessorResponse' => false,
'customer' => 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',
'reportGroup' => null
]
]
]),
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/Customers"
payload := strings.NewReader("{\n \"merchantCustomerRefId\": null,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": null,\n \"billingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\n \"city\": \"Santa Ana\",\n \"state\": \"CA\",\n \"postalCode\": \"90000\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"101 First Street\",\n \"addressLine2\": \"\",\n \"city\": \"Costa Mesa\",\n \"state\": \"CA\",\n \"postalCode\": \"90001\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"subscriptions\": [\n {\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": null,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\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\": null,\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\": \"EndOfCycle\",\n \"startDate\": \"2026-10-12T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": \"\",\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": null,\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 \"reportGroup\": null\n }\n ]\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/Customers")
.header("x-revolv3-token", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"merchantCustomerRefId\": null,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": null,\n \"billingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\n \"city\": \"Santa Ana\",\n \"state\": \"CA\",\n \"postalCode\": \"90000\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"101 First Street\",\n \"addressLine2\": \"\",\n \"city\": \"Costa Mesa\",\n \"state\": \"CA\",\n \"postalCode\": \"90001\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"subscriptions\": [\n {\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": null,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\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\": null,\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\": \"EndOfCycle\",\n \"startDate\": \"2026-10-12T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": \"\",\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": null,\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 \"reportGroup\": null\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.revolv3.com/api/Customers")
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 \"merchantCustomerRefId\": null,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": null,\n \"billingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\n \"city\": \"Santa Ana\",\n \"state\": \"CA\",\n \"postalCode\": \"90000\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"101 First Street\",\n \"addressLine2\": \"\",\n \"city\": \"Costa Mesa\",\n \"state\": \"CA\",\n \"postalCode\": \"90001\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"subscriptions\": [\n {\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": null,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\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\": null,\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\": \"EndOfCycle\",\n \"startDate\": \"2026-10-12T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": \"\",\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": null,\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 \"reportGroup\": null\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"customerId": 1,
"merchantCustomerRefId": "1234-5678-9101",
"firstName": "John",
"lastName": "Doe",
"billingAddresses": [
{
"addressId": 1,
"addressLine1": "100 Main Street",
"addressLine2": null,
"city": "Santa Ana",
"state": "CA",
"postalCode": "90000",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"shippingAddresses": [
{
"addressId": 2,
"addressLine1": "101 First Street",
"addressLine2": "",
"city": "Costa Mesa",
"state": "CA",
"postalCode": "90001",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"taxAddresses": [],
"subscriptions": [
{
"subscriptionId": 1,
"customerId": 1,
"merchantSubscriptionRefId": "1234-5678-9101",
"networkTransactionId": null,
"billingIntervalType": "Days",
"billingIntervalCount": 1,
"subscriptionStatusType": "current",
"subscriptionCancelType": null,
"initialBillDate": "10/12/2026",
"nextBillDate": "10/13/2026",
"taxAddress": null,
"paymentMethodIds": null,
"cancelledAt": null,
"billingPlans": [
{
"subscriptionBillingPlanId": 1,
"subscriptionId": 0,
"name": "Billing Plan 1",
"value": 10.99,
"startDate": "10/12/2026",
"cyclesRemaining": -1,
"cycleCount": 0,
"valueType": "Standard"
},
{
"subscriptionBillingPlanId": 2,
"subscriptionId": 0,
"name": "Billing Plan 2",
"value": 14.99,
"startDate": "10/13/2026",
"cyclesRemaining": 12,
"cycleCount": 0,
"valueType": "Standard"
}
],
"message": null,
"paymentProcessor": null,
"processorMerchantId": null,
"processorRawResponse": null,
"currency": null,
"responseMessage": null,
"responseCode": null
}
]
}[
{
"response": {
"customerId": 1,
"merchantCustomerRefId": "1234-5678-9101",
"firstName": "John",
"lastName": "Doe",
"billingAddresses": [
{
"addressId": 1,
"addressLine1": "100 Main Street",
"addressLine2": "",
"city": "Santa Ana",
"state": "CA",
"postalCode": "90000",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"shippingAddresses": [
{
"addressId": 2,
"addressLine1": "101 First Street",
"addressLine2": "",
"city": "Costa Mesa",
"state": "CA",
"postalCode": "90001",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"taxAddresses": [],
"subscriptions": []
},
"statusCode": 201,
"name": "Customer"
},
{
"response": {
"subscriptionId": 1,
"customerId": 1,
"merchantSubscriptionRefId": "1234-5678-9101",
"networkTransactionId": null,
"billingIntervalType": "Days",
"billingIntervalCount": 1,
"subscriptionStatusType": "current",
"subscriptionCancelType": null,
"initialBillDate": "10/13/2026",
"nextBillDate": null,
"taxAddress": null,
"paymentMethodIds": null,
"cancelledAt": null,
"billingPlans": [
{
"subscriptionBillingPlanId": 1,
"subscriptionId": 0,
"name": "Billing Plan 1",
"value": 10.99,
"startDate": "10/12/2026",
"cyclesRemaining": -1,
"cycleCount": 0,
"valueType": "Standard"
},
{
"subscriptionBillingPlanId": 2,
"subscriptionId": 0,
"name": "Billing Plan 2",
"value": 14.99,
"startDate": "10/12/2026",
"cyclesRemaining": 12,
"cycleCount": 0,
"valueType": "Standard"
}
],
"message": null,
"paymentProcessor": null,
"processorMerchantId": null,
"processorRawResponse": null,
"currency": null,
"responseMessage": null,
"responseCode": null
},
"statusCode": 201,
"name": "Subscription"
},
{
"response": {
"merchantSubscriptionRefId": "1234-5678-9101",
"errorMessage": "Subscription creation fail"
},
"statusCode": 400,
"name": "CreateSubscriptionFailure"
}
]{
"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."
}Customers
Create Customer
Creates a new customer record within your merchant account. You can provide customer details such as first name, last name, billing address, shipping address, and a Merchant Customer Ref ID (an external identifier you define).
Once created, the customer can be linked to subscriptions, payment methods, invoices, and other transactional entities. This endpoint is typically used during onboarding or checkout flows to register the customer in the system before initiating payments.
A successful response includes the unique Customer ID assigned by the platform.
POST
/
api
/
Customers
Create Customer
curl --request POST \
--url https://api-sandbox.revolv3.com/api/Customers \
--header 'Content-Type: application/json-patch+json' \
--header 'x-revolv3-token: <api-key>' \
--data '
{
"merchantCustomerRefId": null,
"firstName": "John",
"lastName": "Doe",
"email": null,
"billingAddresses": [
{
"addressId": null,
"addressLine1": "100 Main Street",
"addressLine2": "",
"city": "Santa Ana",
"state": "CA",
"postalCode": "90000",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"shippingAddresses": [
{
"addressId": null,
"addressLine1": "101 First Street",
"addressLine2": "",
"city": "Costa Mesa",
"state": "CA",
"postalCode": "90001",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"subscriptions": [
{
"paymentMethods": [
{
"priority": 0,
"taxAmount": null,
"originalNetworkTransactionId": null,
"billingAddress": {
"addressId": null,
"addressLine1": "100 Main Street",
"addressLine2": "",
"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": null,
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": null
}
],
"existingPaymentMethod": null,
"merchantSubscriptionRefId": "1234-5678-9101",
"billingFrequency": {
"intervalType": "Days",
"intervalCount": 1
},
"subscriptionStatusType": "current",
"subscriptionCancelType": "EndOfCycle",
"startDate": "2026-10-12T00:00:00Z",
"trialDuration": 0,
"trialDurationType": "Days",
"taxAddress": {
"addressId": null,
"addressLine1": "101 Update Street",
"addressLine2": "",
"city": "Irvine",
"state": "CA",
"postalCode": "92602",
"phoneNumber": null,
"email": null,
"country": "US"
},
"includeRawProcessorResponse": false,
"customer": 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",
"reportGroup": null
}
]
}
'import requests
url = "https://api-sandbox.revolv3.com/api/Customers"
payload = {
"merchantCustomerRefId": None,
"firstName": "John",
"lastName": "Doe",
"email": None,
"billingAddresses": [
{
"addressId": None,
"addressLine1": "100 Main Street",
"addressLine2": "",
"city": "Santa Ana",
"state": "CA",
"postalCode": "90000",
"phoneNumber": None,
"email": None,
"country": "US"
}
],
"shippingAddresses": [
{
"addressId": None,
"addressLine1": "101 First Street",
"addressLine2": "",
"city": "Costa Mesa",
"state": "CA",
"postalCode": "90001",
"phoneNumber": None,
"email": None,
"country": "US"
}
],
"subscriptions": [
{
"paymentMethods": [
{
"priority": 0,
"taxAmount": None,
"originalNetworkTransactionId": None,
"billingAddress": {
"addressId": None,
"addressLine1": "100 Main Street",
"addressLine2": "",
"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": None,
"billingFirstName": "John",
"billingLastName": "Doe",
"billingFullName": None
}
],
"existingPaymentMethod": None,
"merchantSubscriptionRefId": "1234-5678-9101",
"billingFrequency": {
"intervalType": "Days",
"intervalCount": 1
},
"subscriptionStatusType": "current",
"subscriptionCancelType": "EndOfCycle",
"startDate": "2026-10-12T00:00:00Z",
"trialDuration": 0,
"trialDurationType": "Days",
"taxAddress": {
"addressId": None,
"addressLine1": "101 Update Street",
"addressLine2": "",
"city": "Irvine",
"state": "CA",
"postalCode": "92602",
"phoneNumber": None,
"email": None,
"country": "US"
},
"includeRawProcessorResponse": False,
"customer": 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",
"reportGroup": None
}
]
}
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({
merchantCustomerRefId: null,
firstName: 'John',
lastName: 'Doe',
email: null,
billingAddresses: [
{
addressId: null,
addressLine1: '100 Main Street',
addressLine2: '',
city: 'Santa Ana',
state: 'CA',
postalCode: '90000',
phoneNumber: null,
email: null,
country: 'US'
}
],
shippingAddresses: [
{
addressId: null,
addressLine1: '101 First Street',
addressLine2: '',
city: 'Costa Mesa',
state: 'CA',
postalCode: '90001',
phoneNumber: null,
email: null,
country: 'US'
}
],
subscriptions: [
{
paymentMethods: [
{
priority: 0,
taxAmount: null,
originalNetworkTransactionId: null,
billingAddress: {
addressId: null,
addressLine1: '100 Main Street',
addressLine2: '',
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: null,
billingFirstName: 'John',
billingLastName: 'Doe',
billingFullName: null
}
],
existingPaymentMethod: null,
merchantSubscriptionRefId: '1234-5678-9101',
billingFrequency: {intervalType: 'Days', intervalCount: 1},
subscriptionStatusType: 'current',
subscriptionCancelType: 'EndOfCycle',
startDate: '2026-10-12T00:00:00Z',
trialDuration: 0,
trialDurationType: 'Days',
taxAddress: {
addressId: null,
addressLine1: '101 Update Street',
addressLine2: '',
city: 'Irvine',
state: 'CA',
postalCode: '92602',
phoneNumber: null,
email: null,
country: 'US'
},
includeRawProcessorResponse: false,
customer: 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',
reportGroup: null
}
]
})
};
fetch('https://api-sandbox.revolv3.com/api/Customers', 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/Customers",
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([
'merchantCustomerRefId' => null,
'firstName' => 'John',
'lastName' => 'Doe',
'email' => null,
'billingAddresses' => [
[
'addressId' => null,
'addressLine1' => '100 Main Street',
'addressLine2' => '',
'city' => 'Santa Ana',
'state' => 'CA',
'postalCode' => '90000',
'phoneNumber' => null,
'email' => null,
'country' => 'US'
]
],
'shippingAddresses' => [
[
'addressId' => null,
'addressLine1' => '101 First Street',
'addressLine2' => '',
'city' => 'Costa Mesa',
'state' => 'CA',
'postalCode' => '90001',
'phoneNumber' => null,
'email' => null,
'country' => 'US'
]
],
'subscriptions' => [
[
'paymentMethods' => [
[
'priority' => 0,
'taxAmount' => null,
'originalNetworkTransactionId' => null,
'billingAddress' => [
'addressId' => null,
'addressLine1' => '100 Main Street',
'addressLine2' => '',
'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' => null,
'billingFirstName' => 'John',
'billingLastName' => 'Doe',
'billingFullName' => null
]
],
'existingPaymentMethod' => null,
'merchantSubscriptionRefId' => '1234-5678-9101',
'billingFrequency' => [
'intervalType' => 'Days',
'intervalCount' => 1
],
'subscriptionStatusType' => 'current',
'subscriptionCancelType' => 'EndOfCycle',
'startDate' => '2026-10-12T00:00:00Z',
'trialDuration' => 0,
'trialDurationType' => 'Days',
'taxAddress' => [
'addressId' => null,
'addressLine1' => '101 Update Street',
'addressLine2' => '',
'city' => 'Irvine',
'state' => 'CA',
'postalCode' => '92602',
'phoneNumber' => null,
'email' => null,
'country' => 'US'
],
'includeRawProcessorResponse' => false,
'customer' => 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',
'reportGroup' => null
]
]
]),
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/Customers"
payload := strings.NewReader("{\n \"merchantCustomerRefId\": null,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": null,\n \"billingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\n \"city\": \"Santa Ana\",\n \"state\": \"CA\",\n \"postalCode\": \"90000\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"101 First Street\",\n \"addressLine2\": \"\",\n \"city\": \"Costa Mesa\",\n \"state\": \"CA\",\n \"postalCode\": \"90001\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"subscriptions\": [\n {\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": null,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\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\": null,\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\": \"EndOfCycle\",\n \"startDate\": \"2026-10-12T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": \"\",\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": null,\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 \"reportGroup\": null\n }\n ]\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/Customers")
.header("x-revolv3-token", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"merchantCustomerRefId\": null,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": null,\n \"billingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\n \"city\": \"Santa Ana\",\n \"state\": \"CA\",\n \"postalCode\": \"90000\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"101 First Street\",\n \"addressLine2\": \"\",\n \"city\": \"Costa Mesa\",\n \"state\": \"CA\",\n \"postalCode\": \"90001\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"subscriptions\": [\n {\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": null,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\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\": null,\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\": \"EndOfCycle\",\n \"startDate\": \"2026-10-12T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": \"\",\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": null,\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 \"reportGroup\": null\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.revolv3.com/api/Customers")
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 \"merchantCustomerRefId\": null,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": null,\n \"billingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\n \"city\": \"Santa Ana\",\n \"state\": \"CA\",\n \"postalCode\": \"90000\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressId\": null,\n \"addressLine1\": \"101 First Street\",\n \"addressLine2\": \"\",\n \"city\": \"Costa Mesa\",\n \"state\": \"CA\",\n \"postalCode\": \"90001\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n }\n ],\n \"subscriptions\": [\n {\n \"paymentMethods\": [\n {\n \"priority\": 0,\n \"taxAmount\": null,\n \"originalNetworkTransactionId\": null,\n \"billingAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"100 Main Street\",\n \"addressLine2\": \"\",\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\": null,\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\": \"EndOfCycle\",\n \"startDate\": \"2026-10-12T00:00:00Z\",\n \"trialDuration\": 0,\n \"trialDurationType\": \"Days\",\n \"taxAddress\": {\n \"addressId\": null,\n \"addressLine1\": \"101 Update Street\",\n \"addressLine2\": \"\",\n \"city\": \"Irvine\",\n \"state\": \"CA\",\n \"postalCode\": \"92602\",\n \"phoneNumber\": null,\n \"email\": null,\n \"country\": \"US\"\n },\n \"includeRawProcessorResponse\": false,\n \"customer\": null,\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 \"reportGroup\": null\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"customerId": 1,
"merchantCustomerRefId": "1234-5678-9101",
"firstName": "John",
"lastName": "Doe",
"billingAddresses": [
{
"addressId": 1,
"addressLine1": "100 Main Street",
"addressLine2": null,
"city": "Santa Ana",
"state": "CA",
"postalCode": "90000",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"shippingAddresses": [
{
"addressId": 2,
"addressLine1": "101 First Street",
"addressLine2": "",
"city": "Costa Mesa",
"state": "CA",
"postalCode": "90001",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"taxAddresses": [],
"subscriptions": [
{
"subscriptionId": 1,
"customerId": 1,
"merchantSubscriptionRefId": "1234-5678-9101",
"networkTransactionId": null,
"billingIntervalType": "Days",
"billingIntervalCount": 1,
"subscriptionStatusType": "current",
"subscriptionCancelType": null,
"initialBillDate": "10/12/2026",
"nextBillDate": "10/13/2026",
"taxAddress": null,
"paymentMethodIds": null,
"cancelledAt": null,
"billingPlans": [
{
"subscriptionBillingPlanId": 1,
"subscriptionId": 0,
"name": "Billing Plan 1",
"value": 10.99,
"startDate": "10/12/2026",
"cyclesRemaining": -1,
"cycleCount": 0,
"valueType": "Standard"
},
{
"subscriptionBillingPlanId": 2,
"subscriptionId": 0,
"name": "Billing Plan 2",
"value": 14.99,
"startDate": "10/13/2026",
"cyclesRemaining": 12,
"cycleCount": 0,
"valueType": "Standard"
}
],
"message": null,
"paymentProcessor": null,
"processorMerchantId": null,
"processorRawResponse": null,
"currency": null,
"responseMessage": null,
"responseCode": null
}
]
}[
{
"response": {
"customerId": 1,
"merchantCustomerRefId": "1234-5678-9101",
"firstName": "John",
"lastName": "Doe",
"billingAddresses": [
{
"addressId": 1,
"addressLine1": "100 Main Street",
"addressLine2": "",
"city": "Santa Ana",
"state": "CA",
"postalCode": "90000",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"shippingAddresses": [
{
"addressId": 2,
"addressLine1": "101 First Street",
"addressLine2": "",
"city": "Costa Mesa",
"state": "CA",
"postalCode": "90001",
"phoneNumber": null,
"email": null,
"country": "US"
}
],
"taxAddresses": [],
"subscriptions": []
},
"statusCode": 201,
"name": "Customer"
},
{
"response": {
"subscriptionId": 1,
"customerId": 1,
"merchantSubscriptionRefId": "1234-5678-9101",
"networkTransactionId": null,
"billingIntervalType": "Days",
"billingIntervalCount": 1,
"subscriptionStatusType": "current",
"subscriptionCancelType": null,
"initialBillDate": "10/13/2026",
"nextBillDate": null,
"taxAddress": null,
"paymentMethodIds": null,
"cancelledAt": null,
"billingPlans": [
{
"subscriptionBillingPlanId": 1,
"subscriptionId": 0,
"name": "Billing Plan 1",
"value": 10.99,
"startDate": "10/12/2026",
"cyclesRemaining": -1,
"cycleCount": 0,
"valueType": "Standard"
},
{
"subscriptionBillingPlanId": 2,
"subscriptionId": 0,
"name": "Billing Plan 2",
"value": 14.99,
"startDate": "10/12/2026",
"cyclesRemaining": 12,
"cycleCount": 0,
"valueType": "Standard"
}
],
"message": null,
"paymentProcessor": null,
"processorMerchantId": null,
"processorRawResponse": null,
"currency": null,
"responseMessage": null,
"responseCode": null
},
"statusCode": 201,
"name": "Subscription"
},
{
"response": {
"merchantSubscriptionRefId": "1234-5678-9101",
"errorMessage": "Subscription creation fail"
},
"statusCode": 400,
"name": "CreateSubscriptionFailure"
}
]{
"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."
}Authorizations
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Required string length:
1 - 150Required string length:
1 - 150Maximum string length:
100Maximum string length:
100Maximum array length:
10Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Created
Required range:
1 <= x <= 1000000000Maximum string length:
100Maximum string length:
150Maximum string length:
150Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes