API Reference

All responses use one envelope:

{ "success": true, "data": { } }
{ "success": false, "error": { "code": "invalid_signature", "message": "..." } }

Always check success before reading data/error. See Errors for the complete error.code list, and Authentication for the two auth strategies used below.

Endpoints

• 03.01 — POST /api/v1/checkout-sessions
• 03.02 — /api/v1/subscriptions/{external_ref} (get, set customer, change plan)
• 03.03 — GET /checkout/{public_token} (hosted picker page)
• 03.04 — Testing without a real Stripe account
• 03.05 — GET /api/v1/transactions/{transaction_id}
• 03.06 — /api/v1/customers
• 03.07 — /api/v1/plans (plans and prices)
• 03.08 — Subscription lifecycle

POST /api/v1/webhooks/stripe is not called by you — see Webhooks instead.

---

Table of contents

• POST /checkout-sessions
• Subscriptions
• Hosted checkout picker page
• Testing without a real Stripe account
• GET /transactions/{transaction_id}
• Customers
• Plans and prices
• Subscription lifecycle