> ## Documentation Index
> Fetch the complete documentation index at: https://docs.saasybill.com/llms.txt
> Use this file to discover all available pages before exploring further.
# End a subscription
Requires the `subscriptions:write` scope. See [Authentication](/api-reference/authentication#scopes).
## OpenAPI
````yaml /api-reference/openapi.json post /v1/subscriptions/{id}/end
openapi: 3.1.0
info:
title: Saasybill API
version: 1.0.0
description: >-
Create and manage subscriptions in Saasybill from your own platform.
**Authentication.** `Authorization: Bearer saasybill_live_…`. Create keys
under Developer Settings.
**Idempotency.** Send an `Idempotency-Key` on writes. It is required to
create a subscription.
**Webhooks.** Saasybill calls your URL when something changes. Events:
`customer.created`, `customer.updated`, `customer.deleted`,
`subscription.created`, `subscription.updated`, `subscription.ended`,
`subscription.restored`, `subscription.deleted`, `invoice.created`,
`invoice.updated`, `invoice.paid`, `invoice.voided`, `invoice.deleted`,
`credit_note.created`, `credit_note.updated`, `credit_note.voided`,
`credit_note.deleted`. Each request is signed: `Saasybill-Signature: t=,v1=`, where `v1` is `HMAC-SHA256(secret, ".")`.
Reject a `t` more than five minutes old. Deliveries are at-least-once,
retried for about 20 hours, and unordered: de-duplicate on the event `id`.
Changes are detected about once a minute, so an event can arrive up to a
minute late, and changes inside one minute are combined.
**Testing.** Create a sandbox under Developer Settings → Configuration,
connect it to a Xero Demo Company, and use a test key (`saasybill_test_…`)
created inside it. A test key works only in its sandbox, which sends no
emails and is never billed. Your plans, customers and subscriptions can be
copied into the sandbox when it is created or reset, and its test clock can
be advanced to see renewals without waiting. `GET /v1/organisation` returns
`livemode: false` for a sandbox.
servers:
- url: https://api.saasybill.com
description: Production
security: []
tags:
- name: Organisation
description: The organisation an API key belongs to.
- name: Customers
description: >-
Customers are synced from Xero. Create one only where the organisation
allows it.
- name: Plans
description: Read the pricing plans you can sell.
- name: Charges
description: Read the one-off fees that can be added to a new subscription.
- name: Subscriptions
description: Create subscriptions, change units, and end or restore them.
- name: Invoices
description: Read the invoices Saasybill raises in Xero.
- name: Credit notes
description: >-
Read the credit notes Saasybill raises in Xero, and where their credit was
applied.
- name: Usage
description: Report the usage that is billed in arrears against a subscription.
paths:
/v1/subscriptions/{id}/end:
post:
tags:
- Subscriptions
summary: End a subscription
operationId: post_v1_subscriptions_id_end
parameters:
- name: id
in: path
required: true
schema:
type: string
example: 9d4e2b7a-13c5-4f8e-b6a0-2e1d7c9f5b33
description: The Saasybill id of the subscription.
- name: Idempotency-Key
in: header
required: false
description: >-
1 to 255 printable characters. A retry with the same key and body
returns the first response.
schema:
type: string
minLength: 1
maxLength: 255
example: signup_8f3a2c1d
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
when:
type: string
enum:
- now
- period_end
delete_unsent_invoices:
description: >-
With `when: now`: also delete the subscription's invoices
that were never sent, in Xero. Default false.
type: boolean
void_approved_invoices:
description: >-
With `when: now`: also void its approved, unpaid invoices in
Xero. Default false.
type: boolean
invoice_usage_now:
description: >-
With `when: now`: raise the final usage invoice at once
instead of after the organisation's usage grace period.
Ignored when the plan bills no meter. Default false.
type: boolean
required:
- when
additionalProperties: false
examples:
End at period end:
summary: End at period end
description: The subscription runs to its renewal date and does not renew.
value:
when: period_end
End now:
summary: End now
description: >-
End immediately, and remove invoices in Xero that were never
sent.
value:
when: now
delete_unsent_invoices: true
void_approved_invoices: false
invoice_usage_now: false
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
id:
type: string
object:
type: string
const: subscription
customer:
type: string
customer_code:
type:
- string
- 'null'
plan:
type: string
status:
type: string
enum:
- pending
- active
- complete
- ended
currency:
type: string
interval:
type: object
properties:
unit:
type: string
enum:
- day
- week
- month
- year
count:
type: integer
required:
- unit
- count
additionalProperties: false
timezone:
type: string
start_date:
type: string
description: YYYY-MM-DD, in the subscription's own timezone.
renewal_date:
anyOf:
- type: string
description: YYYY-MM-DD, in the subscription's own timezone.
- type: 'null'
end_date:
anyOf:
- type: string
description: YYYY-MM-DD, in the subscription's own timezone.
- type: 'null'
units:
type: integer
minimum_units:
type: integer
discount_percent:
type: string
description: A decimal string, e.g. "19.9900".
cancel_at_period_end:
type: boolean
end_after_cycles:
anyOf:
- type: integer
- type: 'null'
label:
type:
- string
- 'null'
invoice_reference:
type:
- string
- 'null'
renewal_value:
type: string
description: >-
What the next period is certain to bill: the plan at its
current units, the add-ons, and the minimum units of each
meter the plan bills, net of the discount. Usage above the
meter minimums is not included; see `usage_value`.
usage_value:
type: string
description: >-
The average, over the last three closed usage periods, of
what each billed for usage above the meter minimums, net
of the discount. An estimate at the plan's current meter
prices, and never part of `renewal_value`. 0 until a usage
period has closed, and for a plan that bills no meter.
usage_value_annual:
type: string
description: '`usage_value` times the periods in a year.'
minimum_usage_value:
type: string
description: >-
The part of `renewal_value` that is the meter minimums,
net of the discount. 0 for a plan that bills no meter.
meters:
type: array
items:
type: object
properties:
meter:
type: string
description: The Saasybill meter id.
meter_code:
type: string
name:
type: string
minimum_units:
type: integer
description: >-
The minimum in force: this subscription's own where
it set one, never below the plan's.
plan_minimum_units:
type: integer
description: The plan's minimum for the meter.
required:
- meter
- meter_code
- name
- minimum_units
- plan_minimum_units
additionalProperties: false
description: >-
The meters the subscription's plan bills for, with the
minimum each is billed at.
cpi_enabled:
type: boolean
description: Whether the price rises with CPI at each renewal.
created:
type: string
format: date-time
description: ISO 8601, UTC.
required:
- id
- object
- customer
- customer_code
- plan
- status
- currency
- interval
- timezone
- start_date
- renewal_date
- end_date
- units
- minimum_units
- discount_percent
- cancel_at_period_end
- end_after_cycles
- label
- invoice_reference
- renewal_value
- usage_value
- usage_value_annual
- minimum_usage_value
- meters
- cpi_enabled
- created
additionalProperties: false
example:
id: 9d4e2b7a-13c5-4f8e-b6a0-2e1d7c9f5b33
object: subscription
customer: 3b9f1c1e-6a52-4c0e-9d7e-1f6f2f0b7a11
customer_code: ACME-001
plan: b6c1e0a4-2f7d-4a61-8f0c-5d3e9a7b2c44
status: active
currency: AUD
interval:
unit: month
count: 1
timezone: Australia/Sydney
start_date: '2026-09-30'
renewal_date: '2026-10-30'
end_date: '2026-10-30'
units: 10
minimum_units: 5
discount_percent: '10.00'
cancel_at_period_end: true
end_after_cycles: null
label: Acme � Team plan
invoice_reference: PO-4471
renewal_value: '108.0000'
usage_value: '0.0000'
usage_value_annual: '0.0000'
minimum_usage_value: '0.0000'
meters: []
cpi_enabled: false
created: '2026-09-30T04:12:00.000Z'
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
RateLimit-Limit:
$ref: '#/components/headers/RateLimit-Limit'
RateLimit-Remaining:
$ref: '#/components/headers/RateLimit-Remaining'
RateLimit-Reset:
$ref: '#/components/headers/RateLimit-Reset'
'401':
description: The key is missing, malformed, revoked or expired.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: authentication_error
code: invalid_api_key
message: 'Provide a valid API key as `Authorization: Bearer `.'
request_id: req_4f1a9c2e7b8d3a605e1c9f02
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
'403':
description: >-
The key lacks the scope, is a test key, or the organisation has not
allowed this.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: permission_error
code: insufficient_scope
message: This API key does not have the `subscriptions:write` scope.
request_id: req_4f1a9c2e7b8d3a605e1c9f02
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
'404':
description: No such object.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: not_found
code: subscription_not_found
message: There is no subscription with that id.
request_id: req_4f1a9c2e7b8d3a605e1c9f02
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
'409':
description: >-
The request conflicts with the current state, or with an earlier
request using the same `Idempotency-Key`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: conflict
code: idempotency_conflict
message: >-
This `Idempotency-Key` was used with a different request.
Use a new key for a different request.
request_id: req_4f1a9c2e7b8d3a605e1c9f02
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
'422':
description: A field is missing or invalid. `error.param` names it.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: invalid_request_error
code: invalid_parameter
message: '`units`: Invalid input: expected number, received string'
param: units
request_id: req_4f1a9c2e7b8d3a605e1c9f02
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
'429':
description: 'Rate limited: 120 requests a minute per key. See `Retry-After`.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: rate_limit_error
code: rate_limited
message: Too many requests. Try again in 12 seconds.
request_id: req_4f1a9c2e7b8d3a605e1c9f02
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
'500':
description: >-
Something went wrong on our side. Retry; quote `error.request_id` if
it persists.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: api_error
code: internal_error
message: >-
Something went wrong on our side. Retry the request; if it
keeps failing, quote the request id.
request_id: req_4f1a9c2e7b8d3a605e1c9f02
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
security:
- bearerAuth:
- subscriptions:write
components:
headers:
Request-Id:
description: A unique id for the request. Quote it when you contact support.
schema:
type: string
example: req_4f1a9c2e7b8d3a605e1c9f02
RateLimit-Limit:
description: Requests allowed per minute for this key.
schema:
type: integer
example: 120
RateLimit-Remaining:
description: Requests left in the current window.
schema:
type: integer
example: 117
RateLimit-Reset:
description: Seconds until the oldest counted request stops counting.
schema:
type: integer
example: 41
schemas:
Error:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum:
- authentication_error
- permission_error
- invalid_request_error
- not_found
- conflict
- rate_limit_error
- api_error
code:
type: string
description: Stable. Branch on this, never on `message`.
message:
type: string
param:
type: string
request_id:
type: string
required:
- type
- code
- message
- request_id
additionalProperties: false
required:
- error
additionalProperties: false
description: >-
Every failed request answers with this shape. Branch on `error.code`,
never on `error.message`.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
An API key. Its scopes decide what it may call: `customers:read` (List
and look up customers.) `customers:write` (Create customers, and Xero
contacts where the organisation allows it.) `catalogue:read` (List plans
and charges.) `subscriptions:read` (List and look up subscriptions.)
`subscriptions:write` (Create subscriptions, change units, end and
restore them.) `invoices:read` (List and look up invoices.)
`credit_notes:read` (List and look up credit notes, and where their
credit was applied.)
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.