> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superdocs.app/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi.json post /v1/promo/redeem
openapi: 3.1.0
info:
  title: Universal Document AI API
  description: AI-powered document editing with multi-tenant organization support
  version: 2.0.0
servers: []
security: []
paths:
  /v1/promo/redeem:
    post:
      tags:
        - promo
      summary: Redeem Promo
      description: >-
        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.
      operationId: redeem_promo_v1_promo_redeem_post
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedeemRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedeemResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    RedeemRequest:
      properties:
        code:
          type: string
          maxLength: 64
          minLength: 1
          title: Code
          description: The promo code (case-insensitive).
      type: object
      required:
        - code
      title: RedeemRequest
      description: Redeem a promo code and receive its credit grant.
    RedeemResponse:
      properties:
        status:
          type: string
          title: Status
          description: Always 'redeemed' on success.
          default: redeemed
        promotion:
          $ref: '#/components/schemas/RedemptionOut'
        message:
          type: string
          title: Message
      type: object
      required:
        - promotion
        - message
      title: RedeemResponse
      description: Response body for POST /v1/promo/redeem on success.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RedemptionOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        ops_granted:
          type: integer
          title: Ops Granted
        ops_remaining:
          type: integer
          title: Ops Remaining
        redeemed_at:
          type: string
          title: Redeemed At
        expires_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Expires At
      type: object
      required:
        - id
        - name
        - ops_granted
        - ops_remaining
        - redeemed_at
        - expires_at
      title: RedemptionOut
      description: Summary of a successful redemption, returned from POST /v1/promo/redeem.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````