Skip to main content
GET
Read auto-recharge and the current payment handoff

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Actual recharge settings; disabled by default.

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
enabled
boolean
required
revision
integer
required
Required range: x >= 0
status
enum<string>
required
Available options:
off,
setup_required,
on,
payment_required,
monthly_limit,
needs_reconciliation
monthly_limit_minor
integer
required
Required range: 1000 <= x <= 100000
spent_minor
integer
required
Required range: x >= 0
currency
string
required
Allowed value: "usd"
amount_minor
integer
required
credits
integer
required
threshold_credits
integer
required
setup_url
string<uri> | null
required
Maximum string length: 8192
invoice_url
string<uri> | null
required
Maximum string length: 8192