Sign in
OpenMeter Customers

Create customer

post/v3/openmeter/customers

Request body

namestring required

Display name of the resource.

Between 1 and 256 characters.

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

labelsLabels

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 "_".

keystring required

ExternalResourceKey is a unique string that is used to identify a resource in an external system.

primary_emailstring

The primary email address of the customer.

currencystring

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

Example request

{
  "labels": {
    "env": "test"
  },
  "key": "019ae40f-4258-7f15-9491-842f42a7d6ac",
  "currency": "USD",
  "billing_address": {
    "country": "US"
  }
}

Response

Customer created response.

idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

namestring required

Display name of the resource.

Between 1 and 256 characters.

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

labelsLabels

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 "_".

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

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

deleted_atstring date-time

An ISO-8601 timestamp representation of entity deletion date.

keystring required

ExternalResourceKey is a unique string that is used to identify a resource in an external system.

primary_emailstring

The primary email address of the customer.

currencystring

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

Example response

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "labels": {
    "env": "test"
  },
  "created_at": "2023-01-01T01:01:01.001Z",
  "updated_at": "2023-01-01T01:01:01.001Z",
  "deleted_at": "2023-01-01T01:01:01.001Z",
  "key": "019ae40f-4258-7f15-9491-842f42a7d6ac",
  "currency": "USD",
  "billing_address": {
    "country": "US"
  }
}

Changes

Changed in 2 of the 75 revisions of this API.3

  • 86981188d9112See the full diff
    • ○

      the response property created_at became required for the status 201

      response-property-became-required

    • ○

      the response property updated_at became required for the status 201

      response-property-became-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d5eb242b4c931See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog