Skip to main content
POST
/
api
/
Customers
Error
A valid request URL is required to generate request examples
{
  "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": "22-Jun-26",
      "nextBillDate": "23-Jun-26",
      "taxAddress": null,
      "paymentMethodIds": null,
      "cancelledAt": null,
      "billingPlans": [
        {
          "subscriptionBillingPlanId": 1,
          "subscriptionId": 0,
          "name": "Billing Plan 1",
          "value": 10.99,
          "startDate": "22-Jun-26",
          "cyclesRemaining": -1,
          "cycleCount": 0,
          "valueType": "Standard"
        },
        {
          "subscriptionBillingPlanId": 2,
          "subscriptionId": 0,
          "name": "Billing Plan 2",
          "value": 14.99,
          "startDate": "23-Jun-26",
          "cyclesRemaining": 12,
          "cycleCount": 0,
          "valueType": "Standard"
        }
      ],
      "message": null,
      "paymentProcessor": null,
      "processorMerchantId": null,
      "processorRawResponse": null,
      "currency": null,
      "responseMessage": null,
      "responseCode": null
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

firstName
string
required
Required string length: 1 - 150
lastName
string
required
Required string length: 1 - 150
merchantCustomerRefId
string | null
Maximum string length: 100
email
string<email> | null
Maximum string length: 100
billingAddresses
object[] | null
Maximum array length: 10
shippingAddresses
object[] | null
Maximum array length: 10
subscriptions
object[] | null

Response

Created

customerId
integer<int64>
Required range: 1 <= x <= 1000000000
merchantCustomerRefId
string | null
Maximum string length: 100
firstName
string | null
Maximum string length: 150
lastName
string | null
Maximum string length: 150
billingAddresses
object[] | null
shippingAddresses
object[] | null
taxAddresses
object[] | null
subscriptions
object[] | null