v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB

Billing

List customer overrides

List customer overrides using the specified filters.

The response will include the customer override values and the merged billing profile values.

If the includeAllCustomers is set to true, the list contains all customers. This mode is useful for getting the current effective billing workflow settings for all users regardless if they have customer orverrides or not.

get/api/v1/billing/customers

Query parameters

billingProfilestring[]

Filter by billing profile.

[
  "01G65Z755AFWAKHE12NY0CQ9FH"
]

customersWithoutPinnedProfileboolean

Only return customers without pinned billing profiles. This implicitly sets includeAllCustomers to true.

includeAllCustomersboolean

Include customers without customer overrides.

If set to false only the customers specifically associated with a billing profile will be returned.

If set to true, in case of the default billing profile, all customers will be returned.

customerIdstring[]

Filter by customer id.

[
  "01G65Z755AFWAKHE12NY0CQ9FH"
]

customerNamestring

Filter by customer name.

customerKeystring

Filter by customer key

customerPrimaryEmailstring

Filter by customer primary email

expandBillingProfileCustomerOverrideExpand[]

Expand the response with additional details.

order'ASC' | 'DESC'

The order direction.

orderBy'customerId' | 'customerName' | 'customerKey' | 'customerPrimaryEmail' | 'customerCreatedAt'

Order by options for customers.

The order by field.

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

Response

The request has succeeded.

totalCountinteger required

The total number of items.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.