Skip to main content
GET
/
brands
/
{id}
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: 'My Bearer Token',
});

const brand = await client.brands.retrieve('id');

console.log(brand.brand_id);
{
  "brand_id": "<string>",
  "business_id": "<string>",
  "enabled": true,
  "statement_descriptor": "<string>",
  "verification_enabled": true,
  "verification_status": "Success",
  "description": "<string>",
  "image": "<string>",
  "name": "<string>",
  "reason_for_hold": "<string>",
  "support_email": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Brand Id

Response

Get a single brand

​
brand_id
string
required
​
business_id
string
required
​
enabled
boolean
required
​
statement_descriptor
string
required
​
verification_enabled
boolean
required
​
verification_status
enum<string>
required
Available options:
Success,
Fail,
Review,
Hold
​
description
string | null
​
image
string | null
​
name
string | null
​
reason_for_hold
string | null

Incase the brand verification fails or is put on hold

​
support_email
string | null
​
url
string | null