Update Brand

PATCH

brands

{id}

JavaScript

import DodoPayments from 'dodopayments';

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

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

console.log(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.Update(
    context.TODO(),
    "id",
    dodopayments.BrandUpdateParams{

    },
  )
  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.BrandUpdateParams;

public final class Main {
    private Main() {}

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

        Brand brand = client.brands().update("id");
    }
}

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.BrandUpdateParams

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

    val brand: Brand = client.brands().update("id")
}

require "dodopayments"

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

brand = dodo_payments.brands.update("id")

puts(brand)

curl --request PATCH \
  --url https://test.dodopayments.com/brands/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "statement_descriptor": "<string>",
  "support_email": "<string>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/brands/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'image_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'statement_descriptor' => '<string>',
    'support_email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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

string

required

Brand Id

Body

application/json

image_id

string<uuid> | null

The UUID you got back from the presigned‐upload call

name

string | null

statement_descriptor

string | null

support_email

string | null

Response

Updated 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

⌘I

JavaScript

import DodoPayments from 'dodopayments';

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

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

console.log(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.Update(
    context.TODO(),
    "id",
    dodopayments.BrandUpdateParams{

    },
  )
  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.BrandUpdateParams;

public final class Main {
    private Main() {}

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

        Brand brand = client.brands().update("id");
    }
}

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.BrandUpdateParams

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

    val brand: Brand = client.brands().update("id")
}

require "dodopayments"

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

brand = dodo_payments.brands.update("id")

puts(brand)

curl --request PATCH \
  --url https://test.dodopayments.com/brands/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "statement_descriptor": "<string>",
  "support_email": "<string>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/brands/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'image_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'statement_descriptor' => '<string>',
    'support_email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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>"
}

API Reference

Checkout Sessions

Payments

Subscriptions

Discounts

Licenses

Customers

Customer Wallets

Products

Addons

Meters

Usage Events

Refunds

Disputes

Payouts

Brands

Webhooks

Miscellaneous

Authorizations

Path Parameters

Body

Response