Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Entitlements
Customers

Reset customer entitlement

Reset marks the start of a new usage period for the entitlement and initiates grant rollover. At the start of a period usage is zerod out and grants are rolled over based on their rollover settings. It would typically be synced with the customers billing period to enforce usage based on their subscription.

Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.

post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset

Path parameters

string required

ULID (Universally Unique Lexicographically Sortable Identifier).

OR
string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH
entitlementIdOrFeatureKeystring required

Request body

effectiveAtstring date-time

The time at which the reset takes effect, defaults to now. The reset cannot be in the future. The provided value is truncated to the minute due to how historical meter data is stored.

retainAnchorboolean

Determines whether the usage period anchor is retained or reset to the effectiveAt time.

  • If true, the usage period anchor is retained.
  • If false, the usage period anchor is reset to the effectiveAt time.
preserveOverageboolean

Determines whether the overage is preserved or forgiven, overriding the entitlement's default behavior.

  • If true, the overage is preserved.
  • If false, the overage is forgiven.

Example request

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

Response

There is no content to send for this request, but the headers may be useful.