> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/developers/references/apps-api/sections/payments-stripe#from-sandbox-to-live) 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.



## OpenAPI

````yaml /developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/sandbox/claim-url
openapi: 3.1.0
info:
  title: Base44 App Management API
  version: 1.0.0
servers:
  - url: https://app.base44.com
security:
  - PersonalAccessTokenAuth: []
paths:
  /api/apps/{app_id}/payments/stripe/sandbox/claim-url:
    get:
      summary: Get Stripe onboarding link
      description: >-
        <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](/developers/references/apps-api/sections/payments-stripe#from-sandbox-to-live)
        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.
      operationId: >-
        get_sandbox_claim_url_api_apps__app_id__payments_stripe_sandbox_claim_url_get
      parameters:
        - name: app_id
          in: path
          required: true
          schema:
            type: string
            description: ID of the Base44 app.
            title: App Id
          description: ID of the Base44 app.
          example: 6820f3a4e7b91d003c45a1f2
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimUrlResponse'
        '401':
          description: Missing or invalid credentials.
        '403':
          description: >-
            The credential is not permitted or you don't have the required app
            access. A missing app also fails the app access check. Setup and
            catalog operations also return `app_payment_management_not_allowed`
            when the app's workspace restricts payment management.
        '404':
          description: No Stripe sandbox exists or the app is outside the credential grant.
        '409':
          description: The workspace requires an unlocked SSO session.
      security:
        - PersonalAccessTokenAuth:
            - full_access
components:
  schemas:
    ClaimUrlResponse:
      properties:
        claim_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Claim Url
          description: >-
            Stripe onboarding link, or `null` when no link is available. Treat
            this link as a credential.
          example: https://dashboard.stripe.com/claim/example
        is_claimable:
          type: boolean
          title: Is Claimable
          description: >-
            Whether the returned link starts a claim. A link that resumes
            activation of an already claimed sandbox returns `false`.
          example: true
        no_link_reason:
          anyOf:
            - type: string
              enum:
                - already_active
                - sandbox_expired
                - unavailable
            - type: 'null'
          title: No Link Reason
          description: >-
            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: unavailable
      type: object
      required:
        - claim_url
        - is_claimable
      title: ClaimUrlResponse
      description: Claim URL response.
  securitySchemes:
    PersonalAccessTokenAuth:
      type: http
      scheme: bearer
      description: >-
        Personal access token, sent as `Authorization: Bearer <token>`. Each
        operation lists the permission it needs: `read_only` or `full_access`. A
        full-access token can call every operation. A read-only token can call
        only the operations that list `read_only`; anything else returns 403
        `read_only_credential_route_not_allowed`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.