superdocs-app Promo API

openapi: 3.2.0
info:
  title: 'Typebar API: Universal Document AI Promo API'
  description: 'Typebar (formerly SuperDocs): AI-powered document editing with multi-tenant organization support'
  version: 2.0.0
servers:
- url: https://api.superdocs.app
tags:
- name: promo
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
      security:
      - HTTPBearer: []
      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'
  /v1/users/me/promotions:
    get:
      tags:
      - promo
      summary: List My Promotions
      description: 'List the authenticated user''s promotion redemptions, split into `active` (drawable now)

        and `history` (exhausted / expired / revoked).


        Used by the Settings → Billing tab to render the Credits & Promotions section.'
      operationId: list_my_promotions_v1_users_me_promotions_get
      security:
      - HTTPBearer: []
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPromotionsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    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.
    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.
    UserPromotionsResponse:
      properties:
        active:
          items:
            $ref: '#/components/schemas/ActivePromotionOut'
          type: array
          title: Active
        history:
          items:
            $ref: '#/components/schemas/HistoricalPromotionOut'
          type: array
          title: History
      type: object
      required:
      - active
      - history
      title: UserPromotionsResponse
      description: Listing of the authenticated user's promotion grants, split by active vs. history.
    ActivePromotionOut:
      properties:
        redemption_id:
          type: string
          title: Redemption 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:
      - redemption_id
      - name
      - ops_granted
      - ops_remaining
      - redeemed_at
      - expires_at
      title: ActivePromotionOut
      description: A single active (drawable) promotion grant belonging to the current user.
    HistoricalPromotionOut:
      properties:
        redemption_id:
          type: string
          title: Redemption 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
        status:
          type: string
          title: Status
      type: object
      required:
      - redemption_id
      - name
      - ops_granted
      - ops_remaining
      - redeemed_at
      - expires_at
      - status
      title: HistoricalPromotionOut
      description: An exhausted, expired, or revoked promotion grant kept for the user's history view.
    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.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer