Get Trial Eligibility

const options = {method: 'GET', headers: {'X-Browser-Use-API-Key': '<api-key>'}};

fetch('https://api.browser-use.com/api/v3/boxes/me/trial-eligibility', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://api.browser-use.com/api/v3/boxes/me/trial-eligibility \
  --header 'X-Browser-Use-API-Key: <api-key>'

import requests

url = "https://api.browser-use.com/api/v3/boxes/me/trial-eligibility"

headers = {"X-Browser-Use-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "eligible": true,
  "message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Boxes

Get Trial Eligibility

Tell the FE whether to render a ‘try free for 7 days’ CTA.

Account-scoped — any user (free-tier or paid) without a prior bux_trial_started_at stamp is eligible for one free 7-day trial.

Returns a tagged answer:

eligible=True → show the trial CTA on the empty-state.
eligible=False, reason=‘already_used’ → show “trial used, upgrade to deploy”.
eligible=False, reason=‘no_owner’ → fallback for older projects we can’t resolve an owner for; FE shows generic “add credits”.

Cheap call: one profile lookup. The FE polls /me + /sizes already, this is one more cheap GET on the deploy page.

GET

boxes

trial-eligibility

Get Trial Eligibility

const options = {method: 'GET', headers: {'X-Browser-Use-API-Key': '<api-key>'}};

fetch('https://api.browser-use.com/api/v3/boxes/me/trial-eligibility', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://api.browser-use.com/api/v3/boxes/me/trial-eligibility \
  --header 'X-Browser-Use-API-Key: <api-key>'

import requests

url = "https://api.browser-use.com/api/v3/boxes/me/trial-eligibility"

headers = {"X-Browser-Use-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "eligible": true,
  "message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-Browser-Use-API-Key

string

header

required

Response

Successful Response

GET /me/trial-eligibility — is this user eligible for a free trial?

Account-scoped — paid users see this too (one free trial per user, regardless of payment tier).

reason is a stable machine-readable code the FE branches on:

'already_used' — user has already started a trial in their lifetime. Render an "upgrade to deploy" CTA.
'no_owner' — couldn't resolve the project's owner profile (rare, older projects). FE falls back to generic "add credits" copy.
None when eligible=True.

eligible

boolean

required

reason

enum<string> | null

Available options:

already_used,

no_owner

message

string | null

List Box Sizes

Provision Box

⌘I

Overview

Legacy guides & tutorials

Legacy references

Get Trial Eligibility

Authorizations

Response