Call this API to retrieve details for all the Brands you are partnered with via Button. The fields returned are as follows:

Field	Type	Description
`id`	string	Button Organization ID for the Brand; this value will never change for a given Brand
`name`	string	Brand's name
`is_live_ready`	bool	The partnership has been fully configured by Button and is eligible to receive traffic from end users
`description`	string	Brand's description
`urls.homepage`	string	Brand's Homepage URL
`icon_url`	string	Brand's icon URL
`apps`	array	An array of all apps supported by the Brand with `os` and `scheme` keys.
`supported_hostnames`	array	An array of all hostnames associated with the Brand that are optimized by Button.
`subdomain`	string	The `.bttn.io` subdomain that the Brand uses for links, or `null` if not used.
`terms_and_conditions.reporting_window_days`	int	Brand's order reporting delay, in days
`terms_and_conditions.finalization_window_minutes`	int	Brand's expected order adjustment period, in minutes. Note: Finalization windows are evaluated at the transaction level and are mutable.
`terms_and_conditions.coupons_allowed`	bool	Whether the Brand will commission if a coupon is present on the order
`terms_and_conditions.gift_cards_allowed`	bool	Whether the Brand will commission on the purchase of gift cards
`terms_and_conditions.exclusion_details`	string	Brand's list of items exclusions (i.e. will not generate a commission)
`terms_and_conditions.other_terms`	string	Other program terms

FAQs

Q: When should Publishers use this API? Ad-hoc? As part of their Brand onboarding flow?
A: Either/or – this API is meant to deliver static Brand details, and thus can be called ad-hoc when a Publisher needs to retrieve static Brand details (e.g. when onboarding a Brand).

Q: Can Publishers use this API as part of their flow of routing a user to a Brand?
A: No – this API should not be in the critical path of routing a user to a Brand. In other words, the purpose of this API is for Publishers to fetch Brand metadata that does not change frequently, and should not require calling it in real-time.

200200

400400

401401

404404