HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
API Reference
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo

List Subscription Add-On's Usage

get
https://{subdomain}.{domain}/v2/subscriptions//add_ons//usage

Query on billed and unbilled usage for your customer's usage-based add-on.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Subscription's unique identifier.

string
required

The unique add-on code.

Query Params
string

Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.

integer
Defaults to 50

Number of records to return per page, up to a maximum of 200.

string
Defaults to unbilled

all, unbilled, or billed. Defines whether or not to include usage records with a billed_at date.

string
Defaults to usage

usage or recording. Whether you would like to filter on the usage_timestamp or the recording_timestamp.

date-time

Show usage records greater than or equal to this date.

date-time

Show usage records less than this date.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/xml

Updated about 2 months ago

Did this page help you?