OpenMeter Entitlements

Void grant

Changed on

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

Void a grant so it no longer adds to the balance. Usage already deducted from the grant is kept.

delete/v3/openmeter/grants/{grantId}

Request

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

Path parameters

grantIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

voided_atstring date-time

RFC3339 formatted date-time string in UTC.

Example:2023-01-01T01:01:01.001Z

The time the grant is voided from. Defaults to now; it cannot be in the future or before the start of the current usage period.

Response

Deleted response.

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

  • 59663dd13a10Revision changes
    • info

      endpoint added