CommetCommet
GitHubDiscordStatus
Check usage availability POSTSet current usage PUTTrack usage event POST
DocumentaciónRecursosConstruir con AIAPI ReferenceWebhooks

Check usage availability

Check if a customer can consume a feature before actual consumption. Returns availability and cost estimates based on the plan's consumption model.

POST
/usage/check

Check if a customer can consume a feature before actual consumption. Returns availability and cost estimates based on the plan's consumption model.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Header Parameters

Idempotency-Key?string

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

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/usage/check" \  -H "Content-Type: application/json" \  -d '{    "customerId": "string",    "featureCode": "string"  }'
{  "allowed": true,  "subscriptionStatus": "active",  "featureCode": "api_calls",  "quantity": 1,  "consumptionModel": "metered",  "current": 250,  "remaining": 750,  "unlimited": false,  "included": 1000,  "overageEnabled": false,  "overageUnitPrice": null,  "object": "usage_check",  "livemode": false}
{  "error": {    "type": "validation_error",    "code": "validation_error",    "message": "The request contains an invalid parameter.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"  }}
{  "error": {    "type": "authentication_error",    "code": "unauthorized",    "message": "A valid API key is required.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"  }}
{  "error": {    "type": "authentication_error",    "code": "forbidden",    "message": "You do not have permission to perform this operation.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"  }}
{  "error": {    "type": "not_found_error",    "code": "not_found",    "message": "The requested resource was not found.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md"  }}
{  "error": {    "type": "conflict_error",    "code": "idempotency_in_progress",    "message": "A request with this idempotency key is still being processed.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"  }}
{  "error": {    "type": "validation_error",    "code": "validation_error",    "message": "The requested operation is not valid for the current configuration.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"  }}
{  "error": {    "type": "rate_limit_error",    "code": "rate_limited",    "message": "Too many requests. Retry after the interval specified in the Retry-After header.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"  }}
{  "error": {    "type": "internal_error",    "code": "internal_error",    "message": "An unexpected error occurred while processing the request.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"  }}
{  "error": {    "type": "internal_error",    "code": "idempotency_unavailable",    "message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"  }}

Retry transaction POST

Retry a failed subscription renewal and return an honest retry result. The original failed transaction remains immutable.

Set current usage PUT

Set a metered feature's usage to an exact value for the current period. Use the Idempotency-Key header to make retries safe.

customerId*string
Length1 <= length <= 200
featureCode*string
Match^[a-z0-9_]+$
Length1 <= length <= 50
quantity?integer
Range0 < value <= 9007199254740991
Default1