Skip to main content
GET
Retrieve a charge
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 charge.

Example:

"e2a7d5c8-91b3-4d16-a0f4-7c8b6e5d3a22"

Response

Success.

id
string
required
object
string
required
Allowed value: "charge"
code
string
required
name
string
required
description
string | null
required
currency
string
required
price
string
required

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

allows_price_override
boolean
required
status
enum<string>
required
Available options:
draft,
active,
inactive,
legacy
created
string<date-time>
required

ISO 8601, UTC.