invoices

Creates, updates, deletes, gets or lists an invoices resource.

Overview

Name	invoices
Type	Resource
Id	linode.account.invoices

Fields

The following fields are returned by SELECT queries:

get_invoice

An Invoice object.

Name	Datatype	Description
id	integer	Read-only The Invoice's unique ID.
billing_source	string	Filterable, Read-only akamai: This Invoice was generated according to the terms of an agreement between the customer and Akamai. linode: This Invoice was generated according to the default terms, prices, and discounts. (example: linode)
date	string (date-time)	Filterable, Read-only When this Invoice was generated. (example: 2018-01-01T00:01:01)
label	string	Filterable, Read-only The Invoice's display label. (example: Invoice)
subtotal	number	Read-only The amount of the Invoice before taxes in US Dollars.
tax	number	Read-only The amount of tax levied on the Invoice in US Dollars.
tax_summary	array	Read-only The amount of tax broken down into subtotals by source.
total	number	Filterable, Read-only The amount of the Invoice after taxes in US Dollars.

get_invoices

Returns a paginated list of Invoice objects.

Name	Datatype	Description
data	array
page	integer	Read-only The current page.
pages	integer	Read-only The total number of pages.
results	integer	Read-only The total number of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_invoice	select			Returns a single Invoice object. Learn more... Learn more...
get_invoices	select		page, page_size	Returns a paginated list of Invoices against your Account. Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get_invoice

Returns a single Invoice object.

Learn more...

Learn more...

SELECT
id,
billing_source,
date,
label,
subtotal,
tax,
tax_summary,
total
FROM linode.account.invoices;

get_invoices

Returns a paginated list of Invoices against your Account.

Learn more...

Learn more...

SELECT
data,
page,
pages,
results
FROM linode.account.invoices
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';