> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get auto-recharge settings

> Use GET /billing/autorecharge in the Bright Data Account Management API to read regular and dataset auto-recharge settings: amount, threshold and limits.

The `GET /billing/autorecharge` endpoint returns the auto-recharge settings of your Bright Data account: the `regular` section, the `dataset` section and whether auto-recharge is `suspended` for the account.

> [!TIP]
>
> Paste your API key into the authorization field. To get an API key, [create an account](https://brightdata.com/?hs_signup=1\&utm_source=docs\&utm_campaign=playground) and learn [how to generate an API key](https://docs.brightdata.com/api-reference/authentication.md#how-do-i-generate-a-new-api-key%3F).

## Which API key permission does this endpoint need?

`GET /billing/autorecharge` requires the `billing.read` permission. API keys with the **Admin** or **Finance** [permission level](https://docs.brightdata.com/api-reference/authentication.md#what-permissions-level-does-an-api-key-have) have it. Without it, the endpoint returns HTTP 403 with a plain-text message. Manage API key permissions in [Account settings](https://brightdata.com/cp/setting/users).

## How do I check whether auto-recharge is on?

Call `GET /billing/autorecharge`. The endpoint takes no parameters:

```bash theme={null}
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.brightdata.com/billing/autorecharge"
```

Regular auto-recharge is on when `regular.enabled` is `true`. Dataset auto-recharge is on when `dataset.enabled` is `true`. When `suspended` is `true`, auto-recharge is suspended for the whole account.

## What does the regular section return?

The `regular` object holds the regular auto-recharge settings:

| Field | Type | Description |
| - | - | - |
| `available` | boolean | `true` when regular auto-recharge is available for the account and the account has a payment method that supports auto-recharge |
| `enabled` | boolean | `true` when regular auto-recharge is on |
| `pmethod_id` | string or null | Payment method charged by auto-recharge. `null` when disabled |
| `amount` | integer or null | Charge amount in USD. `null` when disabled |
| `threshold` | number or null | Balance level for a charge. A charge starts when the available balance drops below ceil(`amount` / 4). `null` when disabled |
| `limits.min_amount` | integer | Minimum `amount`, in USD. \$50 for all accounts |
| `limits.max_amount` | integer | Maximum `amount`, in USD. Depends on the company type and can be changed per account |

For example, with `amount` set to 200, a charge starts when the available balance drops below \$50. To learn how much each charge is, see [How much does regular auto-recharge charge?](https://docs.brightdata.com/api-reference/account-management-api/Set_regular_auto_recharge.md#how-much-does-regular-auto-recharge-charge%3F).

## What does the dataset section return?

The `dataset` object holds the dataset auto-recharge settings:

| Field | Type | Description |
| - | - | - |
| `available` | boolean | `true` when regular auto-recharge is available and the account has a dataset zone |
| `enabled` | boolean | `true` when dataset auto-recharge is on |
| `pmethod_id` | string or null | Payment method charged by dataset auto-recharge. `null` when disabled |

Dataset auto-recharge charges only when a dataset snapshot build starts and the balance cannot cover the snapshot cost. Regular and dataset auto-recharge are set separately, so turning one off does not change the other.

## Why is auto-recharge not available on my account?

`regular.available` is `false` when one of these is true:

* The account is an AWS Marketplace organic account
* The account is an IBM account
* The account has no payment method that supports auto-recharge, or all such payment methods are blocked

`dataset.available` is also `false` when the account has no dataset zone. Turning auto-recharge off works even when `available` is `false`.

## What are the rate limits for the billing endpoints?

The billing endpoints allow 1,000 requests per minute and 5,000 requests per hour. Over the limit, the endpoint returns HTTP 429 with a plain-text body.

## Related endpoints

* [Set regular auto-recharge](https://docs.brightdata.com/api-reference/account-management-api/Set_regular_auto_recharge.md). Turn regular auto-recharge on or off, or change its amount.
* [Set dataset auto-recharge](https://docs.brightdata.com/api-reference/account-management-api/Set_dataset_auto_recharge.md). Turn dataset auto-recharge on or off.
* [Get payment methods](https://docs.brightdata.com/api-reference/account-management-api/Get_payment_methods.md). Payment method IDs and auto-recharge support.


## OpenAPI

````yaml api-reference/openapi GET /billing/autorecharge
openapi: 3.0.1
info:
  title: Bright Data API
  description: >-
    Integrate Bright Data APIs to your pipeline and secure high-end scraping
    precision
  version: 1.0.0
servers:
  - url: https://api.brightdata.com
security:
  - bearerAuth: []
paths:
  /billing/autorecharge:
    get:
      description: >-
        Get the regular and dataset auto-recharge settings of your account.
        Requires the `billing.read` permission.
      operationId: getAutoRecharge
      responses:
        '200':
          description: Auto-recharge settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingAutoRecharge'
        '401':
          description: Authentication failed
          content:
            text/plain:
              schema:
                type: string
              example: User authentication is required
        '403':
          description: The API key lacks the required permission
          content:
            text/plain:
              schema:
                type: string
              example: >-
                Your API key lacks the required permissions for this action. You
                can change your token permissions at
                https://brightdata.com/cp/setting/users
        '429':
          description: Rate limit exceeded (1,000 requests per minute, 5,000 per hour)
          content:
            text/plain:
              schema:
                type: string
components:
  schemas:
    BillingAutoRecharge:
      type: object
      required:
        - regular
        - dataset
        - suspended
      properties:
        regular:
          $ref: '#/components/schemas/BillingAutoRechargeRegular'
        dataset:
          $ref: '#/components/schemas/BillingAutoRechargeDataset'
        suspended:
          type: boolean
          description: '`true` when auto-recharge is suspended for the account.'
    BillingAutoRechargeRegular:
      type: object
      required:
        - available
        - enabled
        - pmethod_id
        - amount
        - threshold
        - limits
      properties:
        available:
          type: boolean
          description: >-
            `true` when regular auto-recharge is available for the account and
            the account has a payment method that supports auto-recharge.
            `false` for AWS Marketplace organic accounts, IBM accounts and
            accounts with no payment method that supports auto-recharge or with
            all such payment methods blocked.
        enabled:
          type: boolean
          description: '`true` when auto-recharge is enabled for this section.'
        pmethod_id:
          type: string
          nullable: true
          description: Payment method used for auto-recharge. `null` if disabled.
        amount:
          type: integer
          nullable: true
          description: Charge amount, in USD. `null` if disabled.
        threshold:
          type: number
          nullable: true
          readOnly: true
          description: >-
            Balance level that starts a charge: a charge starts when the
            available balance drops below ceil(`amount` / 4). `null` if
            disabled. Read-only.
        limits:
          type: object
          description: Amount limits of the account.
          required:
            - min_amount
            - max_amount
          properties:
            min_amount:
              type: integer
              description: Minimum amount, in USD. $50 for all accounts.
            max_amount:
              type: integer
              description: >-
                Maximum amount, in USD. Depends on the company type and can be
                changed per account.
    BillingAutoRechargeDataset:
      type: object
      required:
        - available
        - enabled
        - pmethod_id
      properties:
        available:
          type: boolean
          description: >-
            `true` when regular auto-recharge is available and the account has a
            dataset zone.
        enabled:
          type: boolean
          description: '`true` when auto-recharge is enabled for this section.'
        pmethod_id:
          type: string
          nullable: true
          description: Payment method used for auto-recharge. `null` if disabled.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use your Bright Data API Key as a Bearer token in the Authorization
        header.


        **How to authenticate:**

        1. Obtain your API Key from the Bright Data account settings at
        https://brightdata.com/cp/setting/users

        2. Include the API Key in the Authorization header of your requests

        3. Format: `Authorization: Bearer YOUR_API_KEY`


        **Example:**

        ```

        Authorization: Bearer
        b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

        ```


        Learn how to get your Bright Data API key:
        https://docs.brightdata.com/api-reference/authentication
      bearerFormat: API Key

````