Skip to main content
POST
Cancel an owned subscription

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public UUID of an owned subscription.

Body

application/json

The optional cancellation reason; omit the body or send an empty object to record unknown.

Optionally say why the member is cancelling. Omit the body or send an empty object to record unknown.

reason_code
enum<string> | null

A customer reason code. Omitted or null records unknown. Any other value returns 422.

Available options:
too_expensive,
too_much_product,
too_frequent,
not_seeing_results,
did_not_like_product,
switching_brand,
shipping_or_delivery_issue,
taking_a_break,
moving_or_life_change,
other,
null
Example:

"other"

reason_text
string | null

Free text, allowed only with reason_code other.

Maximum string length: 500
Example:

"Moving abroad"

Response

Fresh subscription detail after the transition.

One accessible subscription.

status
integer
required

HTTP response status.

data
object
required

A subscription with its billed items, shipping, payment method, discounts and bundle.

meta
object
required

Envelope metadata present on every response.