> ## Documentation Index
> Fetch the complete documentation index at: https://docs.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** · every field ends in `Cents` and carries a string of digits (`"1999"` = 19.99); token amounts likewise, 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 |
| - | - |
| **Checkout** | Signed hosted-checkout tokens. Where every payment starts, and the only place a card is collected. |
| **Payments** | Read, refund, receipts · plus the off-session debit of a stored card (pay-as-you-go) and crypto. |
| **Subscriptions** | Drive a live subscription: read it, change its plan, end it. Opened by a checkout session. |
| **Products** | The catalogue. A `recurringInterval` is what makes a product a plan. |
| **Customers** | Customer records and billing address. |
| **Payment Methods** | Read and revoke stored cards. They are created by a checkout session. |
| **Discount Codes** | Promo codes, redeemed at checkout. |
| **Licences** | Called by the buyer's software · the licence key is the credential, so no API key is sent. |

Analytics, checkout branding, webhook-endpoint management and post-payment access
configuration live in the dashboard. Webhooks are still emitted · only choosing
where they go left the API.

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.