API reference
Partner Hub Management API
Manage reseller relationships, product assignments, serial inventory and conversations with developer workspace authentication.
Choose the correct partner surface
Relationship operations are first-party developer workspace calls authenticated with an account Bearer token. They require partners.view and all-products scope; writes additionally require partners.manage. Serial-pool export also requires partners.manage. The separate product promo-kit operations require partners.manage and assigned-product access even for GET, without requiring all-products scope. An external reseller must use its approved partner integration, not a developer account token.
Relationship discovery, requests, decisions, assignments, serial pools and conversations are separate from external order fulfillment and money movement. A saved commercial term or serial allocation does not prove a sale, collected payment, tax remittance or payout. External sellers cover their own processing costs. SoundSync-managed checkout follows the current Full Store pricing: a 3% SoundSync sales fee plus the actual provider processing fees paid by the developer.
Request a relationship, then assign products
Read the reseller directory and existing relationships before requesting one with partnerId. An existing relationship can be returned rather than duplicated. Accept or deny only an eligible request. Pausing/resuming a relationship is not the same as deleting products or refunding customer orders.
Product assignment uses a catalog product ID; later PATCH/DELETE uses the assignment record ID. Review supported SKUs, commercial terms and basis-point shares before saving. Assignment does not grant every product in the workspace. Allocate serial inventory only after checking the active relationship, product eligibility and supported pool rules; reconcile an uncertain allocation before retrying.
Keep conversations and serial exports private
Start a thread with subject and body/message; reply using the thread ID within the same relationship. Message responses return a thread or message wrapper. Thread message pages report has_more, limit and offset. Never include customer passwords, tokens or full serials in messages.
Serial-pool export returns a private CSV attachment with one serial license per line and no header, quotation marks or other columns. Keep it out of screenshots, public links and logs. Allocation is inventory, not evidence that each key was sold or redeemed.
Read reporting without mistaking estimates for payments
The overview covers the current month, sales-analytics groups reported amounts by currency, and hub-records pages orders, licenses, conversations, campaigns or statements. pool-estimates and serial-pools describe allocated reseller inventory. Historical orders, customers, licenses, statements, settings and API-health have their own read operations.
These records can include private identity, serials and commercial terms. Reported external sales and expected payables are not funded SoundSync checkout earnings. API-health reports saved key configuration and 30-day request statistics, not a real-time connection guarantee.
Edit commercial terms and partner deals deliberately
The terms action saves relationship-level commercial, visibility and supported capability settings; settings PATCH routes are compatible aliases. Share percentages are expressed in basis points. Suspending or ending a relationship does not refund external payments or erase historical records.
Partner campaigns are reseller scheduled deals, not email campaigns. Both create and edit require a name. Campaign PATCH replaces normalized descriptive fields: omitted status becomes draft, and omitted dates, notes and description can be cleared. Read the current record and send the complete intended details. An optional product must already be assigned to the relationship.
Prepare a product promo kit
Use promo-kit to share approved descriptive copy, feature bullets, suggested prices, license terms and promotional media references for an assigned product. Its PUT replaces kit content; read and preserve intended fields before saving. Asset PATCH retains omitted fields, while DELETE removes the reference rather than promising physical deletion of a hosted file.
Use media you have the right to distribute. A URL/storage-key reference is not a binary upload or authorized customer download. A promo-kit price suggestion does not change checkout prices; artwork in the kit is separate from marketplace approval and website artwork preferences.
SoundSync
External integrations and payout reporting
SoundSync
Requests and responses
/api/developer/partners/directory/resellers
Browse the eligible reseller directory
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope.
- Returns
- HTTP 200: resellers.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"resellers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers
List developer reseller relationships
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope.
- Returns
- HTTP 200: relationships.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationships": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}
Read an owned reseller relationship
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope.
- Returns
- HTTP 200: relationship.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/requests
Request a developer-reseller relationship
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Request fields
- partnerId: integer
- partner_id: integer
- message: string
- reason: string
- note: string
- Returns
- HTTP 201: relationship.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply. Creates a relationship request, not approval or permission to sell every product.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"partnerId": {
"type": "integer",
"minimum": 1
},
"partner_id": {
"type": "integer",
"minimum": 1
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"note": {
"type": "string"
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"partnerId"
]
},
{
"required": [
"partner_id"
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/accept
Accept an eligible reseller request
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Request fields
- reason: string
- Returns
- HTTP 200: relationship.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply. The current request side and status must allow this decision. Re-read state after a conflict.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/deny
Deny a reseller request
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Request fields
- reason: string
- Returns
- HTTP 200: relationship.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply. The current request side and status must allow this decision. Re-read state after a conflict.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/pause
Set the relationship to paused
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Returns
- HTTP 200: relationship.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/resume
Set the relationship to active
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Returns
- HTTP 200: relationship.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/products
List assigned relationship products
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope.
- Returns
- HTTP 200: products.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/products/assign
Assign or approve an owned product for this relationship
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Request fields
- productId: integer
- product_id: integer
- status: string
- resellerSku: string
- reseller_sku: string
- resellerProductName: string
- commercialModel: string
- commissionRateBps: integer
- developerRevenueShareBps: integer
- currency: string
- minimumAdvertisedPriceCents: integer
- licenseCap: integer
- monthlyLicenseCap: integer
- apiEnabled: boolean
- manualIssueEnabled: boolean
- staticExportEnabled: boolean
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- HTTP 201: product.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply. Supported snake-case commercial fields are also accepted. Commission/share fields are basis points. This saves an assignment; it does not create a sale, license claim or payout. Review commercial terms before saving.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"productId": {
"type": "integer",
"minimum": 1
},
"product_id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"resellerSku": {
"type": "string"
},
"reseller_sku": {
"type": "string"
},
"resellerProductName": {
"type": "string"
},
"commercialModel": {
"type": "string"
},
"commissionRateBps": {
"type": "integer"
},
"developerRevenueShareBps": {
"type": "integer"
},
"currency": {
"type": "string"
},
"minimumAdvertisedPriceCents": {
"type": "integer"
},
"licenseCap": {
"type": "integer"
},
"monthlyLicenseCap": {
"type": "integer"
},
"apiEnabled": {
"type": "boolean"
},
"manualIssueEnabled": {
"type": "boolean"
},
"staticExportEnabled": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"productId"
]
},
{
"required": [
"product_id"
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"product": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/products/{assignmentId}
Update the saved product assignment
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Request fields
- productId: integer
- product_id: integer
- status: string
- resellerSku: string
- reseller_sku: string
- resellerProductName: string
- commercialModel: string
- commissionRateBps: integer
- developerRevenueShareBps: integer
- currency: string
- minimumAdvertisedPriceCents: integer
- licenseCap: integer
- monthlyLicenseCap: integer
- apiEnabled: boolean
- manualIssueEnabled: boolean
- staticExportEnabled: boolean
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- HTTP 200: product.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply. assignmentId is the relationship-product record, not the catalog product ID. Omitted saved fields are retained; reload the assignment before editing commercial terms.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"productId": {
"type": "integer",
"minimum": 1
},
"product_id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"resellerSku": {
"type": "string"
},
"reseller_sku": {
"type": "string"
},
"resellerProductName": {
"type": "string"
},
"commercialModel": {
"type": "string"
},
"commissionRateBps": {
"type": "integer"
},
"developerRevenueShareBps": {
"type": "integer"
},
"currency": {
"type": "string"
},
"minimumAdvertisedPriceCents": {
"type": "integer"
},
"licenseCap": {
"type": "integer"
},
"monthlyLicenseCap": {
"type": "integer"
},
"apiEnabled": {
"type": "boolean"
},
"manualIssueEnabled": {
"type": "boolean"
},
"staticExportEnabled": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"product": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/products/{assignmentId}
Remove the supported product assignment
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Returns
- HTTP 200: product.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply. Does not issue a refund or erase customer payment history.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"product": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/serials
Read relationship serial inventory
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope.
- Returns
- HTTP 200: serials.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"serials": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/serials/allocate
Allocate product serial inventory
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Request fields
- productId: integer
- product_id: integer
- relationshipProductId: integer
- quantity: integer
- batchLabel: string
- notes: string
- fulfillmentMode: "generated_serials"
- prefix: string
- price: number
- price_cents: integer
- sale_price: number
- sale_price_cents: integer
- expiresAt: string,null
- autoRevokeUnusedOnExpiry: boolean
- promoStart: string,null
- promoExpires: string,null
- Returns
- HTTP 201: pool, allocation, quantity, count, items_created, serials.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply. The current generated-pool model requires productId/product_id and a regular price or price_cents estimate, including explicit 0 for a free product. quantity defaults to 1. Only generated_serials is supported; serial imports are rejected by this path. Product serial support and an active relationship are checked. The optional four-character prefix is letters/numbers. Expiry must be future-dated; automatic unused-serial removal requires an expiry. Supported snake-case aliases are accepted. This allocates inventory, not proof of a reported sale or payment. No blanket idempotency guarantee; reconcile an uncertain allocation before retrying.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"productId": {
"type": "integer",
"minimum": 1
},
"product_id": {
"type": "integer",
"minimum": 1
},
"relationshipProductId": {
"type": "integer",
"minimum": 1
},
"quantity": {
"type": "integer",
"minimum": 1
},
"batchLabel": {
"type": "string"
},
"notes": {
"type": "string"
},
"fulfillmentMode": {
"const": "generated_serials"
},
"prefix": {
"type": "string",
"pattern": "^[A-Za-z0-9]{4}$"
},
"price": {
"type": "number"
},
"price_cents": {
"type": "integer"
},
"sale_price": {
"type": "number"
},
"sale_price_cents": {
"type": "integer"
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"autoRevokeUnusedOnExpiry": {
"type": "boolean"
},
"promoStart": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"promoExpires": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"pool": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"allocation": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"quantity": {
"type": "integer"
},
"count": {
"type": "integer"
},
"items_created": {
"type": "integer"
},
"serials": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/serials/{poolId}/export
Download allocated serials as private CSV
- Auth
- Account Bearer session token
- Scope
- partners.view + partners.manage and all-products workspace scope.
- Returns
- HTTP 200: text/csv.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply. The CSV contains one serial license per line, with no header, quotation marks, extra columns or byte-order mark. This read additionally requires partners.manage because the CSV contains usable serials. Preserve the private attachment; never expose it in public logs or documentation.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (text/csv)
{
"type": "string",
"format": "binary"
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/conversations
Read relationship conversation threads
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope.
- Returns
- HTTP 200: conversations.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"conversations": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/conversations
Start a relationship conversation
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Request fields
- body: string
- message: string
- attachments: array
- internal_note: boolean
- subject: string (required)
- threadType: string
- linkedProductId: integer
- linkedExternalOrderId: integer
- Returns
- HTTP 201: thread, message.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply. A subject and non-empty body/message are required. Do not put customer credentials or full serials into messages.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"body": {
"type": "string"
},
"message": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"internal_note": {
"type": "boolean"
},
"subject": {
"type": "string"
},
"threadType": {
"type": "string"
},
"linkedProductId": {
"type": "integer",
"minimum": 1
},
"linkedExternalOrderId": {
"type": "integer",
"minimum": 1
}
},
"required": [
"subject"
],
"additionalProperties": true,
"anyOf": [
{
"required": [
"body"
]
},
{
"required": [
"message"
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"thread": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"message": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/conversations/{threadId}/messages
Read messages in an owned relationship thread
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope.
- Request fields
- query limit: integer
- query offset: integer
- Returns
- HTTP 200: thread, messages, has_more, limit, offset.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply. The thread must belong to this relationship. Message pages are returned in chronological display order.
Request, response and error reference
Query and header parameters
[
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer"
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"thread": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"messages": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/conversations/{threadId}/messages
Reply to an owned relationship thread
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope. Also requires partners.manage.
- Request fields
- body: string
- message: string
- attachments: array
- internal_note: boolean
- Returns
- HTTP 201: message.
- Notes
- partners.view and all-products workspace scope. Writes additionally require partners.manage. Relationship and product ownership checks still apply.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"body": {
"type": "string"
},
"message": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"internal_note": {
"type": "boolean"
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"body"
]
},
{
"required": [
"message"
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"message": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/activity
Read the relationship activity history
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope.
- Request fields
- query limit: integer
- query offset: integer
- Returns
- HTTP 200: activity.
- Notes
- partners.view and all-products workspace scope. Relationship and product ownership checks still apply.
Request, response and error reference
Query and header parameters
[
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer"
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"activity": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/overview
Read the current-month Partner Hub summary
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: overview.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Reported reseller amounts and estimates are not funded SoundSync-managed checkout balances.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"overview": {
"type": "object",
"properties": {
"active_resellers": {
"type": "integer"
},
"pending_relationships": {
"type": "integer"
},
"external_reported_sales_cents": {
"type": "integer"
},
"external_order_count": {
"type": "integer"
},
"licenses_issued": {
"type": "integer"
},
"expected_payable_cents": {
"type": "integer"
},
"external_fulfillment_events": {
"type": "integer"
},
"api_health_warnings": {
"type": "integer"
},
"unread_partner_messages": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/sales-analytics
Read current-month reseller reporting by currency
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: period, currencies.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"period": {
"const": "current_month"
},
"currencies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string"
},
"order_count": {
"type": "integer"
},
"gross_product_cents": {
"type": "number"
},
"refunded_line_cents": {
"type": "number"
},
"net_product_cents": {
"type": "number"
},
"developer_receivable_cents": {
"type": "number"
},
"reseller_remainder_cents": {
"type": "number"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/hub-records/{kind}
Read the paginated workspace Partner Hub records
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Request fields
- query limit: integer
- query offset: integer
- Returns
- HTTP 200: kind, total, limit, offset, records.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. kind is orders, licenses, conversations, campaigns or statements. Default limit 25, maximum 100; offset is bounded to 1,000,000. Results can contain customer identity and serials and must remain private.
Request, response and error reference
Query and header parameters
[
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"required": false,
"description": ""
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"total": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/pool-estimates
Read serial-pool estimates grouped by currency
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: estimates, pool_count.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Estimated reseller proceeds are not a customer payment, funded settlement or completed payout.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"estimates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"pool_count": {
"type": "integer"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/serial-pools
Read serial pools across owned relationships
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: pools.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"pools": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/overview
Read a relationship and its related records
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: relationship, products, orders, licenses, api_keys, conversations, statements, activity.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Contains private historical records. URL alias: /resellers/{relationshipId}/overview.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"orders": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"api_keys": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"conversations": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"statements": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"activity": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/orders
Read historical external orders
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Request fields
- query limit: integer
- query offset: integer
- Returns
- HTTP 200: orders, has_more, limit, offset.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Default limit 25. The /resellers/{relationshipId}/orders GET alias is supported; its POST write remains retired.
Request, response and error reference
Query and header parameters
[
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"required": false,
"description": ""
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/customers
Read relationship customer purchase summaries
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: customers.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. At most 100 customer summaries. Includes private customer identity; no platform-wide customer-list access is granted. /resellers/{relationshipId}/customers is an alias.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"customers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/licenses
Read paginated relationship licenses
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Request fields
- query limit: integer
- query offset: integer
- Returns
- HTTP 200: licenses, has_more, limit, offset.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Default limit 100; can include usable serials and customer identity. Preserve exact bigint IDs, which may arrive as decimal strings.
Request, response and error reference
Query and header parameters
[
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"required": false,
"description": ""
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"licenses": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/financials
Read reported statement totals and historical statements
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: financials, statements.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Read-only external-sale reporting, not SoundSync payout execution. /resellers/{relationshipId}/financials is an alias.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"financials": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"statements": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/statements
Read historical reseller statements
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: statements.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"statements": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/api-health
Read key configuration and recent API request statistics
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: api_health.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Status is a configuration heuristic based on enabled API and active keys; request counts use 30 days. It is not a real-time connection or delivery guarantee.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"api_health": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"request_count": {
"type": "integer"
},
"error_count": {
"type": "integer"
},
"error_rate": {
"type": "number"
},
"last_sync_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"active_key_count": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/{relationshipId}/settings
Read the saved relationship settings
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: settings.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"settings": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/terms
Save relationship commercial and visibility terms
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Request fields
- displayName: string
- display_name: string,null
- currency: string
- default_currency: string
- commercialModel: string
- default_wholesale_rate_cents: integer
- wholesale_rate: number
- commissionRateBps: integer
- developerRevenueShareBps: integer
- paymentTerms: string
- refundPolicy: string
- customerVisibilityMode: string
- apiEnabled: boolean
- manualIssueEnabled: boolean
- staticSerialExportEnabled: boolean
- monthlyLicenseCap: integer,null
- statementCycle: string
- termStatus: string
- Returns
- HTTP 200: relationship.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Supported snake-case aliases include commercial_model, default_commission_rate_bps, default_developer_revenue_share_bps, payment_terms, default_refund_policy, customer_visibility_mode, api_enabled, manual_issue_enabled, static_serial_export_enabled and monthly_license_cap. Share rates are basis points. PATCH /{relationshipId}/settings and /resellers/{relationshipId}/settings are aliases. Changes are real commercial settings, not a preview; they do not enable a platform financial flag or prove a payment.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"display_name": {
"type": [
"string",
"null"
]
},
"currency": {
"type": "string"
},
"default_currency": {
"type": "string"
},
"commercialModel": {
"type": "string"
},
"default_wholesale_rate_cents": {
"type": "integer"
},
"wholesale_rate": {
"type": "number"
},
"commissionRateBps": {
"type": "integer"
},
"developerRevenueShareBps": {
"type": "integer"
},
"paymentTerms": {
"type": "string"
},
"refundPolicy": {
"type": "string"
},
"customerVisibilityMode": {
"type": "string"
},
"apiEnabled": {
"type": "boolean"
},
"manualIssueEnabled": {
"type": "boolean"
},
"staticSerialExportEnabled": {
"type": "boolean"
},
"monthlyLicenseCap": {
"type": [
"integer",
"null"
]
},
"statementCycle": {
"type": "string"
},
"termStatus": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/suspend
Suspend the supported relationship
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: relationship.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Changes relationship state. It does not refund external payments or erase historical orders and required accounting.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/end
End the supported relationship
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: relationship.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Changes relationship state. It does not refund external payments or erase historical orders and required accounting.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/campaigns
Read relationship scheduled deals
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: campaigns.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"campaigns": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/campaigns
Create a reseller scheduled deal
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Request fields
- name: string (required)
- description: string
- status: draft | requested | approved | active | paused | ended | settled | disputed | cancelled
- startAt: string,null
- endAt: string,null
- currency: string
- notes: string
- relationshipProductId: integer
- productId: integer
- approved_sale_price_cents: integer
- commercialModel: string
- wholesale_rate_cents: integer
- commissionRateBps: integer
- developerRevenueShareBps: integer
- licenseCap: integer,null
- Returns
- HTTP 201: campaign.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. A name is required on both create and edit. This is not a sparse PATCH: omitted status becomes draft and omitted descriptions, dates and notes are cleared. Supported snake-case aliases apply. Optional productId/relationshipProductId must resolve to an approved assignment. A partner deal is not a marketing email, managed-checkout promo code or completed sale.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"requested",
"approved",
"active",
"paused",
"ended",
"settled",
"disputed",
"cancelled"
]
},
"startAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"endAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"currency": {
"type": "string"
},
"notes": {
"type": "string"
},
"relationshipProductId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"approved_sale_price_cents": {
"type": "integer"
},
"commercialModel": {
"type": "string"
},
"wholesale_rate_cents": {
"type": "integer"
},
"commissionRateBps": {
"type": "integer"
},
"developerRevenueShareBps": {
"type": "integer"
},
"licenseCap": {
"type": [
"integer",
"null"
]
}
},
"required": [
"name"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"campaign": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/campaigns/{campaignId}
Replace reseller scheduled-deal details
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Request fields
- name: string (required)
- description: string
- status: draft | requested | approved | active | paused | ended | settled | disputed | cancelled
- startAt: string,null
- endAt: string,null
- currency: string
- notes: string
- relationshipProductId: integer
- productId: integer
- approved_sale_price_cents: integer
- commercialModel: string
- wholesale_rate_cents: integer
- commissionRateBps: integer
- developerRevenueShareBps: integer
- licenseCap: integer,null
- Returns
- HTTP 200: campaign.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. A name is required on both create and edit. This is not a sparse PATCH: omitted status becomes draft and omitted descriptions, dates and notes are cleared. Supported snake-case aliases apply. Optional productId/relationshipProductId must resolve to an approved assignment. A partner deal is not a marketing email, managed-checkout promo code or completed sale.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"requested",
"approved",
"active",
"paused",
"ended",
"settled",
"disputed",
"cancelled"
]
},
"startAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"endAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"currency": {
"type": "string"
},
"notes": {
"type": "string"
},
"relationshipProductId": {
"type": "integer",
"minimum": 1
},
"productId": {
"type": "integer",
"minimum": 1
},
"approved_sale_price_cents": {
"type": "integer"
},
"commercialModel": {
"type": "string"
},
"wholesale_rate_cents": {
"type": "integer"
},
"commissionRateBps": {
"type": "integer"
},
"developerRevenueShareBps": {
"type": "integer"
},
"licenseCap": {
"type": [
"integer",
"null"
]
}
},
"required": [
"name"
],
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"campaign": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/api-keys
Read key metadata without revealing private key material
- Auth
- Account Bearer session token
- Scope
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply.
- Returns
- HTTP 200: api_keys.
- Notes
- partners.view and all-products workspace scope; writes additionally require partners.manage. Owned relationship checks apply. Returns key metadata, not plaintext tokens. Creation and rotation require the fulfillment capability; revocation remains available to authorized developers when that capability is disabled. These are separate from the always-disabled developer-created external orders and payable-statement writes.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"api_keys": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/products/{productId}/promo-kit
Read product partner copy and media
- Auth
- Account Bearer session token
- Scope
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product.
- Returns
- HTTP 200: promo_kit.
- Notes
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"promo_kit": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/products/{productId}/promo-kit
Replace product partner copy and commercial presentation
- Auth
- Account Bearer session token
- Scope
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product.
- Request fields
- title: string
- shortDescription: string
- longDescription: string
- featureBullets: array
- category: string
- tags: array
- msrp_cents: integer
- suggested_sale_price_cents: integer
- currency: string
- approvedDiscountRules: string
- systemRequirements: string
- licenseTerms: string
- emailCopy: string
- socialCopy: string
- adCopy: string
- brandGuidelines: string
- status: string
- Returns
- HTTP 200: promo_kit.
- Notes
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product. Read the kit first. Omitted descriptive fields, lists and price suggestions reset to defaults/null; this is a replacement. Supported snake-case field names and msrp/suggested_sale_price decimal aliases are accepted. Saves suggestions and approved copy, not product pricing or an active sale.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"longDescription": {
"type": "string"
},
"featureBullets": {
"type": "array",
"items": {
"type": "string"
}
},
"category": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"msrp_cents": {
"type": "integer"
},
"suggested_sale_price_cents": {
"type": "integer"
},
"currency": {
"type": "string"
},
"approvedDiscountRules": {
"type": "string"
},
"systemRequirements": {
"type": "string"
},
"licenseTerms": {
"type": "string"
},
"emailCopy": {
"type": "string"
},
"socialCopy": {
"type": "string"
},
"adCopy": {
"type": "string"
},
"brandGuidelines": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"promo_kit": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/products/{productId}/promo-kit/assets
Attach an authorized promotional media reference
- Auth
- Account Bearer session token
- Scope
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product.
- Request fields
- assetType: image | logo | screenshot | audio_demo | video | document | banner | other
- title: string
- description: string
- url: string
- storageKey: string
- mimeType: string
- sortOrder: integer
- Returns
- HTTP 201: asset.
- Notes
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product. Accepts asset_type/storage_key/mime_type/sort_order aliases. Requires a URL or storage key, not a binary file upload. Can initialize a missing promo kit.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"assetType": {
"type": "string",
"enum": [
"image",
"logo",
"screenshot",
"audio_demo",
"video",
"document",
"banner",
"other"
]
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"url": {
"type": "string"
},
"storageKey": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"url"
]
},
{
"required": [
"storageKey"
]
},
{
"required": [
"storage_key"
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"asset": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/products/{productId}/promo-kit/assets/{assetId}
Edit a product promotional asset reference
- Auth
- Account Bearer session token
- Scope
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product.
- Request fields
- assetType: image | logo | screenshot | audio_demo | video | document | banner | other
- title: string
- description: string
- url: string
- storageKey: string
- mimeType: string
- sortOrder: integer
- Returns
- HTTP 200: asset.
- Notes
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product. Omitted asset fields retain saved values; the URL or storage key must still resolve in the normalized reference. Does not change marketplace artwork approval.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"assetType": {
"type": "string",
"enum": [
"image",
"logo",
"screenshot",
"audio_demo",
"video",
"document",
"banner",
"other"
]
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"url": {
"type": "string"
},
"storageKey": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"asset": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/products/{productId}/promo-kit/assets/{assetId}
Remove an owned promotional asset reference
- Auth
- Account Bearer session token
- Scope
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product.
- Returns
- HTTP 200: deleted, asset.
- Notes
- partners.manage and assigned-product access, including GET. The product must belong to the effective developer; all-products scope is not required for an assigned product. Deletes the reference row; does not promise deletion of the underlying stored file or erase customer purchases.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"deleted": {
"type": "boolean"
},
"asset": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
Inventory, reported sales and statements have different meanings
The partner workspace separates Overview, Licenses, Sales, Statements, Conversations and Settings. Available serial pools are inventory. Redemptions can estimate activity; they are not the same as a partner-reported sale or an actual statement.
Record a reseller statement with its period, currency, reported sales, amount due, reference and cumulative payment received. A payment record describes money received outside SoundSync; saving it does not initiate a SoundSync payout. Keep currencies separate. Private PDF, CSV or XLSX statement attachments can be up to 5 MB and remain relationship-scoped.
Custom external-order API availability and an approved WooCommerce connection are separate capabilities. A disabled custom fulfillment API does not mean an approved store connection is enabled or disabled. Test validation is not a real license issue. Disconnecting a store removes saved connection credentials and stops new fulfillment while keeping history; remove unused provider keys and webhooks separately.
SoundSync
Workspace reconciliation and statement documents
/api/developer/partners/workspace
Read scoped inventory, sales estimates and recorded statements
- Auth
- Account Bearer session token
- Scope
- Developer partners.view with all-products scope; writes additionally partners.manage. Partner views require active eligible reseller membership and the relevant relationship.
- Request fields
- query start: string
- query end: string
- query page: integer
- query kind: string
- query product_id: integer
- query pool_id: integer
- query relationship_id: integer
- Returns
- HTTP 200: can_record_statements, relationships, filters, sales, has_more, page, summary, daily, pools, products, statements, basis.
- Notes
- UTC date filters, zero-based page and 25 sales rows per page; follow has_more. Unused licenses are inventory. Redemptions are estimates, linked reported lines are counted separately, currencies are not added together and statements do not prove a SoundSync transfer.
Request, response and error reference
Query and header parameters
[
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "kind",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"all",
"estimated",
"reported"
]
}
},
{
"name": "product_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "pool_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "relationship_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"can_record_statements": {
"type": "boolean"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"filters": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"sales": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"has_more": {
"type": "boolean"
},
"page": {
"type": "integer",
"minimum": 0
},
"summary": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"daily": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"pools": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"statements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"relationship_id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"partner_id": {
"type": "integer",
"minimum": 1
},
"period_start": {
"type": "string"
},
"period_end": {
"type": "string"
},
"currency": {
"type": "string"
},
"gross_reported_sales_cents": {
"type": "integer",
"minimum": 0
},
"expected_payable_cents": {
"type": "integer",
"minimum": 0
},
"payment_received_cents": {
"type": "integer",
"minimum": 0
},
"outstanding_balance_cents": {
"type": "integer",
"minimum": 0
},
"status": {
"type": "string"
},
"record_source": {
"type": "string"
},
"record_details": {
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"notes": {
"type": "string"
},
"payment_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"document": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"basis": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/workspace
Read scoped inventory, sales estimates and recorded statements
- Auth
- Account Bearer session token
- Scope
- Developer partners.view with all-products scope; writes additionally partners.manage. Partner views require active eligible reseller membership and the relevant relationship.
- Request fields
- query start: string
- query end: string
- query page: integer
- query kind: string
- query product_id: integer
- query pool_id: integer
- query relationship_id: integer
- Returns
- HTTP 200: can_record_statements, relationships, filters, sales, has_more, page, summary, daily, pools, products, statements, basis.
- Notes
- UTC date filters, zero-based page and 25 sales rows per page; follow has_more. Unused licenses are inventory. Redemptions are estimates, linked reported lines are counted separately, currencies are not added together and statements do not prove a SoundSync transfer.
Request, response and error reference
Query and header parameters
[
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "kind",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"all",
"estimated",
"reported"
]
}
},
{
"name": "product_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "pool_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "relationship_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"can_record_statements": {
"type": "boolean"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"filters": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"sales": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"has_more": {
"type": "boolean"
},
"page": {
"type": "integer",
"minimum": 0
},
"summary": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"daily": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"pools": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"statements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"relationship_id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"partner_id": {
"type": "integer",
"minimum": 1
},
"period_start": {
"type": "string"
},
"period_end": {
"type": "string"
},
"currency": {
"type": "string"
},
"gross_reported_sales_cents": {
"type": "integer",
"minimum": 0
},
"expected_payable_cents": {
"type": "integer",
"minimum": 0
},
"payment_received_cents": {
"type": "integer",
"minimum": 0
},
"outstanding_balance_cents": {
"type": "integer",
"minimum": 0
},
"status": {
"type": "string"
},
"record_source": {
"type": "string"
},
"record_details": {
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"notes": {
"type": "string"
},
"payment_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"document": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"basis": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/statement-records
Record an actual externally supplied reseller statement
- Auth
- Account Bearer session token
- Scope
- Developer partners.view with all-products scope; writes additionally partners.manage. Partner views require active eligible reseller membership and the relevant relationship.
- Request fields
- period_start: string (required)
- period_end: string (required)
- currency: string
- reference: string (required)
- notes: string
- reported_sales: string,number (required)
- amount_due: string,number (required)
- payment_received: string,number (required)
- payment_date: string
- Returns
- HTTP 201: statement.
- Notes
- Amounts are major currency units with at most two decimals, not cents. Period end is exclusive. A positive received payment requires payment_date and cannot exceed due. Duplicate relationship/period/currency returns 409. Blocked accounts/relationships reject writes; paused relationships can reconcile. Recording a statement sends no money.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"period_start": {
"type": "string"
},
"period_end": {
"type": "string"
},
"currency": {
"type": "string"
},
"reference": {
"type": "string"
},
"notes": {
"type": "string"
},
"reported_sales": {
"type": [
"string",
"number"
]
},
"amount_due": {
"type": [
"string",
"number"
]
},
"payment_received": {
"type": [
"string",
"number"
]
},
"payment_date": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"period_start",
"period_end",
"reference",
"reported_sales",
"amount_due",
"payment_received"
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"statement": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"relationship_id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"partner_id": {
"type": "integer",
"minimum": 1
},
"period_start": {
"type": "string"
},
"period_end": {
"type": "string"
},
"currency": {
"type": "string"
},
"gross_reported_sales_cents": {
"type": "integer",
"minimum": 0
},
"expected_payable_cents": {
"type": "integer",
"minimum": 0
},
"payment_received_cents": {
"type": "integer",
"minimum": 0
},
"outstanding_balance_cents": {
"type": "integer",
"minimum": 0
},
"status": {
"type": "string"
},
"record_source": {
"type": "string"
},
"record_details": {
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"notes": {
"type": "string"
},
"payment_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"document": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/statement-records/{statementId}/payment
Record cumulative external payment received
- Auth
- Account Bearer session token
- Scope
- Developer partners.view with all-products scope; writes additionally partners.manage. Partner views require active eligible reseller membership and the relevant relationship.
- Request fields
- payment_received: string,number (required)
- payment_date: string
- Returns
- HTTP 200: statement.
- Notes
- Send cumulative major-unit payment, no lower than previously recorded and no higher than due. Positive payment needs a date. Disputed/written-off review status is preserved. This records receipt outside SoundSync, not a payout request.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"payment_received": {
"type": [
"string",
"number"
]
},
"payment_date": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"payment_received"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"statement": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"relationship_id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"partner_id": {
"type": "integer",
"minimum": 1
},
"period_start": {
"type": "string"
},
"period_end": {
"type": "string"
},
"currency": {
"type": "string"
},
"gross_reported_sales_cents": {
"type": "integer",
"minimum": 0
},
"expected_payable_cents": {
"type": "integer",
"minimum": 0
},
"payment_received_cents": {
"type": "integer",
"minimum": 0
},
"outstanding_balance_cents": {
"type": "integer",
"minimum": 0
},
"status": {
"type": "string"
},
"record_source": {
"type": "string"
},
"record_details": {
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"notes": {
"type": "string"
},
"payment_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"document": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/statement-records/{statementId}/document
Attach a private reseller statement document
- Auth
- Account Bearer session token
- Scope
- Developer partners.view with all-products scope; writes additionally partners.manage. Partner views require active eligible reseller membership and the relevant relationship.
- Request fields
- file: string (required)
- Returns
- HTTP 200: statement.
- Notes
- One PDF, CSV or XLSX file, at most 5 MB. Requires configured private storage. Scope is checked before upload and again after storage. Replacements retain prior document history; private storage keys are not public response fields.
Request, response and error reference
Request (multipart/form-data)
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"additionalProperties": true,
"required": [
"file"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"statement": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"relationship_id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"partner_id": {
"type": "integer",
"minimum": 1
},
"period_start": {
"type": "string"
},
"period_end": {
"type": "string"
},
"currency": {
"type": "string"
},
"gross_reported_sales_cents": {
"type": "integer",
"minimum": 0
},
"expected_payable_cents": {
"type": "integer",
"minimum": 0
},
"payment_received_cents": {
"type": "integer",
"minimum": 0
},
"outstanding_balance_cents": {
"type": "integer",
"minimum": 0
},
"status": {
"type": "string"
},
"record_source": {
"type": "string"
},
"record_details": {
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"notes": {
"type": "string"
},
"payment_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"document": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 413, 415, 500, 503.
/api/developer/partners/resellers/{relationshipId}/statement-records/{statementId}/document
Download the current relationship-scoped private statement document
- Auth
- Account Bearer session token
- Scope
- Developer partners.view with all-products scope; writes additionally partners.manage. Partner views require active eligible reseller membership and the relevant relationship.
- Returns
- HTTP 200: application/octet-stream.
- Notes
- Streams the current document with its actual type and Content-Disposition filename; responses are private/no-store. A missing file needs reattachment, while transient storage failure can be retried. Keep financial and personal information out of public screenshots.
Request, response and error reference
HTTP 200 response (application/pdf)
{
"type": "string",
"format": "binary"
}HTTP 200 response (text/csv)
{
"type": "string",
"format": "binary"
}HTTP 200 response (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet)
{
"type": "string",
"format": "binary"
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
Select the right product and serial delivery
Partner product choices distinguish relationship authorization from serial-pool eligibility. One-time download products can use customer-library redemption codes without enabling native plugin serial activation. Native activation serials remain a separate path with their own product requirements.
Subscription-only products and access-only bundles need their supported fulfillment model; archived products cannot be treated as available inventory. A product appearing in a selection list is not proof that every delivery mode is enabled. Custom Partner API fulfillment still requires SoundSync activation; approved reseller and WooCommerce paths remain separate.
SoundSync
Assignment and pool eligibility
/api/developer/partners/product-options
List owned products and their partner-assignment/serial-pool eligibility
- Auth
- Account Bearer session token
- Scope
- Existing partner workspace permission and all-products scope; only products owned by the effective developer.
- Returns
- HTTP 200: products.
- Notes
- Authorization eligibility and serial-pool eligibility are separate. Download-only one-time products can use Library redemption codes without enabling native serial licensing. Subscription-only or access-only bundle products require their appropriate fulfillment model; archive and activation settings remain enforced.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"product_type": {
"type": "string"
},
"supports_serials": {
"type": "boolean"
},
"requires_activation": {
"type": "boolean"
},
"supports_downloads": {
"type": "boolean"
},
"archived_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"subscription_product": {
"type": "boolean"
},
"authorization_eligible": {
"type": "boolean"
},
"pool_eligibility": {
"type": "object",
"properties": {
"eligible": {
"type": "boolean"
},
"delivery": {
"type": "string",
"enum": [
"activation_serial",
"library_redemption"
]
},
"code": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
Use the relationship ID and the right operation
The /partners/{relationshipId} and /partners/resellers/{relationshipId} aliases below use the same relationship handlers. Every read requires partners.view and all-products workspace scope; writes additionally require partners.manage. Serial CSV export also requires partners.manage even though it is a GET. Existing relationship and product ownership checks remain in force.
relationshipProductId in a reseller product-edit URL is the saved assignment ID called assignmentId in the shorter URL. POST /messages starts a conversation with subject and body/message; it is not a reply shortcut. Reply through /resellers/{relationshipId}/conversations/{threadId}/messages instead. PATCH /settings saves the same commercial terms as PATCH /resellers/{relationshipId}/terms, not the GET settings response object.
SoundSync
Partner Hub compatibility operation map
| Method | Compatibility path | Contract or result |
|---|---|---|
| GET | /api/developer/partners/resellers/{relationshipId} | GET /api/developer/partners/{relationshipId} |
| GET | /api/developer/partners/resellers/{relationshipId}/overview | GET /api/developer/partners/{relationshipId}/overview |
| GET | /api/developer/partners/resellers/{relationshipId}/products | GET /api/developer/partners/{relationshipId}/products |
| GET | /api/developer/partners/resellers/{relationshipId}/orders | GET /api/developer/partners/{relationshipId}/orders |
| GET | /api/developer/partners/resellers/{relationshipId}/customers | GET /api/developer/partners/{relationshipId}/customers |
| GET | /api/developer/partners/resellers/{relationshipId}/serials | GET /api/developer/partners/{relationshipId}/serials |
| GET | /api/developer/partners/resellers/{relationshipId}/serials/{poolId}/export | GET /api/developer/partners/{relationshipId}/serials/{poolId}/export |
| GET | /api/developer/partners/resellers/{relationshipId}/conversations | GET /api/developer/partners/{relationshipId}/conversations |
| GET | /api/developer/partners/resellers/{relationshipId}/financials | GET /api/developer/partners/{relationshipId}/financials |
| GET | /api/developer/partners/resellers/{relationshipId}/statements | GET /api/developer/partners/{relationshipId}/statements |
| GET | /api/developer/partners/resellers/{relationshipId}/api-health | GET /api/developer/partners/{relationshipId}/api-health |
| GET | /api/developer/partners/resellers/{relationshipId}/activity | GET /api/developer/partners/{relationshipId}/activity |
| GET | /api/developer/partners/resellers/{relationshipId}/settings | GET /api/developer/partners/{relationshipId}/settings |
| POST | /api/developer/partners/resellers/{relationshipId}/pause | POST /api/developer/partners/{relationshipId}/pause |
| POST | /api/developer/partners/resellers/{relationshipId}/resume | POST /api/developer/partners/{relationshipId}/resume |
| POST | /api/developer/partners/resellers/{relationshipId}/products/assign | POST /api/developer/partners/{relationshipId}/products/assign |
| POST | /api/developer/partners/resellers/{relationshipId}/serials/allocate | POST /api/developer/partners/{relationshipId}/serials/allocate |
| POST | /api/developer/partners/resellers/{relationshipId}/conversations | POST /api/developer/partners/{relationshipId}/conversations |
| POST | /api/developer/partners/resellers/{relationshipId}/products | POST /api/developer/partners/{relationshipId}/products/assign |
| PATCH | /api/developer/partners/resellers/{relationshipId}/products/{relationshipProductId} | PATCH /api/developer/partners/{relationshipId}/products/{assignmentId}. relationshipProductId is the same saved assignment ID called assignmentId in the preferred path, not a catalog product ID. |
| DELETE | /api/developer/partners/resellers/{relationshipId}/products/{relationshipProductId} | DELETE /api/developer/partners/{relationshipId}/products/{assignmentId}. relationshipProductId is the same saved assignment ID called assignmentId in the preferred path, not a catalog product ID. |
| POST | /api/developer/partners/{relationshipId}/messages | POST /api/developer/partners/{relationshipId}/conversations. Starts a conversation and requires subject plus body/message. To reply to an existing thread, use its thread-specific messages path. |
| PATCH | /api/developer/partners/{relationshipId}/settings | PATCH /api/developer/partners/resellers/{relationshipId}/terms |
| POST | /api/developer/partners/resellers/{relationshipId}/messages | POST /api/developer/partners/{relationshipId}/conversations. Starts a conversation and requires subject plus body/message. To reply to an existing thread, use its thread-specific messages path. |
| PATCH | /api/developer/partners/resellers/{relationshipId}/settings | PATCH /api/developer/partners/resellers/{relationshipId}/terms |
SoundSync
External fulfillment and credential write paths
/api/developer/partners/{relationshipId}/orders
Read the disabled developer-created external-order response
- Auth
- Account Bearer session token
- Scope
- partners.view + partners.manage and all-products workspace scope; owned relationship checks apply.
- Returns
- HTTP 410: code, message.
- Notes
- Returns 410 PARTNER_FULFILLMENT_DISABLED. The developer controller keeps this operation disabled even when the fulfillment capability is enabled; no submitted order or payable statement is created or updated. Authorized historical GET reads remain separate. Use the approved Partner API/portal for external fulfillment and the current statement-record/document tools for reseller reconciliation. A recorded external statement is not a SoundSync-funded payout.
Request, response and error reference
Legacy operation. Use the current scoped APIs for new integrations.
No request body fields are read by this operation.
HTTP 410 response (application/json)
{
"type": "object",
"properties": {
"code": {
"const": "PARTNER_FULFILLMENT_DISABLED"
},
"message": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"code",
"message"
]
}
Documented failures: 401, 403, 503.
/api/developer/partners/resellers/{relationshipId}/orders
Read the disabled developer-created external-order response
- Auth
- Account Bearer session token
- Scope
- partners.view + partners.manage and all-products workspace scope; owned relationship checks apply.
- Returns
- HTTP 410: code, message.
- Notes
- Returns 410 PARTNER_FULFILLMENT_DISABLED. The developer controller keeps this operation disabled even when the fulfillment capability is enabled; no submitted order or payable statement is created or updated. Authorized historical GET reads remain separate. Use the approved Partner API/portal for external fulfillment and the current statement-record/document tools for reseller reconciliation. A recorded external statement is not a SoundSync-funded payout.
Request, response and error reference
Legacy operation. Use the current scoped APIs for new integrations.
No request body fields are read by this operation.
HTTP 410 response (application/json)
{
"type": "object",
"properties": {
"code": {
"const": "PARTNER_FULFILLMENT_DISABLED"
},
"message": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"code",
"message"
]
}
Documented failures: 401, 403, 503.
/api/developer/partners/resellers/{relationshipId}/api-keys
Create a relationship API key when fulfillment is enabled
- Auth
- Account Bearer session token
- Scope
- partners.view + partners.manage and all-products workspace scope; owned relationship checks apply.
- Request fields
- name: string
- environment: live | test
- test_mode: boolean
- testMode: boolean
- scopes: array
- allowed_product_ids: array
- allowedProductIds: array
- Returns
- HTTP 201: api_key, token, reveal_once.
- Notes
- Requires the owner-controlled fulfillment capability. Disabled availability returns 410 PARTNER_FULFILLMENT_DISABLED before key creation/rotation. When enabled, creation defaults to test unless environment:live or test_mode/testMode:false is selected; explicit environment takes precedence. scopes and allowed_product_ids/allowedProductIds restrict the credential. Save the returned token privately: it is revealed once. Rotation replaces an active key and revokes the old key in the same transaction; coordinate installed integrations before rotating. This call does not enable the platform capability or process an external payment.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"environment": {
"enum": [
"live",
"test"
]
},
"test_mode": {
"type": "boolean"
},
"testMode": {
"type": "boolean"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"allowed_product_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"allowedProductIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"api_key": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"relationship_id": {
"type": [
"integer",
"string"
]
},
"key_prefix": {
"type": "string"
},
"status": {
"type": "string"
},
"environment": {
"enum": [
"live",
"test"
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"allowed_product_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"revoked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"token": {
"type": "string"
},
"reveal_once": {
"const": true
}
},
"additionalProperties": true,
"required": [
"api_key",
"token",
"reveal_once"
]
}
Documented failures: 400, 401, 403, 404, 409, 410, 500, 503.
Operation errors: PARTNER_FULFILLMENT_DISABLED.
/api/developer/partners/resellers/{relationshipId}/api-keys/{keyId}/rotate
Rotate a relationship API key when fulfillment is enabled
- Auth
- Account Bearer session token
- Scope
- partners.view + partners.manage and all-products workspace scope; owned relationship checks apply.
- Returns
- HTTP 200: api_key, token, reveal_once.
- Notes
- Requires the owner-controlled fulfillment capability. Disabled availability returns 410 PARTNER_FULFILLMENT_DISABLED before key creation/rotation. When enabled, creation defaults to test unless environment:live or test_mode/testMode:false is selected; explicit environment takes precedence. scopes and allowed_product_ids/allowedProductIds restrict the credential. Save the returned token privately: it is revealed once. Rotation replaces an active key and revokes the old key in the same transaction; coordinate installed integrations before rotating. This call does not enable the platform capability or process an external payment.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"api_key": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"relationship_id": {
"type": [
"integer",
"string"
]
},
"key_prefix": {
"type": "string"
},
"status": {
"type": "string"
},
"environment": {
"enum": [
"live",
"test"
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"allowed_product_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"revoked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"token": {
"type": "string"
},
"reveal_once": {
"const": true
}
},
"additionalProperties": true,
"required": [
"api_key",
"token",
"reveal_once"
]
}
Documented failures: 400, 401, 403, 404, 409, 410, 500, 503.
Operation errors: PARTNER_FULFILLMENT_DISABLED.
/api/developer/partners/resellers/{relationshipId}/api-keys/{keyId}/revoke
Revoke an existing relationship API key
- Auth
- Account Bearer session token
- Scope
- partners.view + partners.manage and all-products workspace scope; owned relationship checks apply.
- Returns
- HTTP 200: api_key.
- Notes
- Revokes an existing key in an owned relationship and returns api_key metadata, never its plaintext token. This safety action is not gated by fulfillment availability and remains available when new key creation is disabled. Unknown/foreign keys return 404 API_KEY_NOT_FOUND. Revocation affects future partner requests; it does not refund payments, delete customer ownership or execute recovery.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"api_key": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"relationship_id": {
"type": [
"integer",
"string"
]
},
"key_prefix": {
"type": "string"
},
"status": {
"type": "string"
},
"environment": {
"enum": [
"live",
"test"
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"allowed_product_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"revoked_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"required": [
"api_key"
]
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/partners/resellers/{relationshipId}/statements/generate
Read the disabled payable-statement generation response
- Auth
- Account Bearer session token
- Scope
- partners.view + partners.manage and all-products workspace scope; owned relationship checks apply.
- Returns
- HTTP 410: code, message.
- Notes
- Returns 410 PARTNER_FULFILLMENT_DISABLED. The developer controller keeps this operation disabled even when the fulfillment capability is enabled; no submitted order or payable statement is created or updated. Authorized historical GET reads remain separate. Use the approved Partner API/portal for external fulfillment and the current statement-record/document tools for reseller reconciliation. A recorded external statement is not a SoundSync-funded payout.
Request, response and error reference
Legacy operation. Use the current scoped APIs for new integrations.
No request body fields are read by this operation.
HTTP 410 response (application/json)
{
"type": "object",
"properties": {
"code": {
"const": "PARTNER_FULFILLMENT_DISABLED"
},
"message": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"code",
"message"
]
}
Documented failures: 401, 403, 503.
/api/developer/partners/resellers/{relationshipId}/statements/{statementId}
Read the disabled payable-statement update response
- Auth
- Account Bearer session token
- Scope
- partners.view + partners.manage and all-products workspace scope; owned relationship checks apply.
- Returns
- HTTP 410: code, message.
- Notes
- Returns 410 PARTNER_FULFILLMENT_DISABLED. The developer controller keeps this operation disabled even when the fulfillment capability is enabled; no submitted order or payable statement is created or updated. Authorized historical GET reads remain separate. Use the approved Partner API/portal for external fulfillment and the current statement-record/document tools for reseller reconciliation. A recorded external statement is not a SoundSync-funded payout.
Request, response and error reference
Legacy operation. Use the current scoped APIs for new integrations.
No request body fields are read by this operation.
HTTP 410 response (application/json)
{
"type": "object",
"properties": {
"code": {
"const": "PARTNER_FULFILLMENT_DISABLED"
},
"message": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"code",
"message"
]
}
Documented failures: 401, 403, 503.
SoundSync
Disabled operations and gated credentials are different
| Operation | Current contract |
|---|---|
| Developer-created external orders and payable-statement generation/edits | Always return 410 PARTNER_FULFILLMENT_DISABLED in these developer controllers. Enabling fulfillment does not turn them into supported order or payable-statement writes. |
| Relationship API-key creation and rotation | Require enabled fulfillment plus current permissions and relationship checks. Disabled availability returns 410; success returns the new token once. |
| Relationship API-key revocation | Available to authorized developers even when new fulfillment is disabled. Revoke an owned key without exposing its token or deleting historical orders. |
| Current external integrations and statement records | Use their own Partner API/portal or statement-record/document contracts. External reports do not establish funded SoundSync payouts. |
Keep replacement credentials private
Key creation defaults to test; use explicit environment:live only for an approved live integration. test_mode/testMode:false is a supported compatibility selector when environment is absent. scopes and allowed_product_ids/allowedProductIds constrain the key. Creation returns 201; rotation returns 200. Both return api_key, token and reveal_once:true when permitted.
Rotation replaces an active key and revokes the previous key transactionally. Revocation returns only api_key metadata. Neither operation charges a checkout, covers an external processor fee, pays an external statement or changes platform financial controls. Reconcile an uncertain mutation before retrying it through an alias.
