OpenMeter Customers

List credit grants

Changed on

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

List credit grants.

get/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

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

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

Filter credit grants by status.

currencystring

Filter credit grants by currency.

Filter credit grants returned in the response.

{
  "currency": "USD"
}

Response

Page paginated response.

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

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 optional property /// to the response with the status