Skip to main content
GET /api/v2/storefront/billing/onboard Returns a fresh Stripe-hosted onboarding URL for your already-provisioned Connect account. Onboarding links expire after 24 hours, so use this when an operator dropped out mid-onboarding or the original link from Provision Stripe Connect has expired. For in-app onboarding instead of a redirect, use an embedded account session.

​
Request

curl "https://api.interchange.io/api/v2/storefront/billing/onboard" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldTypeRequiredNotes
targetCustomerIdnumberNoQuery param. Parent customers fetch a link for a child account

​
Response

{
  "onboardingUrl": "https://connect.stripe.com/setup/e/acct_1Abc2DefGhiJklMn/xyz789"
}
Redirect the operator to onboardingUrl. The link expires 24 hours after it is issued.

​
Errors

  • 400 VALIDATION_ERROR — no Stripe account provisioned yet, or Stripe is not configured on the server.
See Errors for the full error contract.

Billing tasks

All billing operations

Provision Stripe Connect

Create the Express account first

Create account session

Embedded onboarding UI instead of a redirect

Billing overview

Stripe Connect concepts