Skip to main content
POST
Cancel an automatic payment

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

subscription
string
required

The subscription ID.

Example:

"a216c52c-ccea-430f-b3bf-09aaf1025a44"

Response

The record, as a JSON object. There is no envelope.

One standing arrangement to charge the customer again.

uuid
string
required

The uuid UUID.

Example:

"a216c52c-ccea-430f-b3bf-09aaf1025a44"

provider
string
required

The value of provider.

Example:

"paddle"

status
string
required

The payment provider's current status.

Example:

"active"

is_healthy
boolean
required

Whether the resource is healthy.

Example:

true

is_cancelled
boolean
required

Whether the resource is cancelled.

Example:

false

is_ending
boolean
required

Whether the resource is ending.

Example:

false

description
string | null
required

What it was bought as. The fallback name for a row whose services have gone away.

Example:

"Standard 4 GB · Kansas City, MO · Monthly"

billing_cycle
string | null
required

How often the service renews and is billed.

Example:

"monthly"

amount
string | null
required

The amount in the currency shown by currency.

Example:

"12.00"

currency
string | null
required

The three-letter currency code used for monetary amounts.

Example:

"USD"

next_charge_at
string | null
required

The next charge date, or null if no further payments are scheduled. Ending subscriptions have no next charge date. If the payment provider has not reported a date, this is the next due date of the earliest service covered.

Example:

"2026-10-02T19:15:08+00:00"

ends_at
string | null
required

When the agreed cancellation actually takes effect.

Example:

null

cancelled_at
string | null
required

The date and time for cancelled at, in UTC.

Example:

null

last_paid_at
string | null
required

The date and time for last paid at, in UTC.

Example:

"2026-09-02T19:15:08+00:00"

can_cancel
boolean
required

Whether the subscription can still be cancelled through its payment provider.

Example:

true

services
SubscriptionServiceData · object[]
required

The value of services.

Example:
cancellation_service_id
integer | null
required

For external payments, use the service autopay cancellation endpoint.

Example:

null