SCschematichq
credits

Reserve credits

Changed on
post/billing/credits/reservations

Request

  • Base URL
    https://api.schematichq.com
  • Auth
    API key in header X-Schematic-Api-Key

Request body

amountnumber double required

Credits to hold for the operation. The full amount must be available; a partial hold is never taken

company_idstring required
credit_type_idstring required
expires_atstring date-time nullable

When the hold lapses if no track event settles it; defaults to one minute from now and may be at most 24 hours out. The unspent hold is refunded on expiry

idempotency_keystring nullable

A caller-chosen key for safe retries: a second request with the same key returns the original reservation instead of taking another hold

Response

Created

paramsobject required

Input parameters

Changes