API referencePlatformPlatform billing
Start (or resume) Connect Express onboarding; returns the hosted URL
Authorization
bearer_auth AuthorizationBearer <token>
In: header
Header Parameters
X-Project-Id*string
UUID of the project that scopes consumer accounts, devices, sessions, and VSpaces for the request.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Onboarding request — the console supplies the URLs to return to (its own origin), so the backend stays free of FE-origin coupling.
Response Body
application/json
curl -X POST "https://example.com/platform/v1/billing/payouts/account/onboard" \ -H "X-Project-Id: 11111111-1111-1111-1111-111111111111" \ -H "Content-Type: application/json" \ -d '{ "refresh_url": "string", "return_url": "string" }'{ "url": "string"}