API Reference
Orders, Refunds, and Disputes API
Developer-visible order/reporting and partner external-order refund surfaces. Broad internal order tables and owner controls are intentionally not published.
POST /activateGET /validatePOST /deactivate
Product credentials
Activation request
Entitlement check
Device registration
Periodic validation
Deactivation when needed
SoundSync
Verified endpoints
These endpoints are route-backed in the current platform.
GET
/api/developer/analytics/revenue/activity
List developer revenue/order activity shown in analytics.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- date range/filter query
- Returns
- Activity rows for orders, refunds, product activity, and revenue context.
- Side effects
- None for read endpoints unless noted.
GET
/api/developer/analytics/overview
Return developer analytics overview including commerce KPIs.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- date range query
- Returns
- Summary cards, timeline, products, orders, downloads, activations, marketplace, promotions, subscriptions, and exported field parity.
- Side effects
- None for read endpoints unless noted.
GET
/api/developer/analytics/overview/export.csv
Export developer analytics overview as CSV.
- Auth
- Developer JWT.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Developer JWT
- date range query
- Returns
- text/csv developer analytics export.
- Side effects
- None for read endpoints unless noted.
POST
/api/partner/v1/orders/:externalOrderId/refund
Partner-facing external-order refund/reversal route.
- Auth
- Scoped partner API key with licenses:revoke behavior.
- Scope
- Developer-owned or public storefront/marketplace scope as noted.
- Request fields
- Partner API key
- externalOrderId
- reason/metadata body
- Returns
- Refund/revocation response for partner-visible fulfillment.
- Side effects
- Applies partner refund/revoke behavior and logs API request.
SoundSync
Order states
Use these states when building support/reporting UI.
| State | Meaning | Access rule | Recovery |
|---|---|---|---|
| paid | Payment completed or free claim completed. | Sale ledger entries created; settlement/journal allocation may be created when enabled. | Active entitlements and downloads allowed. |
| refunded | Full refund or reversal recorded. | Negative/refund ledger and recovery/settlement adjustments may apply. | Downloads blocked when entitlement becomes inactive. |
| partially_refunded | Partial refund supported by order status enum and refund service. | Partial negative adjustment may apply. | Download behavior follows entitlement state. |
| disputed | Dispute/chargeback event recorded. | Recovery/reserve/provisional accounting may apply. | Downloads follow entitlement state. |
| failed | Payment failed before durable checkout completion. | No sale ledger entitlement grant. | No protected downloads. |
| canceled | Checkout canceled or order canceled before access grant. | No sale ledger entitlement grant unless another source exists. | No protected downloads. |
| migrated | Imported historical order/access. | Migration ledger depends on import path. | Downloads follow entitlement state. |
API reference
Endpoint groups are organized by authentication model, product scope, request shape, response shape, errors, idempotency, and integration surface.
Orders API
/docs/api/orders
Developer-visible order reporting and partner refund routes.