Interface CustomersApiListCustomersRequest

Request parameters for listCustomers operation in CustomersApi.

Export

CustomersApiListCustomersRequest

Hierarchy

  • CustomersApiListCustomersRequest

Properties

limit? metadata? offset? q? tilled_account

Properties

Optional Readonly limit

limit?: number

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Memberof

CustomersApiListCustomers

Optional Readonly metadata

metadata?: {
    [key: string]: string;
}

`metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

Memberof

CustomersApiListCustomers

Type declaration

  • [key: string]: string

Optional Readonly offset

offset?: number

The (zero-based) offset of the first item in the collection to return.

Memberof

CustomersApiListCustomers

Optional Readonly q

q?: string

The partial search of text fields. Supports searching by `customer.first_name`, `customer.last_name`, `customer.email`, `customer.phone`

Memberof

CustomersApiListCustomers

Readonly tilled_account

tilled_account: string

The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

Memberof

CustomersApiListCustomers

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc