Skip to main content
POST
Create a recurring billing agreement from an AP2 open mandate

Authorizations

Authorization
string
header
required

API key prefixed with 'Bearer sx_live_...'

Body

application/json
open_mandate
string
required

AP2 open mandate SD-JWT with a payment.recurring constraint.

plan_ref
string
Example:

"membership:starter:month"

amount
number

Must not exceed the mandate's per-period cap.

description
string
trigger
object
defer_first_charge
boolean
default:false

Response

Agreement created

agreement
object

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

first_charge
object | null