Sign in

Get Stripe onboarding link

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns a link to claim a sandbox or resume an unfinished activation.

This call checks Stripe for the sandbox's current state and updates the stored record if it's out of date. It also renews the link itself if the stored one expired.

Requires write access to the app. Workspace viewers cannot call this operation.

get/api/apps/{app_id}/payments/stripe/sandbox/claim-url

Path parameters

app_idstring required

ID of the Base44 app.

ID of the Base44 app.

Response

Successful Response

claim_urlstring nullable required

Stripe onboarding link, or null when no link is available. Treat this link as a credential.

is_claimableboolean required

Whether the returned link starts a claim. A link that resumes activation of an already claimed sandbox returns false.

no_link_reason'already_active' | 'sandbox_expired' | 'unavailable' nullable

Reason no link is returned. already_active means the account already finished activation, so there's nothing left to claim. sandbox_expired means an unclaimed sandbox passed its 60-day window. unavailable covers every other case, including no sandbox at all. Otherwise null, when a link is returned. Defaults to null.

Example response

{
  "claim_url": "https://dashboard.stripe.com/claim/example",
  "is_claimable": true,
  "no_link_reason": "unavailable"
}

Changes

Changed in 1 of the 14 revisions of this API.1