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
paymentMethodmeans programs and payments return409 requirement_payment_method; send a brand member to the URL fromPOST /v1/connectionswithprovider: "card". PATCH /v1/accountsets the logo (profilePicture), and a partner's take rates.
Endpoints
/v1/accountGet the key's own account
lucra.account.retrieve()Response20022 fieldsShow
idacct_…typeenumbrandpartnernamestringstatusenumended: a brand whose relationship with your partner account ended; it reads, but no longer changes.
activeendedmanagedByacct_…nullablebrandFeeobjectnullableThe managing partner's fee on this brand; null when none is set.
Show 2 child fieldsHide child fields
ofenumad_spendgmvpercentnumber
partnerobjectnullableA partner's take rates; null for a brand.
Show 2 child fieldsHide child fields
creatorTakeRateobjectnullableShow 1 child fieldHide child fields
percentnumber
brandFeeobjectnullableShow 2 child fieldsHide child fields
ofenumad_spendgmvpercentnumber
emailstringnullablephonestringnullableprofilePicturefile_…nullableimageobjectnullableThe account's logo, with a short-lived `url`.
Show 5 child fieldsHide child fields
fileIdfile_…nullableurlstringwidthnumbernullableheightnumbernullableblurHashstringnullable
paymentMethodobjectnullableA brand's payment method; null means none yet (add one with POST /v1/connections, provider card), and always null for a partner.
Show 3 child fieldsHide child fields
statusstringactivebrandstringnullablelast4stringnullable
payoutsobjectWhere 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/connections (provider stripe).
Show 2 child fieldsHide child fields
identityobjectShow 1 child fieldHide child fields
statusenumrequiredpendingverified
bankAccountobjectnullableShow 1 child fieldHide child fields
statusenummissingadded
platformFeeobjectLucra'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
percentnumbersourceenumdefaultaccountversionstring
brandsobjectnullableThe brands a partner key reaches; null on a managed brand.
Show 1 child fieldHide child fields
countinteger
creatorsobjectnullableThe account's creators and roster; null on a managed brand.
Show 1 child fieldHide child fields
countinteger
descriptionstringnullablerecruitmentobjectShow 2 child fieldsHide child fields
headlinestringnullabledescriptionstringnullable
listingobjectnullableA partner's marketplace listing; null for a brand.
Show 4 child fieldsHide child fields
listedbooleanheadlinestringnullablecategoriesstring[]registeredAtstringnullable
versionintegercreatedAtstringupdatedAtstring
/v1/accountUpdate the key's own account
lucra.account.update({ body })Body
creatorTakeRateobjectnullableThe 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
brandFeeobjectnullableShow 2 child fieldsHide child fields
ofenumrequiredad_spendgmvpercentnumberrequired
profilePicturefile_…nullablenamestringdescriptionstringnullablerecruitmentobjectShow 2 child fieldsHide child fields
headlinestringnullabledescriptionstringnullable
typeenumbrandpartnerlistingobjectShow 3 child fieldsHide child fields
listedbooleanheadlinestringnullablecategoriesstring[]
versioninteger
Response20022 fieldsShow
idacct_…typeenumbrandpartnernamestringstatusenumended: a brand whose relationship with your partner account ended; it reads, but no longer changes.
activeendedmanagedByacct_…nullablebrandFeeobjectnullableThe managing partner's fee on this brand; null when none is set.
Show 2 child fieldsHide child fields
ofenumad_spendgmvpercentnumber
partnerobjectnullableA partner's take rates; null for a brand.
Show 2 child fieldsHide child fields
creatorTakeRateobjectnullableShow 1 child fieldHide child fields
percentnumber
brandFeeobjectnullableShow 2 child fieldsHide child fields
ofenumad_spendgmvpercentnumber
emailstringnullablephonestringnullableprofilePicturefile_…nullableimageobjectnullableThe account's logo, with a short-lived `url`.
Show 5 child fieldsHide child fields
fileIdfile_…nullableurlstringwidthnumbernullableheightnumbernullableblurHashstringnullable
paymentMethodobjectnullableA brand's payment method; null means none yet (add one with POST /v1/connections, provider card), and always null for a partner.
Show 3 child fieldsHide child fields
statusstringactivebrandstringnullablelast4stringnullable
payoutsobjectWhere 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/connections (provider stripe).
Show 2 child fieldsHide child fields
identityobjectShow 1 child fieldHide child fields
statusenumrequiredpendingverified
bankAccountobjectnullableShow 1 child fieldHide child fields
statusenummissingadded
platformFeeobjectLucra'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
percentnumbersourceenumdefaultaccountversionstring
brandsobjectnullableThe brands a partner key reaches; null on a managed brand.
Show 1 child fieldHide child fields
countinteger
creatorsobjectnullableThe account's creators and roster; null on a managed brand.
Show 1 child fieldHide child fields
countinteger
descriptionstringnullablerecruitmentobjectShow 2 child fieldsHide child fields
headlinestringnullabledescriptionstringnullable
listingobjectnullableA partner's marketplace listing; null for a brand.
Show 4 child fieldsHide child fields
listedbooleanheadlinestringnullablecategoriesstring[]registeredAtstringnullable
versionintegercreatedAtstringupdatedAtstring