> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.suby.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> The Suby.fi v3 REST API — base URL, auth, and conventions.

The v3 API is organized around REST. Resources are plural and live under the
`/v3` prefix. All requests are authenticated with your
[API key](/v3-beta/authentication) in the `X-Suby-Api-Key` header.

* **Base URL** — `https://api.beta.suby.fi`
* **Auth** — `X-Suby-Api-Key: sk_live_…` (or `sk_sandbox_…`)
* **Envelope** — `{ "success": true, "data": … }` / `{ "success": false, "error": …, "message": … }`
* **Money** — integer cents; token amounts as strings in smallest unit
* **Pagination** — cursor-based (`?limit=`, `?cursor=` → `pagination.nextCursor`)

See [Errors & responses](/v3-beta/errors) for status codes and error codes.

## Resources

| Group                 | Description                                                   |
| --------------------- | ------------------------------------------------------------- |
| **Payments**          | Create, capture, void, list, and retrieve payments; receipts. |
| **Subscriptions**     | Start, retrieve, and cancel subscriptions.                    |
| **Products**          | Manage the product catalog + product analytics.               |
| **Customers**         | Customer records, billing address, and customer analytics.    |
| **Payment Methods**   | List and revoke saved customer payment methods.               |
| **Setup Intents**     | Save a payment method for off-session charges.                |
| **Checkout Sessions** | Signed hosted-checkout tokens.                                |
| **Checkout Settings** | Hosted-checkout branding.                                     |
| **Webhook Endpoints** | Register destinations and rotate signing secrets.             |
| **Analytics**         | Org-wide revenue analytics.                                   |

Pick an endpoint from the sidebar to see its parameters, request body, and
response schema, with a live "Try it" panel.
