Account · Docs

GET /v1/account describes the key's own account: its type, payment method, payout setup, fees, and how many brands and creators it has.

No paymentMethod means programs and payments return 409 requirement_payment_method; finish it in an onboarding embed.
PATCH /v1/account sets the logo (profilePicture), and a partner's take rates.

Endpoints

GET/v1/account

read

Get the key's own account

SDKlucra.account.retrieve()

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

PATCH/v1/account

write

Update the key's own account

SDKlucra.account.update({ body })

Body

creatorTakeRateobjectnullable
The partner's cut of each payment to a creator it brought, taken from the creator's side. Up to 20%.
Show 1 child fieldHide child fields
- percentnumberrequired
brandFeeobjectnullable
Show 2 child fieldsHide child fields
- ofenumrequired
  ad_spendgmv
- percentnumberrequired
profilePicturefile_…nullable
namestring
descriptionstringnullable
recruitmentobject
Show 2 child fieldsHide child fields
- headlinestringnullable
- descriptionstringnullable
typeenum
brandpartner
listingobject
Show 3 child fieldsHide child fields
- listedboolean
- headlinestringnullable
- categoriesstring[]
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