API reference
Delivery and Downloads API
Endpoint reference for entitlement-gated file downloads, protected proxy downloads, wrapped external downloads, product download codes, and customer library calls.
SoundSync
Delivery, protected downloads, and customer library calls
Download APIs should be called only with the correct entitlement, token, code, or customer-library context.
/api/delivery/entitlements/:entitlementId/files/:fileIndex
Download an entitlement-authorized file.
- Auth
- Account Bearer session token
- Scope
- Current customer-account session and verified customer ownership. Store-scoped sessions remain confined to their storefront; a legacy serial/download token is not account sign-in.
- Request fields
- query token: string
- query download_token: string
- query libraryToken: string
- Returns
- Authorized redirect to short-lived signed R2 delivery, or authorization error.
- Notes
- fileIndex is zero-based. Token ownership, active entitlement, expansion rules and file existence are checked before redirect. Do not persist the storage URL as a permanent download. Requires a current customer-account session, either shared SoundSync sign-in or an authorized store-scoped customer session. A bare legacy serial/download proof returns 403 CUSTOMER_ACCOUNT_REQUIRED. The query names token, download_token and libraryToken are transport aliases where documented, not permission to substitute a different token type. Prefer Authorization: Bearer to keep credentials out of URLs. When account-token session verification is unavailable, fail closed with 503 SESSION_VERIFICATION_UNAVAILABLE. Retry after recovery; do not treat it as authorization or confirmed revocation. A verified revoked account session returns 401 LIBRARY_SESSION_REVOKED. SoundSync-wide customer suspension returns 403 CUSTOMER_ACCOUNT_RESTRICTED, including for an existing shared account session; store closure remains store-scoped. Shared library tokens follow their own token/ownership checks and do not replace required customer-account sign-in.
Request, response and error reference
Query and header parameters
[
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "download_token",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "libraryToken",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 302 response headers
{
"Location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "Short-lived authorized private download URL."
}
}
Documented failures: 400, 500, 401, 403, 503.
Operation errors: SESSION_VERIFICATION_UNAVAILABLE, LIBRARY_SESSION_REVOKED, CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED, CUSTOMER_ACCOUNT_REQUIRED.
/api/download/proxy
Authorize a legacy protected file download and redirect to signed R2 delivery.
- Auth
- Account Bearer session token + private token query parameter
- Scope
- Product or storefront scoped
- Request fields
- query token: string (required)
- query file: string (required)
- Returns
- Authorized redirect to short-lived signed R2 delivery.
- Notes
- Requires both the legacy token query parameter and the signed-in customer who owns its serial. file must identify an authorized managed product file. This call records download activity. Current SoundSync-wide suspension blocks new download authorization with 403 CUSTOMER_ACCOUNT_RESTRICTED. A store closure affects only that store. Already issued storage URLs expire independently.
Request, response and error reference
Query and header parameters
[
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"required": true,
"description": ""
},
{
"name": "file",
"in": "query",
"schema": {
"type": "string"
},
"required": true,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 302 response headers
{
"Location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "Short-lived authorized private download URL."
}
}
Documented failures: 400, 500, 503, 401, 403.
Operation errors: CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED, SESSION_VERIFICATION_UNAVAILABLE.
/api/download/wrapped
Authorize a legacy indexed file download and redirect managed files to signed R2 delivery.
- Auth
- Account Bearer session token + private token query parameter
- Scope
- Product or storefront scoped
- Request fields
- query token: string (required)
- query i: integer (required)
- Returns
- Authorized redirect to short-lived signed R2 delivery, or an import-required error for unmanaged external assets.
- Notes
- Requires legacy serial-token context and signed-in customer ownership. i is a zero-based file index. Unmanaged external files require import rather than an arbitrary proxy redirect. Current SoundSync-wide suspension blocks new download authorization with 403 CUSTOMER_ACCOUNT_RESTRICTED. A store closure affects only that store. Already issued storage URLs expire independently.
Request, response and error reference
Query and header parameters
[
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"required": true,
"description": ""
},
{
"name": "i",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0
},
"required": true,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 302 response headers
{
"Location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "Short-lived authorized private download URL."
}
}
Documented failures: 400, 500, 503, 401, 403.
Operation errors: CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED, SESSION_VERIFICATION_UNAVAILABLE.
/api/products/download/:code
Resolve product download links by download code.
- Auth
- Account Bearer session token
- Scope
- Product or storefront scoped
- Returns
- Authorized download links for the product/order context.
- Notes
- Legacy serial download listing requires the signed-in owning customer, a redeemed/unexpired serial and available download allowance; serial possession alone is insufficient. Current SoundSync-wide suspension blocks new download authorization with 403 CUSTOMER_ACCOUNT_RESTRICTED. A store closure affects only that store. Already issued storage URLs expire independently.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"file_urls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503, 401, 403.
Operation errors: CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED, SESSION_VERIFICATION_UNAVAILABLE.
/api/products/download/:code/:filename
Download one product file by code and filename.
- Auth
- Account Bearer session token
- Scope
- Product or storefront scoped
- Returns
- Protected file response.
- Notes
- Only authorized product filenames are eligible. Requires signed-in owning customer; records the download before redirect. Current SoundSync-wide suspension blocks new download authorization with 403 CUSTOMER_ACCOUNT_RESTRICTED. A store closure affects only that store. Already issued storage URLs expire independently.
Request, response and error reference
No request body fields are read by this operation.
HTTP 302 response headers
{
"Location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "Short-lived authorized private download URL."
}
}
Documented failures: 400, 500, 503, 401, 403.
Operation errors: CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED, SESSION_VERIFICATION_UNAVAILABLE.
/api/library/claim
Claim a library item into the signed-in account.
- Auth
- Account Bearer session token
- Scope
- Product or storefront scoped
- Request fields
- claim: string
- claim_token: string
- Returns
- Claim result and updated library state.
- Notes
- Requires an account JWT and a supported private claim token. claim is also accepted as a query alias. It does not create payment authority.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"claim": {
"type": "string"
},
"claim_token": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"claimed": {
"type": "boolean"
},
"redirect_to": {
"type": "string"
},
"customer_id": {
"type": "integer",
"minimum": 1
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
}
},
"additionalProperties": true
},
"order": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"external_order_id": {
"type": "string"
}
},
"additionalProperties": true
},
"license": {
"type": "object",
"properties": {
"serial": {
"type": [
"string",
"null"
]
},
"entitlement_id": {
"type": [
"integer",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/library
Load customer library.
- Auth
- Account Bearer session token
- Scope
- Current customer-account session and verified customer ownership. Store-scoped sessions remain confined to their storefront; a legacy serial/download token is not account sign-in.
- Request fields
- query token: string
- query download_token: string
- query libraryToken: string
- Returns
- Owned products, downloads, serial/license details, subscriptions, and support links.
- Notes
- Requires a current customer-account session, either shared SoundSync sign-in or an authorized store-scoped customer session. A bare legacy serial/download proof returns 403 CUSTOMER_ACCOUNT_REQUIRED. The query names token, download_token and libraryToken are transport aliases where documented, not permission to substitute a different token type. Prefer Authorization: Bearer to keep credentials out of URLs. When account-token session verification is unavailable, fail closed with 503 SESSION_VERIFICATION_UNAVAILABLE. Retry after recovery; do not treat it as authorization or confirmed revocation. A verified revoked account session returns 401 LIBRARY_SESSION_REVOKED. SoundSync-wide customer suspension returns 403 CUSTOMER_ACCOUNT_RESTRICTED, including for an existing shared account session; store closure remains store-scoped. Shared library tokens follow their own token/ownership checks and do not replace required customer-account sign-in.
Request, response and error reference
Query and header parameters
[
{
"name": "token",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "download_token",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "libraryToken",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"prefs": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"profile": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"download_token": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 401, 403, 503.
Operation errors: SESSION_VERIFICATION_UNAVAILABLE, LIBRARY_SESSION_REVOKED, CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED, CUSTOMER_ACCOUNT_REQUIRED.
/api/library/expansions
List expansion library entries.
- Auth
- Account Bearer session token
- Scope
- Current customer-account session and verified customer ownership. Store-scoped sessions remain confined to their storefront; a legacy serial/download token is not account sign-in.
- Request fields
- query token: string
- query storefront: string
- Returns
- Expansion library payload.
- Notes
- Requires a current customer-account session, either shared SoundSync sign-in or an authorized store-scoped customer session. A bare legacy serial/download proof returns 403 CUSTOMER_ACCOUNT_REQUIRED. The query names token, download_token and libraryToken are transport aliases where documented, not permission to substitute a different token type. Prefer Authorization: Bearer to keep credentials out of URLs. When account-token session verification is unavailable, fail closed with 503 SESSION_VERIFICATION_UNAVAILABLE. Retry after recovery; do not treat it as authorization or confirmed revocation. A verified revoked account session returns 401 LIBRARY_SESSION_REVOKED. SoundSync-wide customer suspension returns 403 CUSTOMER_ACCOUNT_RESTRICTED, including for an existing shared account session; store closure remains store-scoped. Shared library tokens follow their own token/ownership checks and do not replace required customer-account sign-in.
Request, response and error reference
Query and header parameters
[
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "storefront",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"ownedBaseProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"shortDescription": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"salePrice": {
"type": [
"number",
"null"
]
},
"regularPrice": {
"type": "number"
},
"displayPrice": {
"type": "number"
},
"priceDisplay": {
"type": "string"
},
"regularPriceDisplay": {
"type": "string"
},
"salePriceDisplay": {
"type": [
"string",
"null"
]
},
"isOnSale": {
"type": "boolean"
},
"currency": {
"type": "string"
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"coverImage": {
"type": [
"string",
"null"
]
},
"developerId": {
"type": "integer",
"minimum": 1
},
"developerName": {
"type": "string"
},
"developer": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"profileUrl": {
"type": [
"string",
"null"
]
},
"verified": {
"type": "boolean"
}
},
"additionalProperties": true
},
"productType": {
"type": "string"
},
"productTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"subscriptionEnabled": {
"type": "boolean"
},
"billingInterval": {
"type": [
"string",
"null"
]
},
"checkoutEligible": {
"type": "boolean"
},
"capabilities": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"requiresActivation": {
"type": "boolean"
},
"supportsSerials": {
"type": "boolean"
},
"supportsDownloads": {
"type": "boolean"
},
"marketplaceAsset": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"ownedExpansions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"shortDescription": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"salePrice": {
"type": [
"number",
"null"
]
},
"regularPrice": {
"type": "number"
},
"displayPrice": {
"type": "number"
},
"priceDisplay": {
"type": "string"
},
"regularPriceDisplay": {
"type": "string"
},
"salePriceDisplay": {
"type": [
"string",
"null"
]
},
"isOnSale": {
"type": "boolean"
},
"currency": {
"type": "string"
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"coverImage": {
"type": [
"string",
"null"
]
},
"developerId": {
"type": "integer",
"minimum": 1
},
"developerName": {
"type": "string"
},
"developer": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"profileUrl": {
"type": [
"string",
"null"
]
},
"verified": {
"type": "boolean"
}
},
"additionalProperties": true
},
"productType": {
"type": "string"
},
"productTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"subscriptionEnabled": {
"type": "boolean"
},
"billingInterval": {
"type": [
"string",
"null"
]
},
"checkoutEligible": {
"type": "boolean"
},
"capabilities": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"requiresActivation": {
"type": "boolean"
},
"supportsSerials": {
"type": "boolean"
},
"supportsDownloads": {
"type": "boolean"
},
"marketplaceAsset": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"availableExpansions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"shortDescription": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"salePrice": {
"type": [
"number",
"null"
]
},
"regularPrice": {
"type": "number"
},
"displayPrice": {
"type": "number"
},
"priceDisplay": {
"type": "string"
},
"regularPriceDisplay": {
"type": "string"
},
"salePriceDisplay": {
"type": [
"string",
"null"
]
},
"isOnSale": {
"type": "boolean"
},
"currency": {
"type": "string"
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"coverImage": {
"type": [
"string",
"null"
]
},
"developerId": {
"type": "integer",
"minimum": 1
},
"developerName": {
"type": "string"
},
"developer": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"profileUrl": {
"type": [
"string",
"null"
]
},
"verified": {
"type": "boolean"
}
},
"additionalProperties": true
},
"productType": {
"type": "string"
},
"productTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"subscriptionEnabled": {
"type": "boolean"
},
"billingInterval": {
"type": [
"string",
"null"
]
},
"checkoutEligible": {
"type": "boolean"
},
"capabilities": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"requiresActivation": {
"type": "boolean"
},
"supportsSerials": {
"type": "boolean"
},
"supportsDownloads": {
"type": "boolean"
},
"marketplaceAsset": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"lockedExpansions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"shortDescription": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"salePrice": {
"type": [
"number",
"null"
]
},
"regularPrice": {
"type": "number"
},
"displayPrice": {
"type": "number"
},
"priceDisplay": {
"type": "string"
},
"regularPriceDisplay": {
"type": "string"
},
"salePriceDisplay": {
"type": [
"string",
"null"
]
},
"isOnSale": {
"type": "boolean"
},
"currency": {
"type": "string"
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"coverImage": {
"type": [
"string",
"null"
]
},
"developerId": {
"type": "integer",
"minimum": 1
},
"developerName": {
"type": "string"
},
"developer": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"profileUrl": {
"type": [
"string",
"null"
]
},
"verified": {
"type": "boolean"
}
},
"additionalProperties": true
},
"productType": {
"type": "string"
},
"productTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"subscriptionEnabled": {
"type": "boolean"
},
"billingInterval": {
"type": [
"string",
"null"
]
},
"checkoutEligible": {
"type": "boolean"
},
"capabilities": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"requiresActivation": {
"type": "boolean"
},
"supportsSerials": {
"type": "boolean"
},
"supportsDownloads": {
"type": "boolean"
},
"marketplaceAsset": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"download_token": {
"type": "string"
},
"source": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 401, 403, 503.
Operation errors: SESSION_VERIFICATION_UNAVAILABLE, LIBRARY_SESSION_REVOKED, CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED, CUSTOMER_ACCOUNT_REQUIRED.
/api/library/products/:productId/expansions
List expansions for a product.
- Auth
- Account Bearer session token
- Scope
- Current customer-account session and verified customer ownership. Store-scoped sessions remain confined to their storefront; a legacy serial/download token is not account sign-in.
- Request fields
- query token: string
- query storefront: string
- Returns
- Product expansion payload.
- Notes
- Requires a current customer-account session, either shared SoundSync sign-in or an authorized store-scoped customer session. A bare legacy serial/download proof returns 403 CUSTOMER_ACCOUNT_REQUIRED. The query names token, download_token and libraryToken are transport aliases where documented, not permission to substitute a different token type. Prefer Authorization: Bearer to keep credentials out of URLs. When account-token session verification is unavailable, fail closed with 503 SESSION_VERIFICATION_UNAVAILABLE. Retry after recovery; do not treat it as authorization or confirmed revocation. A verified revoked account session returns 401 LIBRARY_SESSION_REVOKED. SoundSync-wide customer suspension returns 403 CUSTOMER_ACCOUNT_RESTRICTED, including for an existing shared account session; store closure remains store-scoped. Shared library tokens follow their own token/ownership checks and do not replace required customer-account sign-in.
Request, response and error reference
Query and header parameters
[
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "storefront",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"parent": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"shortDescription": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"salePrice": {
"type": [
"number",
"null"
]
},
"regularPrice": {
"type": "number"
},
"displayPrice": {
"type": "number"
},
"priceDisplay": {
"type": "string"
},
"regularPriceDisplay": {
"type": "string"
},
"salePriceDisplay": {
"type": [
"string",
"null"
]
},
"isOnSale": {
"type": "boolean"
},
"currency": {
"type": "string"
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"coverImage": {
"type": [
"string",
"null"
]
},
"developerId": {
"type": "integer",
"minimum": 1
},
"developerName": {
"type": "string"
},
"developer": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"profileUrl": {
"type": [
"string",
"null"
]
},
"verified": {
"type": "boolean"
}
},
"additionalProperties": true
},
"productType": {
"type": "string"
},
"productTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"subscriptionEnabled": {
"type": "boolean"
},
"billingInterval": {
"type": [
"string",
"null"
]
},
"checkoutEligible": {
"type": "boolean"
},
"capabilities": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"requiresActivation": {
"type": "boolean"
},
"supportsSerials": {
"type": "boolean"
},
"supportsDownloads": {
"type": "boolean"
},
"marketplaceAsset": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"expansions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"shortDescription": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"salePrice": {
"type": [
"number",
"null"
]
},
"regularPrice": {
"type": "number"
},
"displayPrice": {
"type": "number"
},
"priceDisplay": {
"type": "string"
},
"regularPriceDisplay": {
"type": "string"
},
"salePriceDisplay": {
"type": [
"string",
"null"
]
},
"isOnSale": {
"type": "boolean"
},
"currency": {
"type": "string"
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"coverImage": {
"type": [
"string",
"null"
]
},
"developerId": {
"type": "integer",
"minimum": 1
},
"developerName": {
"type": "string"
},
"developer": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"profileUrl": {
"type": [
"string",
"null"
]
},
"verified": {
"type": "boolean"
}
},
"additionalProperties": true
},
"productType": {
"type": "string"
},
"productTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"subscriptionEnabled": {
"type": "boolean"
},
"billingInterval": {
"type": [
"string",
"null"
]
},
"checkoutEligible": {
"type": "boolean"
},
"capabilities": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"requiresActivation": {
"type": "boolean"
},
"supportsSerials": {
"type": "boolean"
},
"supportsDownloads": {
"type": "boolean"
},
"marketplaceAsset": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"download_token": {
"type": "string"
},
"source": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 401, 403, 503.
Operation errors: SESSION_VERIFICATION_UNAVAILABLE, LIBRARY_SESSION_REVOKED, CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED, CUSTOMER_ACCOUNT_REQUIRED.
/api/library/products/:productId/reviews
List or submit product reviews from library context.
- Auth
- Public request; operation-specific verification still applies
- Scope
- Product or storefront scoped
- Request fields
- Review payload for POST.
- Returns
- Review list or created review state.
Request, response and error reference
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"reviews": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rating": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"status": {
"type": "string"
},
"imported": {
"type": "boolean"
},
"verified": {
"type": "boolean"
},
"verifiedPurchase": {
"type": "boolean"
},
"customerName": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"summary": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"averageRating": {
"type": "number",
"minimum": 0,
"maximum": 5
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
/api/library/products/:productId/reviews
List or submit product reviews from library context.
- Auth
- Account Bearer session token
- Scope
- Product or storefront scoped
- Request fields
- rating: integer (required)
- title: string
- body: string
- review: string
- feedback: string
- Returns
- Review list or created review state.
- Notes
- When account-token session verification is unavailable, fail closed with 503 SESSION_VERIFICATION_UNAVAILABLE. Retry after recovery; do not treat it as authorization or confirmed revocation. A verified revoked account session returns 401 LIBRARY_SESSION_REVOKED. SoundSync-wide customer suspension returns 403 CUSTOMER_ACCOUNT_RESTRICTED, including for an existing shared account session; store closure remains store-scoped. Shared library tokens follow their own token/ownership checks and do not replace required customer-account sign-in.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"rating": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"title": {
"type": "string",
"maxLength": 140
},
"body": {
"type": "string",
"minLength": 1,
"maxLength": 5000
},
"review": {
"type": "string"
},
"feedback": {
"type": "string"
}
},
"required": [
"rating"
],
"additionalProperties": true,
"anyOf": [
{
"required": [
"body"
]
},
{
"required": [
"review"
]
},
{
"required": [
"feedback"
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"review": {
"type": "object",
"properties": {
"rating": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"status": {
"type": "string"
},
"imported": {
"type": "boolean"
},
"verified": {
"type": "boolean"
},
"verifiedPurchase": {
"type": "boolean"
},
"customerName": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"moderation": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"awaitingApproval": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 503, 401, 403.
Operation errors: SESSION_VERIFICATION_UNAVAILABLE, LIBRARY_SESSION_REVOKED, CUSTOMER_ACCOUNT_RESTRICTED, CUSTOMER_STORE_CLOSED.
Current delivery versus legacy download helpers
Use the entitlement-delivery and customer-library flows for new integrations. Deprecated serial download counters and confirmation helpers now require a signed-in customer account, an owned active serial, and, for confirmation, a file belonging to its product. They record/check download activity; they do not authorize file access.
Keep customer-account tokens, library/download links, private serial download tokens, and public download codes distinct. Invoice access and review submission require the supported customer-account identity, not an arbitrary shared library link. Follow the authentication and product checks for the actual file request.
Account sessions must be verifiable
A signed account token is not enough on its own: customer account requests also check that the session is still allowed. If that check is unavailable, protected library, invoice, review, device-reset, download and customer-token activation requests stop before returning private data or performing the protected action.
503 SESSION_VERIFICATION_UNAVAILABLE means verification could not finish. Retry after service recovery; it does not mean that the purchase disappeared or the session was confirmed revoked. A confirmed revoked session returns 401 LIBRARY_SESSION_REVOKED and requires sign-in again. Do not grant access on either response.
Shared library/download tokens retain their separate token and ownership checks. Optional storefront personalization can fall back to anonymous browsing when customer identity cannot be established; that does not authorize a private download. This account-session check does not replace the signed JUCE offline-grant policy.
Handle invalid compatibility download proof
The compatibility proxy and wrapped downloads still require their documented account and serial/download proof. Invalid or expired proof returns 401 DOWNLOAD_PROOF_INVALID. The wrapped file index must be a single non-negative whole number; malformed, fractional, repeated or unsafe integer values return 400 rather than selecting a different file.
