Skip to main content
GET
cURL
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.
Paste your API key into the authorization field. To get an API key, create an account and learn how to generate an API key.

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 have it. Without it, the endpoint returns HTTP 403 with a plain-text message. Manage API key permissions in Account settings.

How do I check whether auto-recharge is on?

Call GET /billing/autorecharge. The endpoint takes no parameters:
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: 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?.

What does the dataset section return?

The dataset object holds the dataset auto-recharge settings: 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.

Authorizations

Authorization
string
header
required

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:

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

Response

Auto-recharge settings

regular
object
required
dataset
object
required
suspended
boolean
required

true when auto-recharge is suspended for the account.