Sign in

v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB
Customers

Save customers

Save new (or update existing) customers

post/v6/customers

Request body

Example request

{
  "data": [
    {
      "id": "cus_28868401",
      "name": "Acme Corp",
      "status": "ACTIVE",
      "additionalContactName": "Jane Smith",
      "businessName": "Acme Corporation LLC",
      "email": "billing@acme.com",
      "ccEmails": [
        "[\"cc@acme.com\"]"
      ],
      "bccEmails": [
        "[\"bcc@acme.com\"]"
      ],
      "invoiceSettings": {
        "invoicePrefix": "INV-",
        "showAdditionalContactName": true,
        "showBusinessName": true,
        "showName": true,
        "showEmail": true,
        "showAddress": true,
        "showPhoneWork": true
      },
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ]
}

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "data": {
        "id": "cus_28868401",
        "name": "Acme Corp",
        "status": "ACTIVE",
        "additionalContactName": "Jane Smith",
        "businessName": "Acme Corporation LLC",
        "email": "billing@acme.com",
        "ccEmails": [
          "cc@acme.com"
        ],
        "bccEmails": [
          "bcc@acme.com"
        ],
        "invoiceSettings": {
          "invoicePrefix": "INV-",
          "showAdditionalContactName": true,
          "showBusinessName": true,
          "showName": true,
          "showEmail": true,
          "showAddress": true,
          "showPhoneWork": true
        },
        "address": {
          "countryCode": "USA"
        },
        "customData": {
          "internal_key": "some_internal_key",
          "some_other_field": 23434
        }
      }
    }
  ]
}