Skip to main content
POST
Check usage availability
This reference describes API version 2026-07-31. Send Commet-Version: 2026-07-31 with your request.

Authorizations

x-api-key
string
header
required

Headers

Commet-Version
string
default:2026-07-31

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

Body

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

Response

Success

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