Sign in
features

Check and reserve flag

post/flags/{key}/check-and-reserve

Path parameters

keystring required

key

Request body

companyobject nullable
expires_atstring date-time nullable

When the hold lapses if no track event settles it; defaults to one minute from now and may be at most one hour out. The unspent hold is refunded on expiry

idempotency_keystring nullable

A caller-chosen key for safe retries: a second request with the same key returns the original reservation instead of taking another hold

quantitynumber double nullable

Units of the feature the operation will consume. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event. When it is omitted the units come from preflight.event_usage.quantity, if that event subtype is the entitlement's, else from preflight.usage, else 1

userobject nullable

Response

OK

paramsobject required

Input parameters

Changes

Changed in 3 of the 171 revisions of this API.12