---
title: Get Unpaid Invoices
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

[Billing](https://developers.cloudflare.com/api/go/resources/billing)

[Unpaid Invoice](https://developers.cloudflare.com/api/go/resources/billing/subresources/unpaid_invoice)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get Unpaid Invoices

client.Billing.UnpaidInvoice.Get(ctx, query) (\*[UnpaidInvoiceGetResponse](<https://developers.cloudflare.com/api/go/resources/billing#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)>), error)

GET/accounts/{account\_id}/billing/unpaid-invoice

Gets unpaid invoice information for an account.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### ParametersExpand Collapse

<details>

<summary>

query UnpaidInvoiceGetParams

</summary>

AccountID param.Field\[string]

Identifier

maxLength32

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20billing.unpaid_invoice%20%3E%20(method)%20get%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type UnpaidInvoiceGetResponse struct{…}

</summary>

<details>

<summary>

Invoices \[]UnpaidInvoiceGetResponseInvoiceOptional

List of unpaid invoices.

</summary>

ID stringOptional

Billing history item identifier.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

Action stringOptional

The billing item action.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20action">Link to this property</a>

Amount float64Optional

The amount associated with this billing item.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20amount">Link to this property</a>

AmountToPay float64Optional

The amount remaining to pay.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20amount_to_pay">Link to this property</a>

Currency stringOptional

The currency of the billing item.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20currency">Link to this property</a>

Description stringOptional

The billing item description.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20description">Link to this property</a>

ExternalInvoiceID stringOptional

The external invoice identifier.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20external_invoice_id">Link to this property</a>

HostedInvoiceURL stringOptional

URL to the hosted invoice.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20hosted_invoice_url">Link to this property</a>

InvoiceID stringOptional

The associated invoice identifier.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20invoice_id">Link to this property</a>

OccurredAt TimeOptional

When the billing event occurred.

formatdate-time

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20occurred_at">Link to this property</a>

ReceiptID stringOptional

The associated receipt identifier.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20receipt_id">Link to this property</a>

Source stringOptional

The source of the billing item.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20source">Link to this property</a>

SourceInvoiceID stringOptional

The source invoice identifier.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20source_invoice_id">Link to this property</a>

Status stringOptional

The status of the billing item.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20status">Link to this property</a>

Type stringOptional

The billing item type.

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20type">Link to this property</a>

</details>

<a href="#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)%20%3E%20(property)%20invoices">Link to this property</a>

</details>

[Link to this property](<#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20UnpaidInvoiceGetResponse%20%3E%20(schema)>)

### Get Unpaid Invoices

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/billing"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  unpaidInvoice, err := client.Billing.UnpaidInvoice.Get(context.TODO(), billing.UnpaidInvoiceGetParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", unpaidInvoice.Invoices)
}
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "invoices": [
      {
        "id": "b69a9f3492637782896352daae219e7d",
        "action": "subscription",
        "amount": 20.99,
        "amount_to_pay": 0,
        "currency": "USD",
        "description": "The billing item description",
        "external_invoice_id": "external_invoice_id",
        "hosted_invoice_url": "hosted_invoice_url",
        "invoice_id": "invoice_id",
        "occurred_at": "2014-03-01T12:21:59.3456Z",
        "receipt_id": "receipt_id",
        "source": "source",
        "source_invoice_id": "source_invoice_id",
        "status": "status",
        "type": "charge"
      }
    ]
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "invoices": [
      {
        "id": "b69a9f3492637782896352daae219e7d",
        "action": "subscription",
        "amount": 20.99,
        "amount_to_pay": 0,
        "currency": "USD",
        "description": "The billing item description",
        "external_invoice_id": "external_invoice_id",
        "hosted_invoice_url": "hosted_invoice_url",
        "invoice_id": "invoice_id",
        "occurred_at": "2014-03-01T12:21:59.3456Z",
        "receipt_id": "receipt_id",
        "source": "source",
        "source_invoice_id": "source_invoice_id",
        "status": "status",
        "type": "charge"
      }
    ]
  },
  "success": true
}
```