List customers
Query Parameters
Determines which page of the collection to retrieve.
Show Child Parameters
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Filter options for listing customers.
Show Child Parameters
Response
application/json
Response
Page paginated response.
CustomerPagePaginatedResponse
Page paginated response.
Customers can be individuals or organizations that can subscribe to plans and have access to features.
Show Child Parameters
returns the pagination information
Show Child Parameters
Authentication
Query Parameters
Get customer
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Response
application/json
Response
Customer response.
BillingCustomer
Customers can be individuals or organizations that can subscribe to plans and have access to features.
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Display name of the resource.
Between 1 and 256 characters.
>= 1 characters<= 256 characters
Optional description of the resource.
Maximum 1024 characters.
<= 1024 characters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity last update date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity deletion date.
Example:2023-01-01T01:01:01.001Z
ExternalResourceKey is a unique string that is used to identify a resource in an external system.
>= 1 characters<= 256 characters
Example:019ae40f-4258-7f15-9491-842f42a7d6ac
Mapping to attribute metered usage to the customer by the event subject.
Show Child Parameters
The primary email address of the customer.
Currency of the customer.
Used for billing, tax and invoicing.
Match pattern:^[A-Z]{3}$
>= 3 characters<= 3 characters
Example:USD
The billing address of the customer.
Used for tax and invoicing.
Show Child Parameters
Authentication
Path Parameters
Upsert customer
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Body
application/json
Body
UpsertCustomerRequest
Customer upsert request.
Display name of the resource.
Between 1 and 256 characters.
>= 1 characters<= 256 characters
Optional description of the resource.
Maximum 1024 characters.
<= 1024 characters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Mapping to attribute metered usage to the customer by the event subject.
Show Child Parameters
The primary email address of the customer.
Currency of the customer.
Used for billing, tax and invoicing.
Match pattern:^[A-Z]{3}$
>= 3 characters<= 3 characters
Example:USD
The billing address of the customer.
Used for tax and invoicing.
Show Child Parameters
Response
application/json
Response
Customer upsert response.
BillingCustomer
Customers can be individuals or organizations that can subscribe to plans and have access to features.
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Display name of the resource.
Between 1 and 256 characters.
>= 1 characters<= 256 characters
Optional description of the resource.
Maximum 1024 characters.
<= 1024 characters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity last update date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity deletion date.
Example:2023-01-01T01:01:01.001Z
ExternalResourceKey is a unique string that is used to identify a resource in an external system.
>= 1 characters<= 256 characters
Example:019ae40f-4258-7f15-9491-842f42a7d6ac
Mapping to attribute metered usage to the customer by the event subject.
Show Child Parameters
The primary email address of the customer.
Currency of the customer.
Used for billing, tax and invoicing.
Match pattern:^[A-Z]{3}$
>= 3 characters<= 3 characters
Example:USD
The billing address of the customer.
Used for tax and invoicing.
Show Child Parameters
Authentication
Path Parameters
Body
Delete customer
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Response
Response
Deleted response.
Authentication
Path Parameters
Get customer billing data
Path Parameters
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Response
application/json
Response
CustomerBillingData response.
BillingCustomerData
Billing customer data.
The billing profile for the customer.
If not provided, the default billing profile will be used.
Show Child Parameters
App customer data.