Skip to main content
GET
Retrieve a plan
Requires the catalogue:read scope. See Authentication.

Authorizations

Authorization
string
header
required

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.)

Path Parameters

id
string
required

The Saasybill id of the plan.

Example:

"b6c1e0a4-2f7d-4a61-8f0c-5d3e9a7b2c44"

Response

Success.

id
string
required
object
string
required
Allowed value: "plan"
code
string
required
name
string
required
type
enum<string>
required
Available options:
flat_fee,
per_unit,
tiered,
volume,
stairstep
interval
object
required
currency
string
required
price
string
required

A decimal string, e.g. "19.9900".

minimum_units
integer
required
free_units
integer
required
unit_labels
object
required
allows_price_override
boolean
required
status
enum<string>
required
Available options:
draft,
active,
inactive,
legacy
tiers
object[]
required
created
string<date-time>
required

ISO 8601, UTC.