Skip to main content
POST
cURL
Check if a customer can consume a feature before actual consumption. Returns availability and cost estimates based on the plan’s consumption model.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
predeterminado:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Cuerpo

application/json
customerId
string
requerido
Required string length: 1 - 200
featureCode
string
requerido
Required string length: 1 - 50
Pattern: ^[a-z0-9_]+$
quantity
integer
predeterminado:1
Rango requerido: x <= 9007199254740991

Respuesta

Success

allowed
boolean
requerido
subscriptionStatus
string
requerido
featureCode
string
requerido
quantity
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
consumptionModel
string
requerido
Allowed value: "metered"
current
number
requerido
remaining
number
requerido
unlimited
boolean
requerido
included
number
requerido
overageEnabled
boolean
requerido
overageUnitPrice
number | null
requerido
object
string
requerido
Allowed value: "usage_check"
livemode
boolean
requerido
reason
string
message
string