GET
/
customers
curl --request GET \
  --url https://api.withorb.com/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "metadata": {},
      "id": "<string>",
      "external_customer_id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "payment_provider_id": "<string>",
      "payment_provider": "quickbooks",
      "created_at": "2023-11-07T05:31:56Z",
      "shipping_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "balance": "<string>",
      "currency": "<string>",
      "tax_id": {
        "country": "AD",
        "type": "ad_nrt",
        "value": "<string>"
      },
      "auto_collection": true,
      "exempt_from_automated_tax": true,
      "email_delivery": true,
      "additional_emails": [
        "<string>"
      ],
      "portal_url": "<string>",
      "accounting_sync_configuration": {
        "excluded": true,
        "accounting_providers": [
          {
            "provider_type": "quickbooks",
            "external_provider_id": "<string>"
          }
        ]
      },
      "reporting_configuration": {
        "exempt": true
      },
      "hierarchy": {
        "parent": {
          "id": "<string>",
          "external_customer_id": "<string>"
        },
        "children": [
          {
            "id": "<string>",
            "external_customer_id": "<string>"
          }
        ]
      }
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Query Parameters

​
limit
integer
default:
20

The number of items to fetch. Defaults to 20.

Required range: 1 < x < 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

​
created_at[gte]
string | null
​
created_at[gt]
string | null
​
created_at[lt]
string | null
​
created_at[lte]
string | null

Response

200
application/json
OK
​
data
object[]
required

A customer is a buyer of your products, and the other party to the billing relationship.

In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an external_customer_id with your own identifier. See Customer ID Aliases for further information about how these aliases work in Orb.

In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the payment_provider_id and the payment_provider enum field to express this mapping.

A customer also has a timezone (from the standard IANA timezone database), which defaults to your account's timezone. See Timezone localization for information on what this timezone parameter influences within Orb.

​
pagination_metadata
object
required

Was this page helpful?

Fetch credit noteCreate customer