Spend credits
consume_entitlement_creditsAtomically spend credits from a single credit pack, with retries that never double-spend when an idempotency key is supplied. Refused when the pack has too few credits left.
Instructions
Spend credits.
Spends credits from one credit pack, atomically. Refused when fewer are left. action labels the spend for your reports; with an Idempotency-Key a retry never spends twice. To spend from a customer's packs together, use POST /credits/consume.
Test keys only: refused with a live key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The object's id. | |
| action | No | Your label for what the credits paid for. | |
| credits | Yes |