List Billing Usages

Returns a collection of billing usages

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

company_id

string

An ID of a company to filter by, which will look like biz_*************

product_id

string

An ID of a product to filter by, which will look like prod_*************

membership_id

string

An ID of a membership to filter by, which will look like mem_*************

billing_item_id

string

An ID of a billing item to filter by, which will look like bi_*************

billing_item_identifier

string

An identifier of a billing item to filter by.

page

integer

default: 1

The page number to retrieve

per

integer

default: 10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json

pagination

object

required

Show child attributes

pagination.current_page

number

required

Current page number

pagination.total_pages

number

required

Total number of pages

pagination.next_page

number

required

Next page number

pagination.prev_page

number

required

Previous page number

pagination.total_count

number

required

Total number of records

data

object[]

required

Show child attributes

data.id

string

required

The ID of the billing usage, which will look like bu_*************

data.created_at

number

required

The date the billing usage was created as a unix timestamp.

data.company_id

string

required

The ID of the company, which will look like biz_*************

data.app_id

string

required

The ID of the app, which will look like app_*************

data.membership_id

string

required

The ID of the membership, which will look like mem_*************

data.billing_item_id

string

required

The ID of the billing item, which will look like bi_*************

data.quantity

number

The quantity to charge for the billing item, if the billing item is structured.

data.amount

number

The amount to charge, if the billing item is variable.

data.receipt_id

string

The ID of the receipt, which will look like rec_*************