Skip to content
Xaalis

Stop future billing

POST
/v1/subscriptions/{id}/cancel
curl --request POST \
  --url http://localhost:4000/v1/subscriptions/example/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "at_period_end": false }'

Immediate cancellation voids an invoice that has not started provider checkout. A payment already processing may still settle; pending_payment identifies it. Period-end cancellation lets the current invoice remain payable through grace.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string

Header Parameters

Section titled “Header Parameters”
idempotency-key
required

Required retry-safe key; reuse it only for the same operation and request body

string
>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
at_period_end
boolean

Responses

Section titled “ Responses ”

200

Section titled “200”

Subscription with pending payment, if any

Media typeapplication/json
object
id
required
string
object
required
string
Allowed values: subscription
livemode
required
boolean
status
required
string
Allowed values: active past_due canceled completed
customer
required
object
phone
required
string
/^\+2217[0-9]{8}$/
name
required
string
email
required
string | null
amount
required
integer
currency
required
string
Allowed values: XOF
interval
required
string
Allowed values: day week month year
interval_count
required
integer
billing_cycles
required
integer | null
cycles_paid
required
integer
current_period_start
required
string
current_period_end
required
string
next_invoice_at
required
string | null
cancel_at_period_end
required
boolean
canceled_at
required
string | null
completed_at
required
string | null
days_until_due
required
integer
cancel_after_days
required
integer
description
required
string | null
client_reference
required
string | null
metadata
required
object
key
additional properties
string
latest_invoice
required
object
id
required
string
object
required
string
Allowed values: invoice
livemode
required
boolean
subscription
required
string
period_index
required
integer
period_start
required
string
period_end
required
string
amount
required
integer
currency
required
string
Allowed values: XOF
status
required
string
Allowed values: open paid void uncollectible
payment
required

Current payment attempt; a confirmed failed attempt may be replaced

string | null
hosted_invoice_url
required

Stable customer link, payable until grace_ends_at

string format: uri
due_at
required

Invoice becomes overdue after this time but remains payable during grace

string
grace_ends_at
required
string
paid_at
required
string | null
reminders_sent
required
integer
created_at
required
string
created_at
required
string
pending_payment
required

A provider payment already in flight may still settle after cancellation

object
id
required
string
status
required
string
Allowed values: requires_payment_method processing succeeded failed expired refunded
Example
{
  "object": "subscription",
  "status": "active",
  "customer": {
    "phone": "+221771234567"
  },
  "currency": "XOF",
  "interval": "day",
  "latest_invoice": {
    "object": "invoice",
    "currency": "XOF",
    "status": "open"
  },
  "pending_payment": {
    "status": "requires_payment_method"
  }
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401”

Authentication error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Section titled “409”

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Section titled “429”

Rate limited; see Retry-After response header

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}