Update Referral Program
Update a referral program. Omitted fields keep their current value.
Body Parameters
Response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
The ID of the referral program.
1The ID of the reward granted when a code is redeemed.
1When the reward is granted: on redemption, or when the redeemer checks out.
customer_creation, checkout Who receives the reward: the referrer only, or both parties.
referrer, all A positive redemption limit.
-9007199254740991 < x <= 9007199254740991Required when redeem_on is checkout. Plan IDs must be unique.
1Response
OK
The unique identifier for the referral program.
The ID of the reward granted when a code is redeemed.
When the reward is granted: on redemption, or when the redeemer checks out.
customer_creation, checkout Who receives the reward: the referrer only, or both parties.
referrer, all The Unix timestamp (in milliseconds) when the referral program was created.
The maximum number of times a referral code can be redeemed.
The plans whose checkout triggers the reward. Only used when redeem_on is checkout.
Whether checkouts that start a trial should skip granting the reward.