Guide
SoundSync API Reference
Licensing, customer access, commerce, partner programs, marketing, and developer operations organized by authentication and workflow.
Start with the identity and the operation
Plugin product credentials, native public-client identity, customer sessions, developer JWTs, and external partner keys authorize different operations. Select the reference for the task rather than substituting another token.
Endpoint references describe current routes and service behavior. Copyable examples identify their fixture or illustrative status; a documented route is not a universal live-provider or native-runtime guarantee.
SoundSync
Current contracts and operation coverage
SoundSync
Refunds, recipient programs, and automation
Developer refunds
Original-payment preview, whole-product selection, confirmation, and operation states.
Affiliate and collaborator programs
Agreements, live consent, attribution, balances, and destination setup.
Growth flows
Sequences, test sends, suppression, queue, and trigger activity.
Keep-your-products bundles
Paid invoice ownership and refund/dispute effects.
SoundSync
Reference pages
Start with authentication and licensing for native plugin integrations.
Authentication
Product plugin credential headers and compatibility aliases.
Plugin Connection Verification
POST /api/plugin-connections/verify.
Licensing
Claim, claim-status, activate, customer-login activate, validate, and deactivate.
Product Credentials
Credential concepts and status.
Errors
Stable codes and client behavior.
SoundSync
Fully documented plugin endpoints
These endpoints include method, auth, fields, responses, side effects, retry/grace guidance through related guides.
/api/plugin-connections/verify
Verify the standard product credential tuple or supported native public-client app/product identity before customer activation testing.
- Auth
- JSON body credential check. Headers are not used for this endpoint.
- Scope
- Product, app, credential, environment, and machine scoped.
- Request fields
- productId and appId
- pluginKey and pluginSecret for standard custom HTTP/HISEScript credential verification
- publicClient: hise-native or juce-native for the generated native public-client path
- pluginVersion, environment, and metadata optional
- Returns
- ok/connected, productId, credentialId, pluginVersion, environment, lastSeenAt.
- Side effects
- Updates credential last-used state, upserts plugin connection status, and records a plugin connection event.
- Notes
- This endpoint reads its JSON body rather than substituting licensing headers. The native public-client path does not require a distributed pluginSecret. Connectivity/product identification is not customer entitlement or audio unlock.
/api/license/v1/claim
Start a serial claim when customer identity or email verification is required.
- Auth
- Standard custom HTTP/HISEScript product credential path: x-ss-app-id, x-ss-plugin-key, and x-ss-plugin-secret. Generated native clients use their supported public-client identity and customer/machine proof path; see /docs/authentication.
- Scope
- Product, app, credential, environment, and machine scoped.
- Request fields
- license_key
- instance_id
- product_id optional when not inferred
- Returns
- pending_email_verification with claim_id/claimId and emailSent when verification is required.
- Side effects
- Creates or restores a pending serial claim and can send the verification email.
/api/license/v1/claim-status
Restore a pending serial claim and receive claim activation material after email verification.
- Auth
- Standard custom HTTP/HISEScript product credential path: x-ss-app-id, x-ss-plugin-key, and x-ss-plugin-secret. Generated native clients use their supported public-client identity and customer/machine proof path; see /docs/authentication.
- Scope
- Product, app, credential, environment, and machine scoped.
- Request fields
- license_key
- instance_id
- claim_id optional
- Returns
- pending_email_verification or verified with claim_activation_token/claimActivationToken.
- Side effects
- Does not activate the machine. The client must call /activate after verified status.
/api/license/v1/activate
Activate the current machine after direct serial/customer proof or a verified serial claim.
- Auth
- Standard custom HTTP/HISEScript product credential path: x-ss-app-id, x-ss-plugin-key, and x-ss-plugin-secret. Generated native clients use their supported public-client identity and customer/machine proof path; see /docs/authentication.
- Scope
- Product, app, credential, environment, and machine scoped.
- Request fields
- license_key or serial
- instance_id or machine_id
- claim_activation_token when using verified claim
- claim_id optional
- plugin_version optional
- Returns
- status activated, activationId, validation_token, entitlement_id, customer, max_activations, remaining, productId, grace_expires_at, offline_grace_days.
- Side effects
- Creates or reactivates a machine activation, ensures entitlement state, marks serial redeemed/billing eligible where applicable, records events, and issues a validation token.
/api/license/v1/customer-login/activate
Activate by customer account identity when the product supports account/login activation.
- Auth
- Standard custom HTTP/HISEScript product credential path: x-ss-app-id, x-ss-plugin-key, and x-ss-plugin-secret. Generated native clients use their supported public-client identity and customer/machine proof path; see /docs/authentication.
- Scope
- Product, app, credential, environment, and machine scoped.
- Request fields
- password or customer_token
- instance_id or machine_id
- product_id/app context when required
- plugin_version optional
- Returns
- activation result with validation token, entitlement/customer details, device limit and subscription state where applicable.
- Notes
- Never cache the customer password. Store only returned activation state and validation token.
/api/license/v1/validate
Validate cached activation state on startup or during periodic revalidation.
- Auth
- Standard custom HTTP/HISEScript product credential path: x-ss-app-id, x-ss-plugin-key, and x-ss-plugin-secret. Generated native clients use their supported public-client identity and customer/machine proof path; see /docs/authentication.
- Scope
- Product, app, credential, environment, and machine scoped.
- Request fields
- instance_id or machine_id
- validation_token/token or activationId/licenseReference/license key context
- product_id optional
- Returns
- active/denied state, rotated validation token, last validation timestamps, offline grace fields, subscription/license state.
- Side effects
- Refreshes validation state and token when allowed. Explicit denials force lock and must not use offline grace.
/api/license/v1/deactivate
Deactivate this machine and release local access.
- Auth
- Standard custom HTTP/HISEScript product credential path: x-ss-app-id, x-ss-plugin-key, and x-ss-plugin-secret. Generated native clients use their supported public-client identity and customer/machine proof path; see /docs/authentication.
- Scope
- Product, app, credential, environment, and machine scoped.
- Request fields
- license_key or customer/email entitlement context
- instance_id or machine_id
- Returns
- status deactivated, code DEVICE_DEACTIVATED, remaining_activations.
- Side effects
- Sets deactivated_at on the activation, records an event, and should cause the client to delete local activation state.
SoundSync
All API families
Plugin Licensing API
Verified plugin connection, serial claim, activation, validation, customer-login activation, and deactivation endpoints.
Product Credentials API
Developer-authenticated product credential creation, ensure, reveal, rotation, and revocation endpoints.
Entitlements and Delivery API
Customer entitlement delivery and library-token authorization.
Customer Library API
Customer-token library listing, webview-library, claim, and expansion/review boundaries.
Subscriptions API
Beta product subscription settings and subscription state behavior.
Storefront and Embed API
Hosted storefront and embedded storefront bootstrap/frame-token/cart handoff.
Partner API
Controlled partner products, orders, licenses, campaigns, and webhooks.
Webhooks API
Partner webhook subscriptions, delivery events, and signatures.
Checkout API
Product checkout, quote, tax jurisdiction, and embed handoff.
Orders API
Developer-visible order reporting and partner refund routes.
Promotions API
Promo codes, scheduled deals, and promotion offers.
Marketplace API
Public marketplace search and developer list/unlist.
Analytics API
Developer analytics, revenue, activity, and exports.
Billing API
Developer billing, statements, invoices, settlements, and payouts.
Email Marketing API
Contacts, campaigns, automation, and usage.
Brand, Domains, and Reviews API
Brand Manager, custom domains, DNS workflow, and review moderation.
Team Accounts API
Developer workspace membership, invitations, roles, product scope, session access, and audit records. Source-reviewed contracts; see the endpoint evidence.
Subscription Bundles API
Bundle checkout, customer plan preview/confirmation, scheduled changes, billing setup, and developer definitions/reporting. Lifecycle evidence is operation-specific.
Developer Refund API
Preview and confirm full-order or whole-product refunds with original payment, tax, share, and access checks.
Affiliate and Collaborator API
Agreement management, invitation acceptance, live consent, referral links, accounting, and recipient payout setup.
Growth Flow and Automation API
Flow lifecycle, sequence previews, developer-only tests, queue activity, suppression rules, and trigger signals.
API reference
Endpoint groups are organized by authentication model, product scope, request shape, response shape, errors, idempotency, and integration surface.
Plugin Licensing API
/docs/api/licensing
Verified plugin connection, serial claim, activation, validation, customer-login activation, and deactivation endpoints.
Product Credentials API
/docs/api/product-credentials
Developer-authenticated product credential creation, ensure, reveal, rotation, and revocation endpoints.
Entitlements and Delivery API
/docs/api/entitlements
Customer entitlement delivery and library-token authorization.
Customer Library API
/docs/api/customer-library
Customer-token library listing, webview-library, claim, and expansion/review boundaries.
Subscriptions API
/docs/api/subscriptions
Beta product subscription settings and subscription state behavior.
Storefront and Embed API
/docs/api/storefront-embed
Hosted storefront and embedded storefront bootstrap/frame-token/cart handoff.
Partner API
/docs/api/reseller-partner
Controlled partner products, orders, licenses, campaigns, and webhooks.
Webhooks API
/docs/api/webhooks
Partner webhook subscriptions, delivery events, and signatures.
Checkout API
/docs/api/checkout
Product checkout, quote, tax jurisdiction, and embed handoff.
Orders API
/docs/api/orders
Developer-visible order reporting and partner refund routes.
Promotions API
/docs/api/promotions
Promo codes, scheduled deals, and promotion offers.
Marketplace API
/docs/api/marketplace
Public marketplace search and developer list/unlist.
Analytics API
/docs/api/analytics
Developer analytics, revenue, activity, and exports.
Billing API
/docs/api/billing
Developer billing, statements, invoices, settlements, and payouts.
Email Marketing API
/docs/api/email-marketing
Contacts, campaigns, automation, and usage.
Brand, Domains, and Reviews API
/docs/api/brand-domains-reviews
Brand Manager, custom domains, DNS workflow, and review moderation.
Team Accounts API
/docs/api/team-accounts
Developer workspace membership, invitations, roles, product scope, session access, and audit records. Source-reviewed contracts; see the endpoint evidence.
Subscription Bundles API
/docs/api/subscription-bundles
Bundle checkout, customer plan preview/confirmation, scheduled changes, billing setup, and developer definitions/reporting. Lifecycle evidence is operation-specific.
Developer Refund API
/docs/api/refunds
Preview and confirm full-order or whole-product refunds with original payment, tax, share, and access checks.
Affiliate and Collaborator API
/docs/api/partner-programs
Agreement management, invitation acceptance, live consent, referral links, accounting, and recipient payout setup.
Growth Flow and Automation API
/docs/api/growth-flows
Flow lifecycle, sequence previews, developer-only tests, queue activity, suppression rules, and trigger signals.