Billing History Details

Deprecated

client.User.Billing.History.List(ctx, query) (*V4PagePaginationArray[BillingHistory], error)

GET/user/billing/history

Accesses your billing history object.

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

Accepted Permissions (at least one required)

Billing WriteBilling Read

ParametersExpand Collapse

query BillingHistoryListParams

Action param.Field[string]Optional

The billing item action.

maxLength30

OccurredAt param.Field[Time]Optional

When the billing item was created.

formatdate-time

Order param.Field[BillingHistoryListParamsOrder]Optional

Field to order billing history by.

const BillingHistoryListParamsOrderType BillingHistoryListParamsOrder = "type"

const BillingHistoryListParamsOrderOccurredAt BillingHistoryListParamsOrder = "occurred_at"

const BillingHistoryListParamsOrderAction BillingHistoryListParamsOrder = "action"

Page param.Field[float64]Optional

Page number of paginated results.

minimum1

PerPage param.Field[float64]Optional

Number of items per page.

maximum50

minimum5

Type param.Field[string]Optional

The billing item type.

maxLength30

ReturnsExpand Collapse

type BillingHistory struct{…}

ID string

Billing item identifier tag.

maxLength32

Action string

The billing item action.

maxLength30

Amount float64

The amount associated with this billing item.

Currency string

The monetary unit in which pricing information is displayed.

Description string

The billing item description.

maxLength255

OccurredAt Time

When the billing item was created.

formatdate-time

Type string

The billing item type.

maxLength30

Zone BillingHistoryZone

Name stringOptional

Billing History Details

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/user"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.User.Billing.History.List(context.TODO(), user.BillingHistoryListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "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": [
    {
      "id": "b69a9f3492637782896352daae219e7d",
      "action": "subscription",
      "amount": 20.99,
      "currency": "USD",
      "description": "The billing item description",
      "occurred_at": "2014-03-01T12:21:59.3456Z",
      "type": "charge",
      "zone": {
        "name": "name"
      }
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

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": [
    {
      "id": "b69a9f3492637782896352daae219e7d",
      "action": "subscription",
      "amount": 20.99,
      "currency": "USD",
      "description": "The billing item description",
      "occurred_at": "2014-03-01T12:21:59.3456Z",
      "type": "charge",
      "zone": {
        "name": "name"
      }
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}