referral

Redeem Code

Redeem a referral code. Called by a new user during or after trial start (or auto-fired by the Stripe customer.subscription.created webhook via _redeem_referral_for_user).

Rules:

  • Code must exist and have redeemed_at IS NULL (the template row)
  • Referrer cannot redeem their own code
  • Each user can only redeem one code ever
  • If referrer already has 30 bonus days, mark as redeemed but do not extend Stripe trial
post/api/referral/redeem

Request

  • Base URL: https://api.equity-rank.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.equity-rank.com/api/referral/redeem
  • Auth: HTTP bearer

Request body

codestring required

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 2 revisions of this API.