Sign in
OpenMeter Entitlements

Reset customer entitlement usage

Changed on

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/openmeter/customers/{customerId}/entitlements/{entitlementId}/reset

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/customers/{customerId}/entitlements/{entitlementId}/reset
  • Auth: none declared

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

RFC3339 formatted date-time string in UTC.

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