Skip to main content
GET
cURL
The GET /customer/balance endpoint returns your Bright Data account balance information: balance, credit, prepayment and pending_costs.
Paste your API key to the authorization field. To get an API key, Create an account and learn how to generate an API key

FAQ

Is there an API endpoint for free-tier credit status?

No. No Account Management API endpoint returns your free-tier credit allowance, credits used, credits remaining or renewal date. To track free credits, check the Free credits card on the Billing overview page in the Control Panel, as described in How do I monitor my free credit usage?. To pull usage data through the API, use the Cost breakdown export endpoint.

Is there an API endpoint for auto-recharge status?

No. No Account Management API endpoint returns whether auto-recharge is enabled. Check and configure auto-recharge in Billing settings in the Control Panel. Auto-recharge requires a verified payment method on the account.

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

200 - application/json

OK

balance
number

Current available funds in your account, in USD.

Example:

220

credit
number

Credit on your account, in USD.

Example:

0

prepayment
number

Prepayment, in USD. Applies to custom plans with a monthly prepayment commitment.

Example:

0

pending_costs
number

Current usage costs expected on next month's invoice, in USD.

Example:

0