Skip to main content
GET
https://api.bouncy.ai
/
v1
/
account
/
profile
curl https://api.bouncy.ai/v1/account/profile \
  -H "X-Api-Key: bcy_live_pk_YOUR_API_KEY"
{
  "email": "[email protected]",
  "displayName": "John Doe",
  "plan": "growth",
  "planStatus": "active",
  "currentLinks": 245,
  "maxLinks": 1000,
  "customDomains": [
    {
      "domain": "go.example.com",
      "verified": true,
      "isDefault": true
    },
    {
      "domain": "link.example.com",
      "verified": false,
      "isDefault": false
    }
  ],
  "createdAt": "2025-06-15T10:00:00Z"
}

Request

Headers

X-Api-Key
string
required
Your API key (e.g., bcy_live_pk_YOUR_API_KEY)

Response

email
string
Your account email address
displayName
string
Your display name
plan
string
Your current subscription planOptions: free, solo, growth, scaling, dominance
planStatus
string
Subscription statusOptions: active, past_due, canceled, trialing
Number of links currently in your account
Maximum links allowed on your plan
customDomains
array
List of your custom domains
createdAt
string
ISO 8601 timestamp of account creation
curl https://api.bouncy.ai/v1/account/profile \
  -H "X-Api-Key: bcy_live_pk_YOUR_API_KEY"
{
  "email": "[email protected]",
  "displayName": "John Doe",
  "plan": "growth",
  "planStatus": "active",
  "currentLinks": 245,
  "maxLinks": 1000,
  "customDomains": [
    {
      "domain": "go.example.com",
      "verified": true,
      "isDefault": true
    },
    {
      "domain": "link.example.com",
      "verified": false,
      "isDefault": false
    }
  ],
  "createdAt": "2025-06-15T10:00:00Z"
}