OpenMeter Customers

Create a credit adjustment

Changed on

A credit adjustment can be used to make manual adjustments to a customer's credit balance.

Supported use-cases:

  • Usage correction
post/openmeter/customers/{customerId}/credits/adjustments

Request

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

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

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

amountstring required

Numeric represents an arbitrary precision number.

Example request

{
  "labels": {
    "env": "test"
  },
  "currency": "USD"
}

Response

CreditAdjustment created response.

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

Example response

{
  "labels": {
    "env": "test"
  }
}

Changes

  • v3bd7fb1027684Revision changes
    • breaking

      removed from the //// request property anyOf list

    • info

      added to the //// request property oneOf list

  • v3b4f5102c436dRevision changes
    • breaking

      the //// request property type changed from string to no type

    • warning

      removed from the //// request property allOf list

    • info

      added to the //// request property anyOf list