Skip to main content
POST
Cancel a subscription

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01
Idempotency-Key
string

A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.

Maximum string length: 255
Example:

"ik_a1b2c3d4e5f6"

Path Parameters

id
string
required

Unique identifier for the subscription

Body

application/json
reason
enum<string>
required

Cancellation reason

Available options:
no_longer_required,
moving_provider,
pricing,
support,
features,
upgraded,
other
Example:

"no_longer_required"

effective
string | null

When cancellation takes effect

Example:

"end_of_term"

reason_description
string | null

Additional context for the cancellation

Example:

"Customer is consolidating vendors"

Response

Success

billing
object
required

Billing configuration

contract
object
required

Contract configuration

created_at
string<date-time>
required

When the subscription was created

Example:

"2025-12-15T10:30:00Z"

currency
string
required

ISO 4217 currency code

Example:

"USD"

customer_id
string
required

Customer ID

Example:

"cust_abc123"

id
string
required

Unique identifier

Example:

"sub_abc123"

metadata
object
required

Key-value metadata

name
string
required

Subscription name

Example:

"Acme Corp - Enterprise"

pending_changes
object[]
required

Pending version changes

renewal
object
required

Renewal configuration

status
string
required

Subscription status

Example:

"active"

updated_at
string<date-time>
required

When the subscription was last updated

Example:

"2026-04-04T10:00:05Z"

activated_at
string<date-time> | null

When the subscription was activated

Example:

"2026-01-01T00:00:00Z"

current_version_id
string | null

Current active version ID

Example:

"subv_abc123"

discount
object | null

Subscription-level discount

maximum_spend
object | null

Maximum spend threshold

minimum_spend
object | null

Minimum spend threshold

plan_id
string | null

Plan ID

Example:

"pln_abc123"

price_escalation
object | null

Price escalation configuration

trial_period_days
integer<int64> | null

Trial period in days

Example:

30