OpenMeter Entitlements

Reset customer entitlement usage

Changed on

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

Reset the usage of a metered entitlement. The reset starts a new usage period: usage is zeroed and grants roll over according to their rollover settings.

Usage is reset automatically at the end of each usage period. Use this operation to reset it earlier, for example to align the entitlement with the customer's billing period. The usage period anchor can be moved at the same time.

post/v3/openmeter/customers/{customerId}/entitlements/{entitlementId}/reset

Request

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

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH
entitlementIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

effective_atstring date-time

The time the reset takes effect. Defaults to the current time and cannot be in the future. Truncated to the minute.

retain_anchorboolean

Whether the usage period anchor is kept. When false, the anchor moves to effective_at.

preserve_overageboolean

Whether overage carries over into the new usage period. Defaults to the entitlement's own setting.

Example request

{
  "effective_at": "2023-01-01T01:01:01.001Z"
}

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