Referral Program
Private Referral Program API endpoints
Partially update the shop's referral program: send only the keys you want to change; every other value stays as it is. An empty body {} returns the program as it is. A request either saves every value it sends or none of them.
Request body
enabledoptionalbooleanWhether the referral program is on.
referrer_creditoptionalintegerCredit added to the referrer's balance for each new customer who buys through their referral link, in minor units of the shop's base currency.
referee_creditoptionalintegerCredit the new customer gets on their first purchase through a referral link, in minor units of the shop's base currency.
ReturnsReferralProgram
Referral program object response
Error responses
422objectValidation failed: a value has the wrong type, null was sent, a credit is not a whole number from 0 to 9999999, or enabled is true while the program is off and the shop's Subbly plan doesn't include the referral program.