invoices_summaries

Creates, updates, deletes, gets or lists a invoices_summaries resource.

Overview

Name	invoices_summaries
Type	Resource
Id	digitalocean.billing.invoices_summaries

Fields

Name	Datatype	Description
amount	string	Total amount of the invoice, in USD. This will reflect month-to-date usage in the invoice preview.
billing_period	string	Billing period of usage for which the invoice is issued, in YYYY-MM format.
credits_and_adjustments	object	A summary of the credits and adjustments contributing to the invoice.
invoice_id	string	ID of the invoice
invoice_uuid	string	UUID of the invoice
overages	object	A summary of the overages contributing to the invoice.
product_charges	object	A summary of the product usage charges contributing to the invoice. This will include an amount, and grouped aggregates by resource type under the items key.
taxes	object	A summary of the taxes contributing to the invoice.
user_billing_address	object	The billing address of the customer being invoiced.
user_company	string	Company of the DigitalOcean customer being invoiced, if set.
user_email	string	Email of the DigitalOcean customer being invoiced.
user_name	string	Name of the DigitalOcean customer being invoiced.

Methods

Name	Accessible by	Required Params	Description
invoices_get_summary_by_uuid	SELECT	invoice_uuid	To retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/summary.

SELECT examples

To retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/summary.

SELECT
amount,
billing_period,
credits_and_adjustments,
invoice_id,
invoice_uuid,
overages,
product_charges,
taxes,
user_billing_address,
user_company,
user_email,
user_name
FROM digitalocean.billing.invoices_summaries
WHERE invoice_uuid = '{{ invoice_uuid }}';