Skip to main content
GET
cURL
The GET /billing/pmethods endpoint returns the active, confirmed payment methods on your Bright Data account. Use the id of a payment method to turn on auto-recharge with Set regular auto-recharge or Set dataset auto-recharge.
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/pmethods 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 list my payment methods?

Call GET /billing/pmethods. The endpoint takes no parameters:
The response contains a pmethods array with one entry per payment method.

How is the response structured?

Each entry in the pmethods array describes one payment method:

Which payment method can I use for auto-recharge?

Use a payment method where autorecharge_supported is true. To print only those payment methods, filter the response with jq:
The auto-recharge endpoints reject a payment method that does not support auto-recharge with HTTP 400 and error_code pmethod_not_supported.

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

Payment methods

pmethods
object[]
required