Sign in

Get Stripe integration status

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

Reports how far Stripe setup has gone for the app, without returning any credentials.

It covers the sandbox's status and claim state, and whether test or live credentials are stored.

If Stripe was never set up, every field but app_id comes back false or null.

Requires read access to the app.

get/api/apps/{app_id}/payments/stripe/status

Path parameters

app_idstring required

ID of the Base44 app.

ID of the Base44 app.

Query parameters

check_transactionsboolean

Whether to look for any checkout session in sandbox mode. Defaults to false.

Whether to look for any checkout session in sandbox mode. Defaults to false.

Response

Successful Response

app_idstring required

ID of the Base44 app.

stripe_modestring nullable

Mode inferred from available credentials and sandbox state. Either sandbox or live, or null when neither is available. Defaults to null.

sandbox_statusstring nullable

Stored sandbox status. Either unclaimed, claimed, or expired, or null without a sandbox. Defaults to null.

sandbox_is_claimableboolean

Whether the sandbox is unclaimed, has not expired, and has a stored claim link. Defaults to false.

sandbox_claim_urlstring nullable

Stored claim link, or null when the sandbox is not claimable or you are a workspace viewer. Treat this link as a credential. Defaults to null.

sandbox_days_until_expiryinteger nullable

Whole days until sandbox expiration, or null for a claimed sandbox or when no expiration is stored. Defaults to null.

sandbox_account_idstring nullable

Stripe sandbox account ID, or null without a sandbox. Defaults to null.

test_mode_configuredboolean

Whether test credentials are available. Defaults to false.

live_mode_configuredboolean

Whether live credentials or a connected live account are available. This alone does not mean the app has switched to live keys. Defaults to false.

live_mode_methodstring nullable

Available live authentication method. Either direct_keys or platform_auth, or null when neither is available. Direct keys take precedence. Defaults to null.

live_keys_configuredboolean

Whether live key setup finished completely, including the redeploy that picks up the new keys. A partial failure leaves this false even after keys are stored. Defaults to false.

live_account_idstring nullable

Connected live Stripe account ID, or null before activation. Defaults to null.

has_tested_paymentboolean nullable

Whether Stripe reports any checkout session when requested in sandbox mode. A failed lookup also reports false, and a session does not prove payment. Otherwise null. Defaults to null.

Example response

{
  "app_id": "6820f3a4e7b91d003c45a1f2",
  "stripe_mode": "sandbox",
  "sandbox_status": "unclaimed",
  "sandbox_is_claimable": true,
  "sandbox_claim_url": "https://dashboard.stripe.com/claim/example",
  "sandbox_days_until_expiry": 30,
  "sandbox_account_id": "acct_T7mK2p9Q4r6S8v",
  "test_mode_configured": true,
  "live_mode_method": "direct_keys",
  "live_account_id": "acct_L8nP3q5R7s9T2v"
}

Changes

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