Cancel a subscription
POST /v1/subscriptions/{subscriptionId}/cancel
POST
/v1/subscriptions/{subscriptionId}/cancel
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” subscriptionId
required
string
Request Body
Section titled “Request Body ”object
atPeriodEnd
If true, the subscription stays active until the current period ends, then cancels.
boolean
Responses
Section titled “ Responses ”A subscription object.
object
id
string
sub_01ARZ3NDEKTSV4RRFFQ69G5FAZ customerId
string
priceId
string
status
string
currentPeriodStart
string format: date-time
currentPeriodEnd
string format: date-time
cancelAtPeriodEnd
boolean
metadata
Up to 50 key/value string pairs you can attach to an object. Trile ignores them; they’re returned on every read.
object
key
additional properties
string
{ "internal_user_id": "42"}Error.
object
success
boolean
error
object
code
string
insufficient_funds message
string
Wallet balance is below the first cycle amount. meta
object
requestId
string
req_aBcDeFgHiJkL