STstiggio
Subscriptions

Charge subscription usage

Changed on

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

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/subscriptions/{id}/usage/charge
  • Auth
    API key in header X-API-KEY

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.

Changes

  • 913f273cc2f7Revision changes
    • warning

      added the new ContractNotFound enum value to the response property for the response status

  • b876edd1a4fcRevision changes
    • warning

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

    • warning

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

    • warning

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

    • warning

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

    • warning

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status