v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB

Customers

Query customers

Query customers for the authenticated user

post/v6/customers/query

Request body

cursorstring nullable

Cursor from the previous paginated response

limitinteger

Page size, i.e. number of items to return per page

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "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
      }
    }
  ]
}