OpenMeter Customers

Create a new credit grant

Changed on

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Create a new credit grant. A credit grant represents an allocation of prepaid credits to a customer.

post/v3/openmeter/customers/{customerId}/credits/grants

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/customers/{customerId}/credits/grants
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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

funding_method'none' | 'invoice' | 'external' required

Funding method of the grant.

amountstring required

Granted credit amount.

priorityinteger

Draw-down priority of the grant. Lower values have higher priority.

effective_atstring date-time

The timestamp when the credit grant becomes effective.

Defaults to the current date and time.

expires_afterstring ISO8601

The duration after which the credit grant expires.

Defaults to never expiring.

keystring

Idempotency key for the credit grant creation request.

Unique per customer: reusing the same key for the same customer returns an HTTP 409 Conflict instead of creating a duplicate grant, which makes create requests safe to retry. The same key may be reused across different customers.

Example request

{
  "labels": {
    "env": "test"
  },
  "currency": "USD",
  "purchase": {
    "currency": "USD",
    "cost_basis": {
      "fiat_currency": "USD"
    }
  },
  "tax_config": {
    "code": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    }
  },
  "filters": {
    "features": [
      "input_tokens",
      "output_tokens"
    ],
    "plans": [
      {
        "key": "resource_key"
      }
    ]
  },
  "effective_at": "2023-01-01T01:01:01.001Z",
  "expires_after": "P1Y",
  "key": "019ae40f-4258-7f15-9491-842f42a7d6ac"
}

Response

CreditGrant 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.

funding_method'none' | 'invoice' | 'external' required

Funding method of the grant.

amountstring required

Granted credit amount.

priorityinteger

Draw-down priority of the grant. Lower values have higher priority.

effective_atstring date-time

The timestamp when the credit grant becomes effective.

Defaults to the current date and time.

keystring

Idempotency key for the credit grant creation request.

Unique per customer: reusing the same key for the same customer returns an HTTP 409 Conflict instead of creating a duplicate grant, which makes create requests safe to retry. The same key may be reused across different customers.

expires_atstring date-time

The timestamp when the credit grant expires.

Calculated from the grant effective time and expires_after if provided.

voided_atstring date-time

Timestamp when the grant was voided.

status'pending' | 'active' | 'expired' | 'voided' required

Current lifecycle status of the grant.

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",
  "currency": "USD",
  "purchase": {
    "currency": "USD",
    "resolved_cost_basis": {
      "fiat_currency": "USD",
      "cost_basis_id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "resolved_at": "2023-01-01T01:01:01.001Z"
    }
  },
  "tax_config": {
    "code": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    }
  },
  "invoice": {
    "id": "01G65Z755AFWAKHE12NY0CQ9FH",
    "line": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    }
  },
  "filters": {
    "features": [
      "input_tokens",
      "output_tokens"
    ],
    "plans": [
      {
        "key": "resource_key"
      }
    ]
  },
  "effective_at": "2023-01-01T01:01:01.001Z",
  "key": "019ae40f-4258-7f15-9491-842f42a7d6ac",
  "expires_at": "2023-01-01T01:01:01.001Z",
  "voided_at": "2023-01-01T01:01:01.001Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 1efb48111817Revision changes
    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status