OpenMeter Customers

List credit grants

List credit grants.

get/openmeter/customers/{customerId}/credits/grants

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'

Credit grant lifecycle status.

pending: The credit block has been created but is not yet valid. (effective_at is in the future or availability_policy is not met)
active: The credit block is currently valid and eligible for consumption. (effective_at is in the past, expires_at is in the future and availability_policy is met)
expired: The credit block expired with remaining unused balance, expires_at time has passed.
voided: The credit block was voided. Remaining balance is forfeited.

currencystring

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

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"
      },
      "tax_config": {
        "tax_code": {
          "id": "01G65Z755AFWAKHE12NY0CQ9FH"
        }
      },
      "invoice": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH",
        "line": {
          "id": "01G65Z755AFWAKHE12NY0CQ9FH"
        }
      },
      "filters": {
        "features": [
          "input_tokens",
          "output_tokens"
        ]
      },
      "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

Changed in 8 of the 63 revisions of this API.8823

Aug 25, 2026v3bd7fb102768411See the full diff
- ▲
  added to the ////// response property oneOf list for the response status
  response-property-one-of-added
- ○
  removed from the ////// response property anyOf list for the response status
  response-property-any-of-removed
Jul 30, 2026v3b4f5102c436d12See the full diff
- ▲
  the ////// response's property type changed from string to no type for status
  response-property-type-changed
- ○
  removed from the ////// response property allOf list for the response status
  response-property-all-of-removed
- ○
  added to the ////// response property anyOf list for the response status
  response-property-any-of-added
Jul 3, 2026v33be06f2694472See the full diff
- ○
  for the query request parameter filter, the format of property key/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was generalized from ArrayEncoding.commaDelimited to no format
  request-parameter-property-type-generalized
- ○
  for the query request parameter filter, the format of property key/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was generalized from ArrayEncoding.commaDelimited to no format
  request-parameter-property-type-generalized
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 30, 2026v316808fbfb5781See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jun 29, 2026v3cf64127756eb1See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
May 26, 2026v366c58f249315454See the full diff
- ▲
  the // response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the // response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added to the // response property allOf list for the response status
  response-property-all-of-added
- ○
  added to the // response property allOf list for the response status
  response-property-all-of-added
- ○
  added to the //// response property allOf list for the response status
  response-property-all-of-added
- ○
  removed from the //// response property allOf list for the response status
  response-property-all-of-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 20, 2026v355836d0ad2f51See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
May 11, 2026v39d0042cb38152311See the full diff
- ▲
  the // response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the // response's property type changed from no type to object for status
  response-property-type-changed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added to the //// response property allOf list for the response status
  response-property-all-of-added
- ○
  removed from the // response property allOf list for the response status
  response-property-all-of-removed
- ○
  removed from the // response property allOf list for the response status
  response-property-all-of-removed
- ○
  removed from the //// response property allOf list for the response status
  response-property-all-of-removed
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
This revision also has 112 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history