Get Account Bad Debt

client.Billing.BadDebt.Get(ctx, query) (*BadDebtGetResponse, error)

GET/accounts/{account_id}/billing/bad-debt

Gets bad debt information for an account, including outstanding invoices and total debt amount.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

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

Example:X-Auth-Email: user@example.com

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

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

query BadDebtGetParams

AccountID param.Field[string]

Identifier

maxLength32

ReturnsExpand Collapse

type BadDebtGetResponse struct{…}

AlreadyPaid float64Optional

Amount already paid towards the debt.

BadDebtStatus stringOptional

The current bad debt status of the account.

Invoices []BadDebtGetResponseInvoiceOptional

List of outstanding invoices contributing to bad debt.

ID stringOptional

Billing history item identifier.

Action stringOptional

The billing item action.

Amount float64Optional

The amount associated with this billing item.

AmountToPay float64Optional

The amount remaining to pay.

Currency stringOptional

The currency of the billing item.

Description stringOptional

The billing item description.

ExternalInvoiceID stringOptional

The external invoice identifier.

HostedInvoiceURL stringOptional

URL to the hosted invoice.

InvoiceID stringOptional

The associated invoice identifier.

OccurredAt TimeOptional

When the billing event occurred.

formatdate-time

ReceiptID stringOptional

The associated receipt identifier.

Source stringOptional

The source of the billing item.

SourceInvoiceID stringOptional

The source invoice identifier.

Status stringOptional

The status of the billing item.

Type stringOptional

The billing item type.

TotalDebtAmount float64Optional

Total outstanding debt amount.

Get Account Bad Debt

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"),
  )
  badDebt, err := client.Billing.BadDebt.Get(context.TODO(), billing.BadDebtGetParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", badDebt.AlreadyPaid)
}

{
  "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": {
    "already_paid": 0,
    "bad_debt_status": "active",
    "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"
      }
    ],
    "total_debt_amount": 20.99
  },
  "success": true
}

Returns Examples

{
  "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": {
    "already_paid": 0,
    "bad_debt_status": "active",
    "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"
      }
    ],
    "total_debt_amount": 20.99
  },
  "success": true
}