v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Subscriptions

Charge subscription usage

Immediately charges usage for a subscription via the billing integration. Calculates usage since the last charge and creates an invoice.

post/api/v1/subscriptions/{id}/usage/charge

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

untilDatestring date-time

Cutoff date for usage calculation. If not provided, the current time is used.

Response

The charge result including period, invoice ID, and usage details.