OpenMeter Customers

Get customer

Changed on
get/openmeter/customers/{customerId}

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/customers/{customerId}
  • Auth: none declared

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

Customer 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

RFC3339 formatted date-time string in UTC.

updated_atstring date-time required

RFC3339 formatted date-time string in UTC.

deleted_atstring date-time

RFC3339 formatted date-time string in UTC.

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

Three-letter ISO4217 currency code. Custom three-letter currency codes are also supported for convenience.

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

  • v3ec36b1a6d676Revision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

  • v39d0042cb3815Revision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status