SUQO External API
Public, API-key-authenticated endpoints for third-party consumers. Use the API to read your products, create and manage subscriptions, and list your customers directly from your own software.
Base URLs
Every endpoint lives under the base path /api/v1/. Pick the environment you're targeting:
| Environment | Base URL |
|---|---|
| Live | https://be.suqo.ai |
| Sandbox | https://test-be.suqo.ai |
So a full request URL looks like:
https://be.suqo.ai/api/v1/products/Build and test against the sandbox first — no checkout SMS and no real money. Email is the exception: it is delivered for real even in the sandbox.
Authentication
All endpoints authenticate with a bearer API key. Generate one in the API Integration section of the seller dashboard, then send it in the Authorization header:
Authorization: Bearer <api_key>See Authenticate your requests to set this up.
A first integration
The shortest path from nothing to a paid subscription:
| Step | Page |
|---|---|
| 1. Generate a key and send it | Authenticate your requests |
| 2. Point at the test environment | Test against the sandbox |
3. Find a plan's pbp_id | Products |
| 4. Create the subscription and redirect the buyer | Create a subscription |
| 5. Learn whether payment succeeded | Receive webhook events |
Reference
| Page | What it covers |
|---|---|
| Subscriptions | List endpoint and response envelope. |
| Products | List your active products, plans and billing periods. |
| Customers | List and retrieve your customers. |
| Webhook events | Event catalogue, payloads and request format. |
| Object fields | Every shared object shape in one place. |
| Subscription statuses | The six status values and what each means. |
| Errors | Error shapes, auth failures and per-endpoint codes. |
Trailing slash required. Every route ends in
/. A GET without it 301-redirects; a POST without it fails, because the redirect can't preserve the body. See Errors.