Billing History Details

Accesses your billing history object.

application/json

Body

result

required

Any of

allOf {2}

array[object (billing-history) {8}]

allOf {2}

One of

array[object (billing-history) {8}]

object

action

string

Cloudflare Client API_action

read-onlyrequired

The billing item action.

<= 30 characters

Example:

subscription

amount

number

amount

read-onlyrequired

The amount associated with this billing item.

Example:

20.99

currency

string

currency

read-onlyrequired

The monetary unit in which pricing information is displayed.

Example:

USD

description

string

schemas-description

read-onlyrequired

The billing item description.

<= 255 characters

Example:

The billing item description

string

billing-history_components-schemas-identifier

read-onlyrequired

Billing item identifier tag.

<= 32 characters

Example:

b69a9f3492637782896352daae219e7d

occurred_at

string <date-time>

occurred_at

read-onlyrequired

When the billing item was created.

Example:

2014-03-01T12:21:59.3456Z

type

string

Cloudflare Client API_type

read-onlyrequired

The billing item type.

<= 30 characters

Example:

charge

zone

object

schemas-zone

required

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "action": "subscription",
            "amount": 20.99,
            "currency": "USD",
            "description": "The billing item description",
            "id": "b69a9f3492637782896352daae219e7d",
            "occurred_at": "2014-03-01T12:21:59.3456Z",
            "type": "charge",
            "zone": {
                "name": null
            }
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Billing History Details

Request

Request samples

Responses