Skip to content
SoundSyncAudio software platform

API reference

Developer Onboarding API

Resume account setup, save business and selling choices, inspect domain readiness and complete onboarding.

Account setup, not a product credential

Use the signed-in developer account Bearer token. Onboarding state is tied to that account rather than a request-supplied developer ID or product credential. The existing account, workspace and downstream operation checks remain in force; onboarding does not expand a teammate role.

Read featureEnabled, onboarding and entryRoute. Start reuses existing progress. The guided steps are launch_plan, business_brand, selling_experience, domain_email, payouts and ready_for_products. Complete a step only after its current requirements pass; changing selling models can require later reviews again.

Save first, then inspect requirements

Choose quick or fully_branded and one or more supported selling models. licensing_only cannot be combined with a sales channel. Business saves accept businessProfile/visualIdentity or supported flat fields. Read current state before replacing normalized settings, including defaulted account/country/currency values.

Support-address verification can send a real email and issues a private 24-hour token. An already-verified result avoids another send; inspect supportEmailVerification.deliveryStatus for skipped/failed transport. The browser verification action consumes the token and redirects; format=json or Accept:application/json returns the verification object instead. Never use token links as health probes.

Prepare a website without silently publishing it

Hosted ensure can create a draft storefront and the required page foundation. The route returns refreshed selling-experience state with templateOptions. Select a supported returned template key. Existing-site setup saves websiteUrl, storefront_package, standalone_pages or headless_api, selectedSurfaces and review acknowledgment. Custom API setup works with any platform language and uses separately verified External website callbacks. The Astro / Node starter is optional; saved setup is not proof of installation.

Some step reads initialize progress, prepare missing pages or refresh uninitialized domain checks. They are not guaranteed zero-write diagnostics. Domain review flags do not substitute for actual DNS, hosting, SSL, sender and tracking readiness. Use the Domain Setup API for those configuration operations.

Keep setup progress separate from financial approval

Payout decision connect or defer records an onboarding choice. Status refresh can contact the provider and persist readiness but does not send funds. Stripe Connect onboarding remains workspace-owner-only through the separate connect-session operation. Completing or deferring setup does not authorize live checkout, waive a hold or change financial flags.

Ready-for-products completion records the requested next action. Position only saves an accessible last-visited step; it does not skip requirements. Reset restarts progress and launch choices without deleting products, branding, domains, payout accounts or required financial history.

SoundSync

Illustrative setup read

Read the signed-in account setup state
curl --fail-with-body -sS "$SOUNDSYNC_API_BASE/api/developer/onboarding-v2" \
  -H "Authorization: Bearer $DEVELOPER_TOKEN"

SoundSync

Continue setup

Getting Started

The developer setup sequence.

Domain Setup API

Records, provider preparation and readiness.

Payout setup

Owner-only Connect onboarding and read-only reporting.

SoundSync

Requests and responses

GET /api/developer/onboarding-v2

Read current account onboarding progress

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Returns not_started without creating progress when no saved state exists. serviceAgreement is the effective agreement, while onboarding.serviceOption is a draft selection and onboarding.serviceOptions lists advertised choices. selected:false and active:false do not start service billing; a default Full Store identity is not owner acceptance. Monetary service fields are USD cents, saleFeeBps is basis points and storageBytes is bytes.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/start

Start or resume saved onboarding

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 201: featureEnabled, entryRoute, serviceAgreement, onboarding.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Ignores body fields; repeated calls reuse saved state.
Request, response and error reference

No request body fields are read by this operation.

HTTP 201 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/onboarding-v2/launch-plan

Save launch path and selling models

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • launchPath: quick | fully_branded |
  • serviceOption: full_store | licensing_hosting | licensing_only |
  • servicePricingAcknowledged: boolean
  • sellingModels: array
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Supported snake-case launch_path/selling_models aliases are accepted. Licensing and Licensing + Hosting normalize sellingModels to licensing_only; Full Store uses a supported commerce path. The service option is separate from a customer subscription or launch-path style. Changing the service choice resets pricing acknowledgment unless explicitly confirmed for the current policy. Saving a draft does not activate billing. An active option change requires support review; changing selling models can require selling/domain review again.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "launchPath": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "quick",
        "fully_branded",
        null
      ]
    },
    "serviceOption": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "full_store",
        "licensing_hosting",
        "licensing_only",
        null
      ]
    },
    "servicePricingAcknowledged": {
      "type": "boolean"
    },
    "sellingModels": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "hosted_storefront",
          "existing_website",
          "marketplace",
          "licensing_only"
        ]
      }
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: INVALID_DEVELOPER_SERVICE_OPTION, ACTIVE_SERVICE_OPTION_CHANGE_REQUIRES_REVIEW.

POST /api/developer/onboarding-v2/launch-plan/complete

Validate the saved launch plan and advance

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • launchPath: quick | fully_branded |
  • serviceOption: full_store | licensing_hosting | licensing_only |
  • servicePricingAcknowledged: boolean
  • sellingModels: array
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Choose serviceOption and explicitly confirm servicePricingAcknowledged=true. Full Store has a $20 monthly minimum on its 3% sales fees only. Email/redemption usage and actual provider fees are additional. Licensing + Hosting is $20/month and Licensing is $10/month. Completion records owner pricing acceptance; monthly billing starts with production activation. Non-checkout options use the licensing_only setup path. A path and at least one model must be saved. Completion can save the provided plan first.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "launchPath": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "quick",
        "fully_branded",
        null
      ]
    },
    "serviceOption": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "full_store",
        "licensing_hosting",
        "licensing_only",
        null
      ]
    },
    "servicePricingAcknowledged": {
      "type": "boolean"
    },
    "sellingModels": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "hosted_storefront",
          "existing_website",
          "marketplace",
          "licensing_only"
        ]
      }
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

Operation errors: SERVICE_PRICING_ACK_REQUIRED, SERVICE_OPTION_OWNER_REQUIRED, ACTIVE_SERVICE_OPTION_CHANGE_REQUIRES_REVIEW, INVALID_DEVELOPER_SERVICE_OPTION, LAUNCH_PATH_REQUIRED, SELLING_MODEL_REQUIRED.

GET /api/developer/onboarding-v2/business-brand

Read business, brand and support-email readiness

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/onboarding-v2/business-brand

Save business identity and visual defaults

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • publicName: string
  • accountType: individual | company
  • country: string
  • defaultCurrency: string
  • existingWebsite: string
  • supportEmail: string
  • tagline: string
  • shortDescription: string
  • logos: object
  • colors: object
  • businessProfile: object
  • visualIdentity: object
  • previewReviewed: boolean
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Accepts businessProfile/visualIdentity wrappers or supported flat fields and snake-case aliases. Read current values first: accountType, country and currency have normalization defaults. A saved currency preference does not enable non-USD checkout or payouts. This saves brand values; it does not issue an SSL certificate.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "publicName": {
      "type": "string"
    },
    "accountType": {
      "type": "string",
      "enum": [
        "individual",
        "company"
      ]
    },
    "country": {
      "type": "string"
    },
    "defaultCurrency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$"
    },
    "existingWebsite": {
      "type": "string"
    },
    "supportEmail": {
      "type": "string",
      "format": "email"
    },
    "tagline": {
      "type": "string"
    },
    "shortDescription": {
      "type": "string"
    },
    "logos": {
      "type": "object",
      "properties": {
        "logoUrl": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "colors": {
      "type": "object",
      "properties": {
        "primaryColor": {
          "type": "string"
        },
        "secondaryColor": {
          "type": "string"
        },
        "accentColor": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "businessProfile": {
      "type": "object",
      "properties": {
        "publicName": {
          "type": "string"
        },
        "accountType": {
          "type": "string",
          "enum": [
            "individual",
            "company"
          ]
        },
        "country": {
          "type": "string"
        },
        "defaultCurrency": {
          "type": "string",
          "pattern": "^[A-Za-z]{3}$"
        },
        "existingWebsite": {
          "type": "string"
        },
        "supportEmail": {
          "type": "string",
          "format": "email"
        },
        "tagline": {
          "type": "string"
        },
        "shortDescription": {
          "type": "string"
        },
        "logos": {
          "type": "object",
          "properties": {
            "logoUrl": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "colors": {
          "type": "object",
          "properties": {
            "primaryColor": {
              "type": "string"
            },
            "secondaryColor": {
              "type": "string"
            },
            "accentColor": {
              "type": "string"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "visualIdentity": {
      "type": "object",
      "properties": {
        "tagline": {
          "type": "string"
        },
        "shortDescription": {
          "type": "string"
        },
        "logos": {
          "type": "object",
          "properties": {
            "logoUrl": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "colors": {
          "type": "object",
          "properties": {
            "primaryColor": {
              "type": "string"
            },
            "secondaryColor": {
              "type": "string"
            },
            "accentColor": {
              "type": "string"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "previewReviewed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/business-brand/support-email/verification

Send support-address verification

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • email: string
  • supportEmail: string
Returns
HTTP 201: supportEmailVerification, alreadyVerified.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Falls back to the saved support email. Can send a real email; inspect deliveryStatus rather than assuming delivery from HTTP 201. The email token expires after 24 hours.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email"
    },
    "supportEmail": {
      "type": "string",
      "format": "email"
    }
  },
  "additionalProperties": true
}

HTTP 201 response (application/json)

{
  "type": "object",
  "properties": {
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "alreadyVerified": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/business-brand/complete

Validate brand requirements and advance

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • publicName: string
  • accountType: individual | company
  • country: string
  • defaultCurrency: string
  • existingWebsite: string
  • supportEmail: string
  • tagline: string
  • shortDescription: string
  • logos: object
  • colors: object
  • businessProfile: object
  • visualIdentity: object
  • previewReviewed: boolean
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "publicName": {
      "type": "string"
    },
    "accountType": {
      "type": "string",
      "enum": [
        "individual",
        "company"
      ]
    },
    "country": {
      "type": "string"
    },
    "defaultCurrency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$"
    },
    "existingWebsite": {
      "type": "string"
    },
    "supportEmail": {
      "type": "string",
      "format": "email"
    },
    "tagline": {
      "type": "string"
    },
    "shortDescription": {
      "type": "string"
    },
    "logos": {
      "type": "object",
      "properties": {
        "logoUrl": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "colors": {
      "type": "object",
      "properties": {
        "primaryColor": {
          "type": "string"
        },
        "secondaryColor": {
          "type": "string"
        },
        "accentColor": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "businessProfile": {
      "type": "object",
      "properties": {
        "publicName": {
          "type": "string"
        },
        "accountType": {
          "type": "string",
          "enum": [
            "individual",
            "company"
          ]
        },
        "country": {
          "type": "string"
        },
        "defaultCurrency": {
          "type": "string",
          "pattern": "^[A-Za-z]{3}$"
        },
        "existingWebsite": {
          "type": "string"
        },
        "supportEmail": {
          "type": "string",
          "format": "email"
        },
        "tagline": {
          "type": "string"
        },
        "shortDescription": {
          "type": "string"
        },
        "logos": {
          "type": "object",
          "properties": {
            "logoUrl": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "colors": {
          "type": "object",
          "properties": {
            "primaryColor": {
              "type": "string"
            },
            "secondaryColor": {
              "type": "string"
            },
            "accentColor": {
              "type": "string"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "visualIdentity": {
      "type": "object",
      "properties": {
        "tagline": {
          "type": "string"
        },
        "shortDescription": {
          "type": "string"
        },
        "logos": {
          "type": "object",
          "properties": {
            "logoUrl": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "colors": {
          "type": "object",
          "properties": {
            "primaryColor": {
              "type": "string"
            },
            "secondaryColor": {
              "type": "string"
            },
            "accentColor": {
              "type": "string"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "previewReviewed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

GET /api/developer/onboarding-v2/selling-experience

Read hosted, existing-site and customer-access setup

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/selling-experience/hosted-storefront/ensure

Prepare the hosted storefront and page foundation

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 201: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Creates missing storefront/pages but does not publish a live website. The route returns refreshed selling-experience state.
Request, response and error reference

No request body fields are read by this operation.

HTTP 201 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/onboarding-v2/selling-experience/hosted-storefront/template

Choose a supported saved starter template

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • template: string (required)
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Use a template key returned in templateOptions; templateKey/websiteTemplate/website_template are aliases. A storefront must already exist.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "template": {
      "type": "string"
    }
  },
  "required": [
    "template"
  ],
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/onboarding-v2/selling-experience/existing-website

Save the existing website integration plan

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • websiteUrl: string (required)
  • integrationApproach: storefront_package | standalone_pages | headless_api (required)
  • selectedSurfaces: array
  • reviewed: boolean
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. This replaces the normalized integration selection, not a sparse installation-status patch. Re-read dependencies. A reviewed plan does not prove the embed is installed.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "websiteUrl": {
      "type": "string"
    },
    "integrationApproach": {
      "type": "string",
      "enum": [
        "storefront_package",
        "standalone_pages",
        "headless_api"
      ]
    },
    "selectedSurfaces": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "catalog",
          "product_pages",
          "deals",
          "reviews",
          "customer_account_library",
          "cart_checkout",
          "homepage",
          "about",
          "support_faq"
        ]
      }
    },
    "reviewed": {
      "type": "boolean"
    }
  },
  "required": [
    "websiteUrl",
    "integrationApproach"
  ],
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/onboarding-v2/selling-experience

Save selling-experience review acknowledgments

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • hostedStorefrontReviewed: boolean
  • marketplaceAcknowledged: boolean
  • licensingOnlyAcknowledged: boolean
  • customerAccessReviewed: boolean
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "hostedStorefrontReviewed": {
      "type": "boolean"
    },
    "marketplaceAcknowledged": {
      "type": "boolean"
    },
    "licensingOnlyAcknowledged": {
      "type": "boolean"
    },
    "customerAccessReviewed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/selling-experience/complete

Validate selling experience and advance

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • hostedStorefrontReviewed: boolean
  • marketplaceAcknowledged: boolean
  • licensingOnlyAcknowledged: boolean
  • customerAccessReviewed: boolean
  • existingWebsiteIntegration: object
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "hostedStorefrontReviewed": {
      "type": "boolean"
    },
    "marketplaceAcknowledged": {
      "type": "boolean"
    },
    "licensingOnlyAcknowledged": {
      "type": "boolean"
    },
    "customerAccessReviewed": {
      "type": "boolean"
    },
    "existingWebsiteIntegration": {
      "type": "object",
      "properties": {
        "websiteUrl": {
          "type": "string"
        },
        "integrationApproach": {
          "type": "string",
          "enum": [
            "storefront_package",
            "standalone_pages",
            "headless_api"
          ]
        },
        "selectedSurfaces": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "catalog",
              "product_pages",
              "deals",
              "reviews",
              "customer_account_library",
              "cart_checkout",
              "homepage",
              "about",
              "support_faq"
            ]
          }
        },
        "reviewed": {
          "type": "boolean"
        }
      },
      "required": [
        "websiteUrl",
        "integrationApproach"
      ],
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

GET /api/developer/onboarding-v2/domain-email

Read domain, SSL and sender readiness

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Checks reflect the current saved setup; an uninitialized domain can be verified during the read. Use the Domain Setup API to configure records rather than treating review flags as DNS proof.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/onboarding-v2/domain-email

Save domain and email review acknowledgments

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • finalReviewAcknowledged: boolean
  • testEmailReviewed: boolean
  • managedEmailReviewed: boolean
  • optionalCustomSetupStarted: boolean
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "finalReviewAcknowledged": {
      "type": "boolean"
    },
    "testEmailReviewed": {
      "type": "boolean"
    },
    "managedEmailReviewed": {
      "type": "boolean"
    },
    "optionalCustomSetupStarted": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/domain-email/complete

Validate domain and communication requirements

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • finalReviewAcknowledged: boolean
  • testEmailReviewed: boolean
  • managedEmailReviewed: boolean
  • optionalCustomSetupStarted: boolean
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "finalReviewAcknowledged": {
      "type": "boolean"
    },
    "testEmailReviewed": {
      "type": "boolean"
    },
    "managedEmailReviewed": {
      "type": "boolean"
    },
    "optionalCustomSetupStarted": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

GET /api/developer/onboarding-v2/payouts

Read payout setup need, destination and requirements

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/onboarding-v2/payouts

Record a payout setup decision and review

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • decision: connect | defer |
  • reviewAcknowledged: boolean
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. connect/defer records an onboarding choice only. It does not start Stripe onboarding, make a transfer or change a financial flag.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "decision": {
      "type": "string",
      "enum": [
        "connect",
        "defer",
        ""
      ]
    },
    "reviewAcknowledged": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/payouts/status/refresh

Refresh the saved provider payout-account status

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. No saved connection returns payoutStatusRefreshed:false. A refresh can query the provider and update saved readiness. It is not a payment; owner-only Connect onboarding remains a separate API.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/payouts/complete

Validate or defer payout setup and advance

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • decision: connect | defer |
  • reviewAcknowledged: boolean
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "decision": {
      "type": "string",
      "enum": [
        "connect",
        "defer",
        ""
      ]
    },
    "reviewAcknowledged": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

GET /api/developer/onboarding-v2/ready-for-products

Read the completed business setup summary

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/ready-for-products/complete

Complete setup and record the next destination

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • destination: string
  • action: string
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding, branding, businessProfile, visualIdentity, supportEmailVerification, requirements, sellingExperience, domainEmail, payouts, readyForProducts, payoutStatusRefreshed.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "destination": {
      "type": "string"
    },
    "action": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "branding": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "businessProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "visualIdentity": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "supportEmailVerification": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "requirements": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "sellingExperience": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "domainEmail": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payouts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "readyForProducts": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
    },
    "payoutStatusRefreshed": {
      "type": "boolean"
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

PATCH /api/developer/onboarding-v2/position

Save the last visited accessible onboarding step

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • step: launch_plan | business_brand | selling_experience | domain_email | payouts | ready_for_products
  • stepKey: launch_plan | business_brand | selling_experience | domain_email | payouts | ready_for_products
  • currentStep: launch_plan | business_brand | selling_experience | domain_email | payouts | ready_for_products
  • current_step: launch_plan | business_brand | selling_experience | domain_email | payouts | ready_for_products
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Records the last visited accessible step. It cannot skip prerequisites or mark a step completed.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "step": {
      "type": "string",
      "enum": [
        "launch_plan",
        "business_brand",
        "selling_experience",
        "domain_email",
        "payouts",
        "ready_for_products"
      ]
    },
    "stepKey": {
      "type": "string",
      "enum": [
        "launch_plan",
        "business_brand",
        "selling_experience",
        "domain_email",
        "payouts",
        "ready_for_products"
      ]
    },
    "currentStep": {
      "type": "string",
      "enum": [
        "launch_plan",
        "business_brand",
        "selling_experience",
        "domain_email",
        "payouts",
        "ready_for_products"
      ]
    },
    "current_step": {
      "type": "string",
      "enum": [
        "launch_plan",
        "business_brand",
        "selling_experience",
        "domain_email",
        "payouts",
        "ready_for_products"
      ]
    }
  },
  "additionalProperties": true,
  "anyOf": [
    {
      "required": [
        "step"
      ]
    },
    {
      "required": [
        "stepKey"
      ]
    },
    {
      "required": [
        "currentStep"
      ]
    },
    {
      "required": [
        "current_step"
      ]
    }
  ]
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

POST /api/developer/onboarding-v2/reset

Restart onboarding progress without deleting business assets

Auth
Account Bearer session token
Scope
Signed-in developer account. Progress belongs to that account; this is not a product-credential API or a request-selected developer ID.
Request fields
  • reason: string
Returns
HTTP 200: featureEnabled, entryRoute, serviceAgreement, onboarding.
Notes
The saved step prerequisites and feature configuration apply. Read missing/requirements on failure and resume the indicated entryRoute. A saved review is not publication, domain verification, checkout approval or a payout. Step reads can initialize progress or prepare website page foundations; do not use them as zero-side-effect health probes. Resets the progress row, launch choices and step statuses. It does not delete existing products, branding, domains, payout accounts, customer records or financial history.
Request, response and error reference

Request (application/json)

{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "featureEnabled": {
      "type": "boolean"
    },
    "entryRoute": {
      "type": "string"
    },
    "serviceAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "full_store",
            "licensing_hosting",
            "licensing_only"
          ]
        },
        "name": {
          "type": "string"
        },
        "price": {
          "type": "string"
        },
        "priceDetail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "monthlyFeeCents": {
          "type": "integer",
          "minimum": 0
        },
        "monthlyMinimumCents": {
          "type": "integer",
          "minimum": 0
        },
        "saleFeeBps": {
          "type": "integer",
          "minimum": 0
        },
        "minimumBasis": {
          "type": "string",
          "enum": [
            "sales_fees",
            "soundsync_charges"
          ],
          "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
        },
        "hosting": {
          "type": "boolean"
        },
        "checkout": {
          "type": "boolean"
        },
        "storageBytes": {
          "type": "integer",
          "minimum": 0,
          "description": "Bytes, not GB. Current service allowances use decimal GB."
        },
        "storageLabel": {
          "type": "string"
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "active": {
          "type": "boolean"
        },
        "selected": {
          "type": "boolean"
        },
        "legacy": {
          "type": "boolean"
        },
        "agreementId": {
          "type": [
            "integer",
            "string",
            "null"
          ],
          "minimum": 1,
          "pattern": "^[1-9][0-9]*$",
          "description": "PostgreSQL bigserial may serialize as a decimal string. Preserve the identifier without numeric coercion; null means no agreement."
        },
        "policyVersion": {
          "type": "string"
        },
        "activatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveFrom": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "developerId": {
          "type": "integer",
          "minimum": 1
        },
        "onboardingVersion": {
          "type": "string"
        },
        "overallStatus": {
          "type": "string"
        },
        "currentStep": {
          "type": "string",
          "enum": [
            "launch_plan",
            "business_brand",
            "selling_experience",
            "domain_email",
            "payouts",
            "ready_for_products"
          ]
        },
        "launchPath": {
          "type": [
            "string",
            "null"
          ]
        },
        "sellingModels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "stepStatus": {
          "type": "object",
          "additionalProperties": true,
          "description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
        },
        "serviceOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "full_store",
                "licensing_hosting",
                "licensing_only"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "servicePricingAcknowledged": {
          "type": "boolean"
        },
        "servicePolicyVersion": {
          "type": "string"
        },
        "serviceOptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "full_store",
                  "licensing_hosting",
                  "licensing_only"
                ]
              },
              "name": {
                "type": "string"
              },
              "price": {
                "type": "string"
              },
              "priceDetail": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "monthlyFeeCents": {
                "type": "integer",
                "minimum": 0
              },
              "monthlyMinimumCents": {
                "type": "integer",
                "minimum": 0
              },
              "saleFeeBps": {
                "type": "integer",
                "minimum": 0
              },
              "minimumBasis": {
                "type": "string",
                "enum": [
                  "sales_fees",
                  "soundsync_charges"
                ],
                "description": "Use the effective agreement. Older agreements retain their prior minimum basis until the recorded transition."
              },
              "hosting": {
                "type": "boolean"
              },
              "checkout": {
                "type": "boolean"
              },
              "storageBytes": {
                "type": "integer",
                "minimum": 0,
                "description": "Bytes, not GB. Current service allowances use decimal GB."
              },
              "storageLabel": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "resetAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "lastVisitedStep": {
          "type": [
            "string",
            "null"
          ]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "route": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "isCurrent": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}

Documented failures: 400, 401, 403, 404, 409, 500, 503.

GET /api/developer/onboarding-v2/support-email/verify

Consume a private support-email verification token

Auth
Public request; operation-specific verification still applies
Scope
Private token identifies its developer support address.
Request fields
  • query token: string (required)
  • query format: value
Returns
HTTP 200: verified, supportEmailVerification.
Notes
Consumes verification state. Request format=json or Accept:application/json for JSON; ordinary browser success redirects with 303 to business-brand?supportEmailVerified=1. Do not poll or log the token URL. Invalid/expired links are errors, not account sign-in.
Request, response and error reference

Query and header parameters

[
  {
    "name": "token",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "required": true,
    "description": ""
  },
  {
    "name": "format",
    "in": "query",
    "schema": {
      "const": "json"
    },
    "required": false,
    "description": ""
  }
]

No request body fields are read by this operation.

HTTP 200 response (application/json)

{
  "type": "object",
  "properties": {
    "verified": {
      "type": "boolean"
    },
    "supportEmailVerification": {
      "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.

Distinguish the service agreement from setup choices

onboarding.serviceOptions lists Full Store, Licensing + Hosting and Licensing. onboarding.serviceOption is the saved setup choice; serviceAgreement describes the effective agreement and its selected/active state. A default Full Store name with selected:false is not an accepted or billable agreement. Completing the launch plan records acceptance; production activation is still separate.

monthlyFeeCents and monthlyMinimumCents are USD cents, saleFeeBps is basis points, and storageBytes is bytes. Licensing + Hosting is 2000 fixed cents with 100000000000 storage bytes and checkout:false; Licensing is 1000 fixed cents with hosting:false; Full Store has a 2000-cent sales-fee minimum and a 300-basis-point managed-sale fee. These are developer services, not the customer subscription models.

After changing the choice, confirm servicePricingAcknowledged for the current policy. An active agreement cannot be rewritten by changing an onboarding draft; contact support for a reviewed future-month change.

SoundSync

Save and confirm an external-checkout service

Illustrative setup calls; neither publishes a product nor activates production
curl --fail-with-body -sS -X PATCH "$SOUNDSYNC_API_BASE/api/developer/onboarding-v2/launch-plan" \
  -H "Authorization: Bearer $DEVELOPER_TOKEN" -H "Content-Type: application/json" \
  --data '{"serviceOption":"licensing_hosting","servicePricingAcknowledged":true,"launchPath":"quick","sellingModels":["licensing_only"]}'

curl --fail-with-body -sS -X POST "$SOUNDSYNC_API_BASE/api/developer/onboarding-v2/launch-plan/complete" \
  -H "Authorization: Bearer $DEVELOPER_TOKEN" -H "Content-Type: application/json" --data '{}'

Preserve the service agreement identifier

serviceAgreement.agreementId can be a positive integer, a decimal string from PostgreSQL bigserial, or null when no agreement exists. Keep a string identifier unchanged; converting a large identifier through a JavaScript number can lose precision. The identifier does not establish that serviceAgreement.active is true.