Brands · Docs

A partner lists the brands it manages with GET /v1/brands, and acts for one with Lucra-Account. A brand key gets an empty list.

Provision

An approved partner creates a brand with POST /v1/brands. Send an Idempotency-Key.

JSON

{
  "name": "Acme",
  "email": "ops@acme.com",
  "brandFee": { "of": "ad_spend", "percent": 10 }
}

The brand pays for its own programs: until it adds a payment method in an onboarding embed, those writes return 409 requirement_payment_method.

Logo and fee

PATCH /v1/brands/:id sets its profilePicture and brandFee. A new fee applies to spend from now on.

Endpoints

GET/v1/brands

read

List the brands this key reaches, and a partner's brands whose relationship ended

SDKlucra.brands.list({ query })

Query parameters

limitinteger
cursorstring
createdAfterstring
Only items created at or after this time.
createdBeforestring
Only items created before this time.
statusenum
activeended

Response200A page of items, 22 fields each, and nextCursorShow

idacct_…
typeenum
brandpartner
namestring
statusenum
ended: a brand whose relationship with your partner account ended; it reads, but no longer changes.
activeended
managedByacct_…nullable
brandFeeobjectnullable
The managing partner's fee on this brand; null when none is set.
Show 2 child fieldsHide child fields
- ofenum
  ad_spendgmv
- percentnumber
partnerobjectnullable
A partner's approval and take rates; null for a brand.
Show 3 child fieldsHide child fields
- approvedboolean
- creatorTakeRateobjectnullable
  Show 1 child fieldHide child fields
  percentnumber
- brandFeeobjectnullable
  Show 2 child fieldsHide child fields
  ofenum
  ad_spendgmv
  percentnumber
emailstringnullable
phonestringnullable
profilePicturefile_…nullable
imageobjectnullable
The account's logo, with a short-lived `url`.
Show 5 child fieldsHide child fields
- fileIdfile_…nullable
- urlstring
- widthnumbernullable
- heightnumbernullable
- blurHashstringnullable
paymentMethodobjectnullable
A brand's payment method; null means none yet (open one with POST /v1/account-links), and always null for a partner.
Show 3 child fieldsHide child fields
- statusstring
  active
- brandstringnullable
- last4stringnullable
payoutsobject
Where it's paid: verified identity lets earnings reach its balance; a bank account is asked for on the first withdrawal. Set up with POST /v1/account-links.
Show 2 child fieldsHide child fields
- identityobject
  Show 1 child fieldHide child fields
  statusenum
  requiredpendingverified
- bankAccountobjectnullable
  Show 1 child fieldHide child fields
  statusenum
  missingadded
platformFeeobject
Lucra's fee on ad spend for programs created now; a program keeps the terms current when it was created.
Show 3 child fieldsHide child fields
- percentnumber
- sourceenum
  defaultaccount
- versionstring
brandsobjectnullable
The brands a partner key reaches; null on a managed brand.
Show 1 child fieldHide child fields
- countinteger
creatorsobjectnullable
The account's creators and roster; null on a managed brand.
Show 1 child fieldHide child fields
- countinteger
descriptionstringnullable
recruitmentobject
Show 2 child fieldsHide child fields
- headlinestringnullable
- descriptionstringnullable
listingobjectnullable
A partner's marketplace listing; null for a brand.
Show 4 child fieldsHide child fields
- listedboolean
- headlinestringnullable
- categoriesstring[]
- registeredAtstringnullable
versioninteger
createdAtstring
updatedAtstring

GET/v1/brands/:id

read

Get a brand

SDKlucra.brands.retrieve({ path: { id } })

Path parameters

idstringrequired

Response20022 fieldsShow

idacct_…
typeenum
brandpartner
namestring
statusenum
ended: a brand whose relationship with your partner account ended; it reads, but no longer changes.
activeended
managedByacct_…nullable
brandFeeobjectnullable
The managing partner's fee on this brand; null when none is set.
Show 2 child fieldsHide child fields
- ofenum
  ad_spendgmv
- percentnumber
partnerobjectnullable
A partner's approval and take rates; null for a brand.
Show 3 child fieldsHide child fields
- approvedboolean
- creatorTakeRateobjectnullable
  Show 1 child fieldHide child fields
  percentnumber
- brandFeeobjectnullable
  Show 2 child fieldsHide child fields
  ofenum
  ad_spendgmv
  percentnumber
emailstringnullable
phonestringnullable
profilePicturefile_…nullable
imageobjectnullable
The account's logo, with a short-lived `url`.
Show 5 child fieldsHide child fields
- fileIdfile_…nullable
- urlstring
- widthnumbernullable
- heightnumbernullable
- blurHashstringnullable
paymentMethodobjectnullable
A brand's payment method; null means none yet (open one with POST /v1/account-links), and always null for a partner.
Show 3 child fieldsHide child fields
- statusstring
  active
- brandstringnullable
- last4stringnullable
payoutsobject
Where it's paid: verified identity lets earnings reach its balance; a bank account is asked for on the first withdrawal. Set up with POST /v1/account-links.
Show 2 child fieldsHide child fields
- identityobject
  Show 1 child fieldHide child fields
  statusenum
  requiredpendingverified
- bankAccountobjectnullable
  Show 1 child fieldHide child fields
  statusenum
  missingadded
platformFeeobject
Lucra's fee on ad spend for programs created now; a program keeps the terms current when it was created.
Show 3 child fieldsHide child fields
- percentnumber
- sourceenum
  defaultaccount
- versionstring
brandsobjectnullable
The brands a partner key reaches; null on a managed brand.
Show 1 child fieldHide child fields
- countinteger
creatorsobjectnullable
The account's creators and roster; null on a managed brand.
Show 1 child fieldHide child fields
- countinteger
descriptionstringnullable
recruitmentobject
Show 2 child fieldsHide child fields
- headlinestringnullable
- descriptionstringnullable
listingobjectnullable
A partner's marketplace listing; null for a brand.
Show 4 child fieldsHide child fields
- listedboolean
- headlinestringnullable
- categoriesstring[]
- registeredAtstringnullable
versioninteger
createdAtstring
updatedAtstring

POST/v1/brands

write

Create a brand a partner manages

SDKlucra.brands.create({ body })

Body

namestringrequired
brandFeeobject
Show 2 child fieldsHide child fields
- ofenumrequired
  ad_spendgmv
- percentnumberrequired
emailstring
phonestring

Response20122 fieldsShow

idacct_…
typeenum
brandpartner
namestring
statusenum
ended: a brand whose relationship with your partner account ended; it reads, but no longer changes.
activeended
managedByacct_…nullable
brandFeeobjectnullable
The managing partner's fee on this brand; null when none is set.
Show 2 child fieldsHide child fields
- ofenum
  ad_spendgmv
- percentnumber
partnerobjectnullable
A partner's approval and take rates; null for a brand.
Show 3 child fieldsHide child fields
- approvedboolean
- creatorTakeRateobjectnullable
  Show 1 child fieldHide child fields
  percentnumber
- brandFeeobjectnullable
  Show 2 child fieldsHide child fields
  ofenum
  ad_spendgmv
  percentnumber
emailstringnullable
phonestringnullable
profilePicturefile_…nullable
imageobjectnullable
The account's logo, with a short-lived `url`.
Show 5 child fieldsHide child fields
- fileIdfile_…nullable
- urlstring
- widthnumbernullable
- heightnumbernullable
- blurHashstringnullable
paymentMethodobjectnullable
A brand's payment method; null means none yet (open one with POST /v1/account-links), and always null for a partner.
Show 3 child fieldsHide child fields
- statusstring
  active
- brandstringnullable
- last4stringnullable
payoutsobject
Where it's paid: verified identity lets earnings reach its balance; a bank account is asked for on the first withdrawal. Set up with POST /v1/account-links.
Show 2 child fieldsHide child fields
- identityobject
  Show 1 child fieldHide child fields
  statusenum
  requiredpendingverified
- bankAccountobjectnullable
  Show 1 child fieldHide child fields
  statusenum
  missingadded
platformFeeobject
Lucra's fee on ad spend for programs created now; a program keeps the terms current when it was created.
Show 3 child fieldsHide child fields
- percentnumber
- sourceenum
  defaultaccount
- versionstring
brandsobjectnullable
The brands a partner key reaches; null on a managed brand.
Show 1 child fieldHide child fields
- countinteger
creatorsobjectnullable
The account's creators and roster; null on a managed brand.
Show 1 child fieldHide child fields
- countinteger
descriptionstringnullable
recruitmentobject
Show 2 child fieldsHide child fields
- headlinestringnullable
- descriptionstringnullable
listingobjectnullable
A partner's marketplace listing; null for a brand.
Show 4 child fieldsHide child fields
- listedboolean
- headlinestringnullable
- categoriesstring[]
- registeredAtstringnullable
versioninteger
createdAtstring
updatedAtstring

PATCH/v1/brands/:id

write

Update a brand a partner manages

SDKlucra.brands.update({ path: { id }, body })

Path parameters

idstringrequired

Body

brandFeeobjectnullable
Show 2 child fieldsHide child fields
- ofenumrequired
  ad_spendgmv
- percentnumberrequired
profilePicturefile_…nullable
namestring
descriptionstringnullable
recruitmentobject
Show 2 child fieldsHide child fields
- headlinestringnullable
- descriptionstringnullable
versioninteger

Response20022 fieldsShow

idacct_…
typeenum
brandpartner
namestring
statusenum
ended: a brand whose relationship with your partner account ended; it reads, but no longer changes.
activeended
managedByacct_…nullable
brandFeeobjectnullable
The managing partner's fee on this brand; null when none is set.
Show 2 child fieldsHide child fields
- ofenum
  ad_spendgmv
- percentnumber
partnerobjectnullable
A partner's approval and take rates; null for a brand.
Show 3 child fieldsHide child fields
- approvedboolean
- creatorTakeRateobjectnullable
  Show 1 child fieldHide child fields
  percentnumber
- brandFeeobjectnullable
  Show 2 child fieldsHide child fields
  ofenum
  ad_spendgmv
  percentnumber
emailstringnullable
phonestringnullable
profilePicturefile_…nullable
imageobjectnullable
The account's logo, with a short-lived `url`.
Show 5 child fieldsHide child fields
- fileIdfile_…nullable
- urlstring
- widthnumbernullable
- heightnumbernullable
- blurHashstringnullable
paymentMethodobjectnullable
A brand's payment method; null means none yet (open one with POST /v1/account-links), and always null for a partner.
Show 3 child fieldsHide child fields
- statusstring
  active
- brandstringnullable
- last4stringnullable
payoutsobject
Where it's paid: verified identity lets earnings reach its balance; a bank account is asked for on the first withdrawal. Set up with POST /v1/account-links.
Show 2 child fieldsHide child fields
- identityobject
  Show 1 child fieldHide child fields
  statusenum
  requiredpendingverified
- bankAccountobjectnullable
  Show 1 child fieldHide child fields
  statusenum
  missingadded
platformFeeobject
Lucra's fee on ad spend for programs created now; a program keeps the terms current when it was created.
Show 3 child fieldsHide child fields
- percentnumber
- sourceenum
  defaultaccount
- versionstring
brandsobjectnullable
The brands a partner key reaches; null on a managed brand.
Show 1 child fieldHide child fields
- countinteger
creatorsobjectnullable
The account's creators and roster; null on a managed brand.
Show 1 child fieldHide child fields
- countinteger
descriptionstringnullable
recruitmentobject
Show 2 child fieldsHide child fields
- headlinestringnullable
- descriptionstringnullable
listingobjectnullable
A partner's marketplace listing; null for a brand.
Show 4 child fieldsHide child fields
- listedboolean
- headlinestringnullable
- categoriesstring[]
- registeredAtstringnullable
versioninteger
createdAtstring
updatedAtstring