Billing

Create a Stripe Connect onboarding link

Changed on

Returns a hosted Stripe onboarding URL for the Board's payment connection, creating the connected account first if the Board has none. The URL is single-use and expires within minutes: hand it to a human immediately, then poll GET /v1/billing/connect until acceptingPayments and payoutsEnabled are both true. Calling this again issues a fresh link, so request a new one if the human did not finish in time. When the human finishes or the link expires, Stripe sends them to the Board's payment settings in the dashboard. Sandbox boards use a platform-provisioned test connection and are refused with sandbox_connect_managed (409). Requires plans.manage.

post/billing/connect/onboarding-link

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/billing/connect/onboarding-link
  • Auth: HTTP bearer

Response

Onboarding link created.

object'billing_connect_onboarding_link' required
urlstring uri required

Single-use hosted Stripe onboarding URL. Hand it to a human straight away; it expires within minutes.

expiresAtstring date-time required

ISO 8601 time after which the URL no longer works.

Changes