Guide

Affiliate and Collaborator API

Agreement management, invitation acceptance, live consent, referral links, accounting, and recipient payout setup.

Start with getting started Explore API docs

SoundSync

Program operations

Current route and service contracts. Examples below are illustrative; live provider outcomes and client-host testing are separate checks.

GET /api/developer/partners/programs

List developer agreements and proposals.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Returns: Workspace program records.
Side effects: Read-only unless the operation explicitly records referral activity.

POST /api/developer/partners/programs

Create an affiliate or collaborator proposal and invitation.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: kind: affiliate or collaborator
recipient_email
name
rate_bps and product_rates[{product_id,rate_bps}]
attribution_window_days: 1-365
include_reseller_sales boolean
Optional effective_from and send_email
Returns: 201 agreement and invitation result.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Rates are integer basis points from 0 to 10000. Effective terms cannot be backdated. Products must belong to the workspace and pass eligibility/capacity checks.

PATCH /api/developer/partners/programs/:id

Propose revised versioned terms.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: id
Changed proposal fields
Returns: Revised proposal; accepted prior terms are retained.
Side effects: Performs the described operation; review confirmation and retry requirements.

POST /api/developer/partners/programs/:id/status

Pause, resume, or end an accepted agreement.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: id
status: active, paused, or ended
Returns: Updated agreement status.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: An ended agreement cannot be resumed; acceptance is required before activation.

POST /api/developer/partners/programs/:id/invite

Replace or resend a pending invitation.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: id
Optional send_email
Returns: Invitation and delivery result.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Invitation limits and resend cooldown apply; replacement revokes older pending links.

POST /api/developer/partners/programs/preview

Calculate a nonpayable split preview.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: product_id
subtotal_cents, discount_cents, platform_fee_cents, processing_fee_cents
Optional affiliate_agreement_id, currency, collection_provider, cumulative_refund_product_cents
Returns: mode:preview; payable:false; projected allocation and payout plan.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: This calculator is not the captured-sale ledger. Use zero processing_fee_cents for the current managed-checkout policy; historical projections can have a different supplied basis.

GET /api/developer/partners/programs/accounting

Read allocations, reversals, destinations, transfers, and funded versus external balances.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Returns: Accounting summary including balance_details and unfunded_earnings.
Side effects: Read-only unless the operation explicitly records referral activity.

POST /api/developer/partners/programs/:id/live-consent

Developer owner explicitly authorizes the current live terms.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: id
accept:true
terms_version
policy_version: soundsync-managed-live-v1
Returns: Accepted party, version, and policy.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Owner authorization cannot be inherited from a teammate; both parties must consent.

GET /api/partner-portal/programs

List agreements for the signed-in recipient.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Returns: Recipient-scoped agreements.
Side effects: Read-only unless the operation explicitly records referral activity.

GET /api/partner-portal/programs/invitations/:token

Read a private invitation for its intended recipient.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: token path
Returns: Invitation and displayed terms.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Never expose invitation tokens in public URLs or screenshots.

POST /api/partner-portal/programs/invitations/accept

Accept the displayed invitation terms.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: token
accept_preview_terms:true
preview_terms_version from the invitation
payout_policy_version from the invitation
Returns: Accepted version.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: These field names describe invitation acceptance, not live payment consent. The verified invited identity is required.

POST /api/partner-portal/programs/:id/live-consent

Recipient authorizes the applicable live terms.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: id
accept:true
terms_version
policy_version: soundsync-managed-live-v1
Returns: Accepted recipient consent.
Side effects: Performs the described operation; review confirmation and retry requirements.

GET /api/partner-portal/programs/accounting

Read the recipient's own balances and transfer history.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Returns: Accounting summary; external amounts remain separately unfunded.
Side effects: Read-only unless the operation explicitly records referral activity.

POST /api/partner-portal/programs/payouts/stripe

Start or inspect recipient Stripe Connect onboarding.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: livemode boolean
Optional program: affiliate or collaborator
Returns: ready:true or an onboarding url.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: Onboarding is not a payout request. Use the returned URL privately.

POST /api/partner-portal/programs/payouts/stripe/refresh

Refresh the recipient Stripe destination readiness.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: livemode boolean
Returns: Current Stripe destination readiness.
Side effects: Performs the described operation; review confirmation and retry requirements.

POST /api/partner-portal/programs/payouts/paypal

Confirm the verified recipient email as the PayPal destination.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: livemode boolean
confirm_verified_email:true
Returns: Destination readiness and availability time.
Side effects: Performs the described operation; review confirmation and retry requirements.
Notes: A destination change can impose a security hold; no arbitrary third-party email is accepted.

GET /api/partner-referrals/:code

Resolve an eligible referral to its storefront/product.

Auth: Developer JWT for developer routes; signed-in intended recipient for partner-portal routes; referral resolution is public.
Scope: Authenticated account, workspace, relationship, and product ownership checks apply.
Request fields: code path
Optional product query
Returns: 303 redirect with supported referral context.
Side effects: Read-only unless the operation explicitly records referral activity.
Notes: Public, rate-limited; records visit activity except HEAD. A click is not proof of a sale.

Permissions and live availability

Developer program access requires partners.view and all-products workspace scope; mutations also require partners.manage. Live consent separately checks developer-owner or recipient identity, verified email, active account, current accepted terms, and rollout enablement. A live endpoint existing does not authorize an arbitrary caller or enable every account.

Keep product credentials, partner external API keys, developer JWTs, recipient sessions, and private invitation tokens separate. An affiliate agreement grants neither team membership nor reseller authority.

Funding and recovery

Current managed checkout allocates the post-10% proceeds without a second deduction for ordinary processing. External collections are unfunded estimates and their fees remain the external seller's responsibility. Refunds reverse original saved shares; outstanding recovery reduces future eligible earnings. A reserved, submitted, or reconciliation-required transfer is not confirmed arrival.