Skip to main content
GET
cURL
The GET /trials/free_tier endpoint returns the free tier credits on your Bright Data account: whether the free tier is enabled and how many credits are included, used and left. The values match the Free credits card on the Billing overview page in the Control Panel.
Paste your API key into the authorization field. To get an API key, create an account and learn how to generate an API key.

How do I check my free tier credits?

Call GET /trials/free_tier with your API key. The endpoint takes no parameters:
The response is a JSON object with four fields:
To print only the credits left, filter the response with jq:

How is the response structured?

The response always contains the same four fields with the same types: When is_enabled is false, included_credits, used_credits and left_credits are all 0.

How do I tell if my free tier credits are used up?

Check both is_enabled and left_credits. A response with is_enabled: true and left_credits: 0 means the free tier is active but this month’s credits are used up. Free credits renew on the first of each month, as described in What happens when free credits run out?. A response with is_enabled: false means the free tier is not enabled on your account, and all three *_credits fields are 0.

What is the rate limit for GET /trials/free_tier?

GET /trials/free_tier allows 600 requests per minute and 36,000 requests per hour per IP address. When you exceed the limit, Bright Data slows down incoming requests instead of blocking them.

Does GET /trials/free_tier return specific errors?

No. GET /trials/free_tier has no endpoint-specific error codes.
  • Free tier. Which products the 5,000 monthly free credits cover and how each product consumes them.
  • Total balance. Account balance, credit, prepayment and pending usage costs.
  • Cost breakdown export. Per-day account cost by product, zone, dataset or scraper.

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

is_enabled
boolean
required

true if the free tier is enabled on your account, including when all credits are used. When false, every *_credits field is 0.

Example:

true

included_credits
number
required

Free credits included in the current period.

Example:

5000

used_credits
number
required

Free credits used in the current period.

Example:

3

left_credits
number
required

Free credits left in the current period.

Example:

4997