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
- list
An Invoice object.
| Name | Datatype | Description |
|---|---|---|
id | integer | Read-only The Invoice's unique ID. |
billing_source | string | Filterable, Read-only The source of service charges for this invoice. A value of akamai indicates an invoice generated according to the terms of an agreement between the customer and Akamai. A value of linode indicates an invoice was generated according to the default terms, prices, and discounts. (akamai, linode) (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. |
Returns a paginated list of Invoice objects.
| Name | Datatype | Description |
|---|---|---|
id | integer | Read-only The Invoice's unique ID. |
billing_source | string | Filterable, Read-only The source of service charges for this invoice. A value of akamai indicates an invoice generated according to the terms of an agreement between the customer and Akamai. A value of linode indicates an invoice was generated according to the default terms, prices, and discounts. (akamai, linode) (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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | invoiceId | Returns a single Invoice object. Learn more... Learn more... | |
list | select | X-Filter, 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 |
|---|---|---|
invoiceId | string | The ID of the Invoice. |
X-Filter | | Specifies a JSON object to filter down the results. See Filtering and sorting for details. (example: {{X-Filter}}) |
page | integer | The page of a collection to return. |
page_size | integer | The number of items to return per page. |
SELECT examples
- get
- list
Returns a single Invoice object.
Learn more...
Learn more...
SELECT
id,
billing_source,
date,
label,
subtotal,
tax,
tax_summary,
total
FROM linode.account.invoices
WHERE invoiceId = '{{ invoiceId }}' -- required
;
Returns a paginated list of invoices against your account.
Learn more...
Learn more...
SELECT
id,
billing_source,
date,
label,
subtotal,
tax,
tax_summary,
total
FROM linode.account.invoices
WHERE X-Filter = '{{ X-Filter }}'
AND page = '{{ page }}'
AND page_size = '{{ page_size }}'
;