Skip to main content
POST
Enroll in membership auto-renew

Authorizations

Authorization
string
header
required

API key prefixed with 'Bearer sx_live_...'

Body

application/json
mode
enum<string>

Omit for the custodial/soft path.

Available options:
wallet
tier
enum<string>
Available options:
starter,
growth
interval
enum<string>
Available options:
month,
year
periods
integer

Custodial path only - number of periods to prefund.

approve_tx
string

Wallet path - the on-chain approve tx you just signed (used only to disambiguate a still-confirming allowance).

Response

Already enrolled

success
boolean
enrolled
boolean
soft
boolean
mode
enum<string>
Available options:
wallet,
funded
already_enrolled
boolean
agreement
object | null

An AP2 open-mandate-backed recurring billing agreement. The open_mandate SD-JWT is never returned over the API.

card_id
string
reserve
number
periods_funded
integer
price
number
next_charge_at
string<date-time> | null
allowance
number