credits

Extend credit lease

Changed on
put/billing/credits/lease/{lease_id}/extend

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/billing/credits/lease/{lease_id}/extend
  • Auth
    API key in header X-Schematic-Api-Key

Path parameters

lease_idstring required

lease_id

Request body

additional_amountnumber double required
expires_atstring date-time nullable

Pushes the lease's expiry out; may be at most one hour from now. Leave unset to keep the expiry the lease already has

idempotency_keystring nullable

A caller-chosen key for safe retries: a second request with the same key returns the lease as it stands instead of growing it again. Keys are unique per environment across every extend

user_idstring nullable

The user drawing the top-up, so a user-scope spend policy applies to it

Response

OK

paramsobject required

Input parameters

Changes