promo

Redeem Promo

Redeem a promo code and add the granted operations to the authenticated user's account.

B2C only: web app login tokens and sk_ user API keys are accepted; lce_ org keys are rejected. Requires a verified email. Each user may redeem a given code at most once.

Rate-limited to 3 attempts per IP per hour. All attempts (success and failure) are logged for audit.

post/v1/promo/redeem

Request

  • Base URL: https://api.superdocs.app
  • URL: https://api.superdocs.app/v1/promo/redeem
  • Auth: HTTP bearer

Headers

authorizationstring nullable

Request body

codestring required

The promo code (case-insensitive).

Response

Successful Response

statusstring

Always 'redeemed' on success.

messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.