Skip to main content
POST
Cancel a billing agreement

Authorizations

Authorization
string
header
required

API key prefixed with 'Bearer sx_live_...'

Path Parameters

id
string
required

Body

application/json
at_period_end
boolean
default:false

Only applies to interval-trigger agreements.

Response

Cancelled

agreement
object

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