# Billing

# History

## Billing History Details

`user.billing.history.list(HistoryListParams**kwargs)  -> SyncV4PagePaginationArray[BillingHistory]`

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

Accesses your billing history object.

### Parameters

- `action: Optional[str]`

  The billing item action.

- `occurred_at: Optional[Union[str, datetime]]`

  When the billing item was created.

- `order: Optional[Literal["type", "occurred_at", "action"]]`

  Field to order billing history by.

  - `"type"`

  - `"occurred_at"`

  - `"action"`

- `page: Optional[float]`

  Page number of paginated results.

- `per_page: Optional[float]`

  Number of items per page.

- `type: Optional[str]`

  The billing item type.

### Returns

- `class BillingHistory: …`

  - `id: str`

    Billing item identifier tag.

  - `action: str`

    The billing item action.

  - `amount: float`

    The amount associated with this billing item.

  - `currency: str`

    The monetary unit in which pricing information is displayed.

  - `description: str`

    The billing item description.

  - `occurred_at: datetime`

    When the billing item was created.

  - `type: str`

    The billing item type.

  - `zone: Zone`

    - `name: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.user.billing.history.list()
page = page.result[0]
print(page.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

- `class BillingHistory: …`

  - `id: str`

    Billing item identifier tag.

  - `action: str`

    The billing item action.

  - `amount: float`

    The amount associated with this billing item.

  - `currency: str`

    The monetary unit in which pricing information is displayed.

  - `description: str`

    The billing item description.

  - `occurred_at: datetime`

    When the billing item was created.

  - `type: str`

    The billing item type.

  - `zone: Zone`

    - `name: Optional[str]`

# Profile

## Billing Profile Details

`user.billing.profile.get()  -> ProfileGetResponse`

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

Accesses your billing profile object.

### Returns

- `class ProfileGetResponse: …`

  - `id: Optional[str]`

    Billing item identifier tag.

  - `account_type: Optional[str]`

  - `address: Optional[str]`

  - `address2: Optional[str]`

  - `balance: Optional[str]`

  - `card_expiry_month: Optional[int]`

  - `card_expiry_year: Optional[int]`

  - `card_number: Optional[str]`

  - `city: Optional[str]`

  - `company: Optional[str]`

  - `country: Optional[str]`

  - `created_on: Optional[datetime]`

  - `device_data: Optional[str]`

  - `edited_on: Optional[datetime]`

  - `enterprise_billing_email: Optional[str]`

  - `enterprise_primary_email: Optional[str]`

  - `first_name: Optional[str]`

  - `is_partner: Optional[bool]`

  - `last_name: Optional[str]`

  - `next_bill_date: Optional[datetime]`

  - `payment_address: Optional[str]`

  - `payment_address2: Optional[str]`

  - `payment_city: Optional[str]`

  - `payment_country: Optional[str]`

  - `payment_email: Optional[str]`

  - `payment_first_name: Optional[str]`

  - `payment_gateway: Optional[str]`

  - `payment_last_name: Optional[str]`

  - `payment_nonce: Optional[str]`

  - `payment_state: Optional[str]`

  - `payment_zipcode: Optional[str]`

  - `primary_email: Optional[str]`

  - `state: Optional[str]`

  - `tax_id_type: Optional[str]`

  - `telephone: Optional[str]`

  - `use_legacy: Optional[bool]`

  - `validation_code: Optional[str]`

  - `vat: Optional[str]`

  - `zipcode: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
profile = client.user.billing.profile.get()
print(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

- `class ProfileGetResponse: …`

  - `id: Optional[str]`

    Billing item identifier tag.

  - `account_type: Optional[str]`

  - `address: Optional[str]`

  - `address2: Optional[str]`

  - `balance: Optional[str]`

  - `card_expiry_month: Optional[int]`

  - `card_expiry_year: Optional[int]`

  - `card_number: Optional[str]`

  - `city: Optional[str]`

  - `company: Optional[str]`

  - `country: Optional[str]`

  - `created_on: Optional[datetime]`

  - `device_data: Optional[str]`

  - `edited_on: Optional[datetime]`

  - `enterprise_billing_email: Optional[str]`

  - `enterprise_primary_email: Optional[str]`

  - `first_name: Optional[str]`

  - `is_partner: Optional[bool]`

  - `last_name: Optional[str]`

  - `next_bill_date: Optional[datetime]`

  - `payment_address: Optional[str]`

  - `payment_address2: Optional[str]`

  - `payment_city: Optional[str]`

  - `payment_country: Optional[str]`

  - `payment_email: Optional[str]`

  - `payment_first_name: Optional[str]`

  - `payment_gateway: Optional[str]`

  - `payment_last_name: Optional[str]`

  - `payment_nonce: Optional[str]`

  - `payment_state: Optional[str]`

  - `payment_zipcode: Optional[str]`

  - `primary_email: Optional[str]`

  - `state: Optional[str]`

  - `tax_id_type: Optional[str]`

  - `telephone: Optional[str]`

  - `use_legacy: Optional[bool]`

  - `validation_code: Optional[str]`

  - `vat: Optional[str]`

  - `zipcode: Optional[str]`