Skip to main content
POST
Typescript (SDK)
Read a tenant’s Stripe OAuth connection before showing a Connect Stripe or Disconnect Stripe action in your application. Authenticate with your master organization’s secret key, with platform:read scope. Pass the tenant’s public organization_slug and an explicit env: test or live. You can only inspect organizations created by your master organization. The env field alone selects the connection: a test-mode or live-mode master key can read either environment’s connection.

Interpreting the response

  • connected: true means the tenant has a stored Stripe OAuth account connection in this environment. account_id identifies that Stripe account.
  • connected_at is the authorization time as a Unix timestamp in milliseconds. It can be null for historical connections; null does not mean disconnected.
  • An unconnected tenant returns {"connected":false,"account_id":null,"connected_at":null}.
A default sandbox account, a separately configured Stripe secret key, or a direct account-ID connection through your own Stripe platform does not count as an Autumn OAuth connection. This endpoint is not a general check of whether the tenant can process payments.
After the tenant returns from the Stripe OAuth flow, fetch this status to update your UI. Revocations made in Stripe are reflected after Autumn processes Stripe’s deauthorization webhook. A slug that does not resolve to an organization created by your master organization returns 400 with Organization with slug '<slug>' not found. A missing API key returns 401, and a key without platform:read returns 403. To remove the OAuth connection, call Disconnect Stripe. Test and live connections are managed separately.

Body Parameters

Response

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string
default:2.4.0
required

Body

application/json
organization_slug
string
required

Public tenant organization slug, without the master organization suffix.

Minimum string length: 1
env
enum<string>
required

Stripe connection environment to inspect or disconnect.

Available options:
test,
live

Response

200 - application/json

OK

connected
boolean
required

Whether an OAuth connection is stored. Excludes platform-managed accounts, default sandbox accounts, and separate secret-key connections.

account_id
string | null
required

OAuth-connected Stripe account ID, or null when absent.

connected_at
number | null
required

Connection timestamp in Unix milliseconds, or null for historical connections without a timestamp and when disconnected.