v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB

DigitalOcean-public.v2-new_Billing

Retrieve an Invoice Summary by UUID

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

get/v2/customers/my/invoices/{invoice_uuid}/summary

Path parameters

invoice_uuidstring required

UUID of the invoice

Response

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

invoice_uuidstring

UUID of the invoice

invoice_idstring

ID of the invoice

billing_periodstring

Billing period of usage for which the invoice is issued, in YYYY-MM format.

amountstring

Total amount of the invoice, in USD. This will reflect month-to-date usage in the invoice preview.

user_namestring

Name of the DigitalOcean customer being invoiced.

user_companystring

Company of the DigitalOcean customer being invoiced, if set.

user_emailstring

Email of the DigitalOcean customer being invoiced.

Example response

{
  "invoice_uuid": "22737513-0ea7-4206-8ceb-98a575af7681",
  "invoice_id": "123456789",
  "billing_period": "2020-01",
  "amount": "27.13",
  "user_name": "Sammy Shark",
  "user_billing_address": {
    "address_line1": "101 Shark Row",
    "address_line2": " ",
    "city": "Atlantis",
    "region": "OC",
    "postal_code": "12345",
    "country_iso2_code": "US",
    "created_at": "2019-09-03T16:34:46.000+00:00",
    "updated_at": "2019-09-03T16:34:46.000+00:00"
  },
  "user_company": "DigitalOcean",
  "user_email": "sammy@digitalocean.com",
  "product_charges": {
    "name": "Product usage charges",
    "amount": "12.34",
    "items": [
      {
        "amount": "10.00",
        "name": "Spaces Subscription",
        "count": "1"
      },
      {
        "amount": "2.34",
        "name": "Database Clusters",
        "count": "1"
      }
    ]
  },
  "overages": {
    "name": "Overages",
    "amount": "3.45"
  },
  "taxes": {
    "name": "Overages",
    "amount": "3.45"
  },
  "credits_and_adjustments": {
    "name": "Overages",
    "amount": "3.45"
  }
}