API Reference Overview

Index of every developer API resource and the rules they all share.

View as Markdown

Paths follow /api/{Resource}[/{resourceId}][/{Action}] (e.g. /api/PaymentLink, /api/Subscription/{subscriptionId}/Cancel), authenticated with Authorization: Bearer <API Key>. Success responses are { data }; lists also carry page, pageSize, totalCount and totalPages; failures are { error: { code, message } }. Lists take page (from 1), pageSize (default 20, max 200), orderBy, orderDirection (ASC/DESC), createdFrom and createdTo. Fields are camelCase and enum values PascalCase (e.g. Active, PastDue). The full machine-readable spec is at GET /api/OpenApi?audience=developer.

Resources