Skip to main content
DELETE
Cancel a payment subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer<uint64>
required

Subscription ID

network_id
required

The Network's unique integer ID, or subdomain Unique numeric network ID

Query Parameters

when
string

When to cancel: 'now' (immediate) or 'end_of_billing_cycle' (default: 'end_of_billing_cycle')

Response

Returns the canceled subscription details

A payment subscription for a plan

member
object
required

The subscriber

member_id
integer<uint64>
required
deprecated

Deprecated: Use member.id instead

created_at
string<date-time>
required
deprecated

Deprecated: Use member.created_at instead

Example:

"2026-11-11T22:25:36+00:00"

updated_at
string<date-time>
required
deprecated

Deprecated: Use member.updated_at instead

Example:

"2026-11-11T22:25:36+00:00"

email
string
required
deprecated

Deprecated: Use member.email instead

Deprecated: Use member.permalink instead

plan
object
required

The subscription plan

subscription
object
required

Detailed subscription information

first_name
string
deprecated

Deprecated: Use member.first_name instead

last_name
string
deprecated

Deprecated: Use member.last_name instead

time_zone
string
deprecated

Deprecated: Use member.time_zone instead

location
string
deprecated

Deprecated: Use member.location instead

referral_count
integer<uint64>
deprecated

Deprecated: Use member.referral_count instead

avatar
string
deprecated

Deprecated: Use member.avatar instead

categories
object[]
deprecated

Deprecated: Use member.categories instead

ambassador_level
string
deprecated

Deprecated: Use member.ambassador_level instead