Pular para o conteúdo principal
GET
/
brands
/
{id}
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

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

console.log(brand.brand_id);
import os
from dodopayments import DodoPayments

client = DodoPayments(
bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted
)
brand = client.brands.retrieve(
"brnd_8dFiAW42v28JzhlVSocjq",
)
print(brand.brand_id)
package main

import (
"context"
"fmt"

"github.com/dodopayments/dodopayments-go"
"github.com/dodopayments/dodopayments-go/option"
)

func main() {
client := dodopayments.NewClient(
option.WithBearerToken("My Bearer Token"),
)
brand, err := client.Brands.Get(context.TODO(), "brnd_8dFiAW42v28JzhlVSocjq")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", brand.BrandID)
}
package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.brands.Brand;
import com.dodopayments.api.models.brands.BrandRetrieveParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

Brand brand = client.brands().retrieve("brnd_8dFiAW42v28JzhlVSocjq");
}
}
package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.brands.Brand
import com.dodopayments.api.models.brands.BrandRetrieveParams

fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

val brand: Brand = client.brands().retrieve("brnd_8dFiAW42v28JzhlVSocjq")
}
require "dodopayments"

dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)

brand = dodo_payments.brands.retrieve("brnd_8dFiAW42v28JzhlVSocjq")

puts(brand)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
environment: 'test_mode',
);

try {
$brand = $client->brands->retrieve('brnd_8dFiAW42v28JzhlVSocjq');

var_dump($brand);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Brands;

DodoPaymentsClient client = new();

BrandRetrieveParams parameters = new() { ID = "brnd_8dFiAW42v28JzhlVSocjq" };

var brand = await client.Brands.Retrieve(parameters);

Console.WriteLine(brand);
use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let id = "id";
let result = client
.brands()
.retrieve()
.id(id)
.await?;
println!("{result:?}");
Ok(())
}
curl --request GET \
--url https://test.dodopayments.com/brands/{id} \
--header 'Authorization: Bearer <token>'
{
  "brand_id": "<string>",
  "business_id": "<string>",
  "enabled": true,
  "statement_descriptor": "<string>",
  "verification_enabled": true,
  "description": "<string>",
  "image": "<string>",
  "name": "<string>",
  "reason_for_hold": "<string>",
  "support_email": "<string>",
  "url": "<string>"
}

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
string
obrigatório

Brand Id

Resposta

Get a single brand

brand_id
string
obrigatório
business_id
string
obrigatório
enabled
boolean
obrigatório
statement_descriptor
string
obrigatório
verification_enabled
boolean
obrigatório
verification_status
enum<string>
obrigatório
Opções disponíveis:
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
Última modificação em 1 de abril de 2026