Account & credits
Updated 9/17/2026Account & credits
API-authenticated, live-mode orders are paid from a prepaid credit balance rather than a per-order card charge.
Check your balance
GET /api/v1/account/credits
json{ "balancePence": 4250 }
- With an API key, the balance returned matches the key's mode (test keys always report a synthetic/unlimited test balance since no real deduction happens).
- With a dashboard session, the balance returned matches whichever mode (test/live) is currently active in the dashboard's mode switcher.
Topping up
Credits are purchased via Stripe Checkout from the dashboard:
POST /api/v1/account/credits/checkout
This returns a Stripe Checkout session URL. There is currently no API-only top-up flow — direct users to Dashboard → Settings → Billing to add funds.
How orders consume credit
For a live order created with an API key, the order's price (
pricePence) is deducted from your balance at creation time, atomically — if the deduction fails (insufficient balance), the order is never created and you receive a 402 (see Creating orders). A cancelled or refunded order credits the amount back to your balance.Errors
| Status | Meaning |
|---|---|
401 Unauthorized | Missing/invalid API key or session. |
LetterAPIPrint and post letters in the UK, from one letter to thousands.
© 2026 LetterAPI. All rights reserved.