API Reference
Explore Sobtra's REST API by resource. Select a category to view its endpoints, request parameters, examples, and integration notes.
Backend origin
Every request goes to api.sobtra.com. Endpoint paths below include the /api/v1 prefix, so they are appended to the bare origin.
https://api.sobtra.com/api/v1The dashboard reads the origin from NEXT_PUBLIC_SOBTRA_API_URL. Servers that need the canonical hosts at runtime can read GET /platform/metadata/api instead of hard-coding them.
Authentication
Server-to-server callers authenticate with a merchant API key: Authorization: Bearer sk_…. A key is bound to one environment, so test and live traffic never share records. Incoming payment-provider webhooks use provider-specific authentication and signature verification instead.
Customers
11 documented endpoints
Payment Gateways
2 documented endpoints
Payment Methods
5 documented endpoints
Products
9 documented endpoints
Invoices
8 documented endpoints
Payments
3 documented endpoints
Refunds
4 documented endpoints
Subscriptions
14 documented endpoints
Webhooks
6 documented endpoints
Review the incoming payment-provider webhook endpoint.