Give Feedback

invoice_items_info

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

Get the line items for a specific invoice. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Billing.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`invoice_uuid` str / required		The UUID of the invoice to retrieve items for.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Get invoice items
  digitalocean.cloud.invoice_items_info:
    token: "{{ token }}"
    invoice_uuid: 22737513-0ea7-4206-8ceb-98a575af7681

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`invoice_items` list	always	List of items in the invoice. Sample: `[ { "amount": "5.00", "description": "my-droplet", "duration": "744 Hours", "duration_unit": "Hours", "end_time": "2023-02-01T00:00:00Z", "group_description": "Droplet (1 vCPU, 1GB / 25GB Disk)", "product": "Droplets", "project_name": "Default", "resource_id": "123456789", "resource_uuid": "9c42d3e4-e6d8-45d7-a76b-9e1c5f2a4b3c", "start_time": "2023-01-01T00:00:00Z" } ]`
`msg` str	always	Invoice items result information. Sample: `[ "Invoice items for 22737513-0ea7-4206-8ceb-98a575af7681", "No invoice items" ]`

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

invoice_items
list

always

List of items in the invoice.
Sample:

[
  {
    "amount": "5.00",
    "description": "my-droplet",
    "duration": "744 Hours",
    "duration_unit": "Hours",
    "end_time": "2023-02-01T00:00:00Z",
    "group_description": "Droplet (1 vCPU, 1GB / 25GB Disk)",
    "product": "Droplets",
    "project_name": "Default",
    "resource_id": "123456789",
    "resource_uuid": "9c42d3e4-e6d8-45d7-a76b-9e1c5f2a4b3c",
    "start_time": "2023-01-01T00:00:00Z"
  }
]

msg
str