getConnectStatus
Client function: live Stripe Connect account status for the builder (refreshes cached flags).
import { getConnectStatus } from 'flowstack-sdk'Non-React client function. Queries Stripe for the builder's Connect Express account state and refreshes the backend's cached flags. Use before showing payout UI: payouts_enabled gates requestBuilderPayout. GET /billing/connect/status.
Signature
getConnectStatus(credentials, config?): Promise<ApiResponse<ConnectStatus>>Parameters
| Param | Type | Notes | Description |
|---|---|---|---|
credentials | FlowstackCredentials | required | The builder's (app owner's) credentials. |
config | FlowstackClientConfig | since 0.2.9 | Client config (baseUrl, tenantId as needed). |
Returns
| Field | Type | Description |
|---|---|---|
| — | Promise<ApiResponse<ConnectStatus>> | ConnectStatus: { connected, stripe_account_id?, payouts_enabled, details_submitted? }. |
Examples
Gate payout UI
const res = await getConnectStatus(credentials);
const canPayout = res.ok && res.data.payouts_enabled;WarningBuilder/owner operation — call with the builder's credentials from a dashboard/console context, not from inside a generated app's end-user runtime.
builtAppSafe is false.See also
startConnectOnboarding · requestBuilderPayout · ConnectStatus
Source: src/api/client.ts (Builder Earnings, P0-152) · Also available in llms-full.txt and registry.json.