> ## 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.
# List subscriptions
Requires the `subscriptions:read` scope. See [Authentication](/api-reference/authentication#scopes).
## OpenAPI
````yaml /api-reference/openapi.json get /v1/subscriptions
openapi: 3.1.0
info:
title: Saasybill API
version: 1.0.0
description: >-
Create and manage subscriptions in Saasybill from your own platform.
Every request is authenticated with an API key sent as `Authorization:
Bearer saasybill_live_…`.
Writes accept an `Idempotency-Key` header. It is required to create a
subscription.
Webhooks, errors, pagination and idempotency are covered in the guides
alongside this reference.
servers:
- url: https://app.saasybill.com/api
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.
paths:
/v1/subscriptions:
get:
tags:
- Subscriptions
summary: List subscriptions
operationId: get_v1_subscriptions
parameters:
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 25
- name: starting_after
in: query
description: The id of the last object on the previous page.
schema:
type: string
- name: customer
in: query
description: A customer id.
schema:
type: string
- name: customer_code
in: query
description: A customer code.
schema:
type: string
- name: status
in: query
description: Only these.
schema:
type: string
enum:
- pending
- active
- complete
- ended
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
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: A decimal string, e.g. "19.9900".
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
- created
additionalProperties: false
has_more:
type: boolean
required:
- data
- has_more
additionalProperties: false
example:
data:
- 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: null
units: 10
minimum_units: 5
discount_percent: '10.00'
cancel_at_period_end: false
end_after_cycles: null
label: Acme – Team plan
invoice_reference: PO-4471
renewal_value: '108.0000'
created: '2026-09-30T04:12:00.000Z'
has_more: false
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:read
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.)
````