# Billing

# History

## Billing History Details

`client.user.billing.history.list(HistoryListParamsquery?, RequestOptionsoptions?): V4PagePaginationArray<BillingHistory>`

**get** `/user/billing/history`

Accesses your billing history object.

### Parameters

- `query: HistoryListParams`

  - `action?: string`

    The billing item action.

  - `occurred_at?: string`

    When the billing item was created.

  - `order?: "type" | "occurred_at" | "action"`

    Field to order billing history by.

    - `"type"`

    - `"occurred_at"`

    - `"action"`

  - `page?: number`

    Page number of paginated results.

  - `per_page?: number`

    Number of items per page.

  - `type?: string`

    The billing item type.

### Returns

- `BillingHistory`

  - `id: string`

    Billing item identifier tag.

  - `action: string`

    The billing item action.

  - `amount: number`

    The amount associated with this billing item.

  - `currency: string`

    The monetary unit in which pricing information is displayed.

  - `description: string`

    The billing item description.

  - `occurred_at: string`

    When the billing item was created.

  - `type: string`

    The billing item type.

  - `zone: Zone`

    - `name?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const billingHistory of client.user.billing.history.list()) {
  console.log(billingHistory.id);
}
```

#### Response

```json
{
  "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
  }
}
```

## Domain Types

### Billing History

- `BillingHistory`

  - `id: string`

    Billing item identifier tag.

  - `action: string`

    The billing item action.

  - `amount: number`

    The amount associated with this billing item.

  - `currency: string`

    The monetary unit in which pricing information is displayed.

  - `description: string`

    The billing item description.

  - `occurred_at: string`

    When the billing item was created.

  - `type: string`

    The billing item type.

  - `zone: Zone`

    - `name?: string`

# Profile

## Billing Profile Details

`client.user.billing.profile.get(RequestOptionsoptions?): ProfileGetResponse`

**get** `/user/billing/profile`

Accesses your billing profile object.

### Returns

- `ProfileGetResponse`

  - `id?: string`

    Billing item identifier tag.

  - `account_type?: string`

  - `address?: string`

  - `address2?: string`

  - `balance?: string`

  - `card_expiry_month?: number`

  - `card_expiry_year?: number`

  - `card_number?: string`

  - `city?: string`

  - `company?: string`

  - `country?: string`

  - `created_on?: string`

  - `device_data?: string`

  - `edited_on?: string`

  - `enterprise_billing_email?: string`

  - `enterprise_primary_email?: string`

  - `first_name?: string`

  - `is_partner?: boolean`

  - `last_name?: string`

  - `next_bill_date?: string`

  - `payment_address?: string`

  - `payment_address2?: string`

  - `payment_city?: string`

  - `payment_country?: string`

  - `payment_email?: string`

  - `payment_first_name?: string`

  - `payment_gateway?: string`

  - `payment_last_name?: string`

  - `payment_nonce?: string`

  - `payment_state?: string`

  - `payment_zipcode?: string`

  - `primary_email?: string`

  - `state?: string`

  - `tax_id_type?: string`

  - `telephone?: string`

  - `use_legacy?: boolean`

  - `validation_code?: string`

  - `vat?: string`

  - `zipcode?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const profile = await client.user.billing.profile.get();

console.log(profile.id);
```

#### Response

```json
{
  "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",
    "account_type": "type",
    "address": "123 Main Street",
    "address2": "Apt 1",
    "balance": "0",
    "card_expiry_month": 12,
    "card_expiry_year": 2099,
    "card_number": "4242424242424242",
    "city": "Anytown",
    "company": "Company",
    "country": "Anycountry",
    "created_on": "2014-03-01T12:21:59.3456Z",
    "device_data": "sample_data",
    "edited_on": "2014-03-01T12:21:59.3456Z",
    "enterprise_billing_email": "johndoe@gmail.com",
    "enterprise_primary_email": "johndoe@gmail.com",
    "first_name": "John",
    "is_partner": false,
    "last_name": "Doe",
    "next_bill_date": "2014-03-01T12:21:59.3456Z",
    "payment_address": "123 Main Street",
    "payment_address2": "Apt 1",
    "payment_city": "Anytown",
    "payment_country": "Anycountry",
    "payment_email": "johndoe@gmail.com",
    "payment_first_name": "John",
    "payment_gateway": "gateway",
    "payment_last_name": "Doe",
    "payment_nonce": "abc123",
    "payment_state": "state",
    "payment_zipcode": "12345",
    "primary_email": "johndoe@gmail.com",
    "state": "AnyState",
    "tax_id_type": "type",
    "telephone": "1234567899",
    "use_legacy": false,
    "validation_code": "1111",
    "vat": "GB123456789",
    "zipcode": "12345"
  },
  "success": true
}
```

## Domain Types

### Profile Get Response

- `ProfileGetResponse`

  - `id?: string`

    Billing item identifier tag.

  - `account_type?: string`

  - `address?: string`

  - `address2?: string`

  - `balance?: string`

  - `card_expiry_month?: number`

  - `card_expiry_year?: number`

  - `card_number?: string`

  - `city?: string`

  - `company?: string`

  - `country?: string`

  - `created_on?: string`

  - `device_data?: string`

  - `edited_on?: string`

  - `enterprise_billing_email?: string`

  - `enterprise_primary_email?: string`

  - `first_name?: string`

  - `is_partner?: boolean`

  - `last_name?: string`

  - `next_bill_date?: string`

  - `payment_address?: string`

  - `payment_address2?: string`

  - `payment_city?: string`

  - `payment_country?: string`

  - `payment_email?: string`

  - `payment_first_name?: string`

  - `payment_gateway?: string`

  - `payment_last_name?: string`

  - `payment_nonce?: string`

  - `payment_state?: string`

  - `payment_zipcode?: string`

  - `primary_email?: string`

  - `state?: string`

  - `tax_id_type?: string`

  - `telephone?: string`

  - `use_legacy?: boolean`

  - `validation_code?: string`

  - `vat?: string`

  - `zipcode?: string`