Create customer

post

Body

application/json

CreateCustomerRequest

Customer create request.

namestringrequired

Display name of the resource.

Between 1 and 256 characters.

>= 1 characters<= 256 characters

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

<= 1024 characters

labelsobject

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

keystringrequired

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

usage_attributionobject

Mapping to attribute metered usage to the customer by the event subject.

Show Child Parameters
primary_emailstring

The primary email address of the customer.

currencystring

Currency of the customer.
Used for billing, tax and invoicing.

Match pattern:^[A-Z]{3}$

>= 3 characters<= 3 characters

Example:USD

billing_addressobject

The billing address of the customer.
Used for tax and invoicing.

Show Child Parameters

Response

application/json

Customer created response.

BillingCustomer

Customers can be individuals or organizations that can subscribe to plans and have access to features.

idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

namestringrequired

Display name of the resource.

Between 1 and 256 characters.

>= 1 characters<= 256 characters

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

<= 1024 characters

labelsobject

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

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2023-01-01T01:01:01.001Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity last update date.

Example:2023-01-01T01:01:01.001Z

deleted_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity deletion date.

Example:2023-01-01T01:01:01.001Z

keystringrequired

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

usage_attributionobject

Mapping to attribute metered usage to the customer by the event subject.

Show Child Parameters
primary_emailstring

The primary email address of the customer.

currencystring

Currency of the customer.
Used for billing, tax and invoicing.

Match pattern:^[A-Z]{3}$

>= 3 characters<= 3 characters

Example:USD

billing_addressobject

The billing address of the customer.
Used for tax and invoicing.

Show Child Parameters
post/openmeter/customers

Body

{ "name": "name", "key": "019ae40f-4258-7f15-9491-842f42a7d6ac" }
 
application/json

List customers

get

Query Parameters

pageobject

Determines which page of the collection to retrieve.

Show Child Parameters
sortstring

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

filterobject

Filter options for listing customers.

Show Child Parameters

Response

application/json

Page paginated response.

CustomerPagePaginatedResponse

Page paginated response.

dataarray[object]required

Customers can be individuals or organizations that can subscribe to plans and have access to features.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/openmeter/customers
 
application/json

Get customer

get

Path Parameters

customerIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

application/json

Customer response.

BillingCustomer

Customers can be individuals or organizations that can subscribe to plans and have access to features.

idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

namestringrequired

Display name of the resource.

Between 1 and 256 characters.

>= 1 characters<= 256 characters

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

<= 1024 characters

labelsobject

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

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2023-01-01T01:01:01.001Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity last update date.

Example:2023-01-01T01:01:01.001Z

deleted_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity deletion date.

Example:2023-01-01T01:01:01.001Z

keystringrequired

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

usage_attributionobject

Mapping to attribute metered usage to the customer by the event subject.

Show Child Parameters
primary_emailstring

The primary email address of the customer.

currencystring

Currency of the customer.
Used for billing, tax and invoicing.

Match pattern:^[A-Z]{3}$

>= 3 characters<= 3 characters

Example:USD

billing_addressobject

The billing address of the customer.
Used for tax and invoicing.

Show Child Parameters
get/openmeter/customers/{customerId}
 
application/json

Upsert customer

put

Path Parameters

customerIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

Body

application/json

UpsertCustomerRequest

Customer upsert request.

namestringrequired

Display name of the resource.

Between 1 and 256 characters.

>= 1 characters<= 256 characters

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

<= 1024 characters

labelsobject

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

usage_attributionobject

Mapping to attribute metered usage to the customer by the event subject.

Show Child Parameters
primary_emailstring

The primary email address of the customer.

currencystring

Currency of the customer.
Used for billing, tax and invoicing.

Match pattern:^[A-Z]{3}$

>= 3 characters<= 3 characters

Example:USD

billing_addressobject

The billing address of the customer.
Used for tax and invoicing.

Show Child Parameters

Response

application/json

Customer upsert response.

BillingCustomer

Customers can be individuals or organizations that can subscribe to plans and have access to features.

idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

namestringrequired

Display name of the resource.

Between 1 and 256 characters.

>= 1 characters<= 256 characters

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

<= 1024 characters

labelsobject

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

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2023-01-01T01:01:01.001Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity last update date.

Example:2023-01-01T01:01:01.001Z

deleted_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity deletion date.

Example:2023-01-01T01:01:01.001Z

keystringrequired

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

usage_attributionobject

Mapping to attribute metered usage to the customer by the event subject.

Show Child Parameters
primary_emailstring

The primary email address of the customer.

currencystring

Currency of the customer.
Used for billing, tax and invoicing.

Match pattern:^[A-Z]{3}$

>= 3 characters<= 3 characters

Example:USD

billing_addressobject

The billing address of the customer.
Used for tax and invoicing.

Show Child Parameters
put/openmeter/customers/{customerId}

Body

{ "name": "name" }
 
application/json

Delete customer

delete

Path Parameters

customerIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

Deleted response.

delete/openmeter/customers/{customerId}