Zum Hauptinhalt springen
POST
JavaScript

Autorisierungen

Authorization
string
header
erforderlich

Send your API key as a bearer token: Authorization: Bearer <api_key>. A test mode key starts with dodo_test_, for example dodo_test_AbCd1234EfGh5678.<secret>. A live mode key starts with dodo_live_. Use a test mode key on test.dodopayments.com and a live mode key on live.dodopayments.com. Keys from before these tags have no tag and operate as before.

Pfadparameter

id
string
erforderlich

Brand Id

Body

application/json
move_products_to
string | null

Brand that takes over the products and the live subscriptions of the brand you archive. It must be a brand of the same business, and it must not be archived. The primary brand (its brand id is the business id) is a valid target. Omit this field only when the brand holds no products and no live subscriptions.

Antwort

Archived Brand

archived_at
string<date-time>
erforderlich

Time the brand was archived.

brand_id
string
erforderlich

The archived brand.

collections_moved
integer<int64>
erforderlich

Count of product collections moved to the target brand.

Erforderlicher Bereich: x >= 0
products_moved
integer<int64>
erforderlich

Count of products moved to the target brand.

Erforderlicher Bereich: x >= 0
subscriptions_moved
integer<int64>
erforderlich

Count of live subscriptions moved to the target brand.

Erforderlicher Bereich: x >= 0
moved_to_brand_id
string | null

Brand that received the moved records. Null when no target was given.

Zuletzt geändert am 21. August 2026