Give Feedback

billing_history_info

Generated on 30 Jun 2025 from digitalocean.cloud version v1.2.1

Synopsis

Retrieve a list of all billing history entries. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/billingHistory_list.

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.
`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 billing history information
  digitalocean.cloud.billing_history_info:
    token: "{{ token }}"

Return Values

Key Returned Description

Key	Returned	Description
`billing_history` list	always	Billing history information. Sample: `[ { "amount": 12.34, "date": "2018-06-01T08:44:38Z", "description": "Invoice for May 2018", "invoice_id": 123, "invoice_uuid": "example-uuid", "type": "Invoice" } ]`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Billing history result information. Sample: `[ "Current billing history information", "No billing history information" ]`

billing_history
list

always

Billing history information.
Sample:

[
  {
    "amount": 12.34,
    "date": "2018-06-01T08:44:38Z",
    "description": "Invoice for May 2018",
    "invoice_id": 123,
    "invoice_uuid": "example-uuid",
    "type": "Invoice"
  }
]

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str