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

# Redeem Promo

> Redeem a promo code on a FRESH org — no Checkout, no card.

A promo code lets you continue without entering a card. This creates the
subscription server-side with the coupon attached (the self-serve twin of the manual comp flow), stamps
``metadata.organization_id`` so the subscription webhook grants tier +
POC cap, and sets the org's plan fields inline so the user continues
IMMEDIATELY (no webhook-latency paywall).

Only codes whose window bills $0 (percent_off=100 — every POC code by
validated shape) can start service card-less: a partial discount with no
payment method would generate a FAILING first invoice (service cut +
dunning — strictly worse than the card form; the uncollectable shape
POC-PROMO-CAP-2026-07-17 exists to prevent). Partial codes get a clear
redirect to checkout, where the discount still applies. Card-ask happens
at coupon end (finances' T-7d lifecycle).

Every failure carries a reason — never a silent no-op.



## OpenAPI

````yaml post /v1/organizations/billing/redeem-promo
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/organizations/billing/redeem-promo:
    post:
      tags:
        - Organization Billing
      summary: Redeem Promo
      description: >-
        Redeem a promo code on a FRESH org — no Checkout, no card.


        A promo code lets you continue without entering a card. This creates the

        subscription server-side with the coupon attached (the self-serve twin
        of the manual comp flow), stamps

        ``metadata.organization_id`` so the subscription webhook grants tier +

        POC cap, and sets the org's plan fields inline so the user continues

        IMMEDIATELY (no webhook-latency paywall).


        Only codes whose window bills $0 (percent_off=100 — every POC code by

        validated shape) can start service card-less: a partial discount with no

        payment method would generate a FAILING first invoice (service cut +

        dunning — strictly worse than the card form; the uncollectable shape

        POC-PROMO-CAP-2026-07-17 exists to prevent). Partial codes get a clear

        redirect to checkout, where the discount still applies. Card-ask happens

        at coupon end (finances' T-7d lifecycle).


        Every failure carries a reason — never a silent no-op.
      operationId: redeem_promo_v1_organizations_billing_redeem_promo_post
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedeemPromoRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedeemPromoResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    RedeemPromoRequest:
      properties:
        code:
          type: string
          maxLength: 64
          minLength: 1
          title: Code
        plan:
          type: string
          title: Plan
          description: >-
            Plan slug to start on the comped window (product_tier, e.g.
            managed_build). Must be self-serve and match the code's product
            restriction.
          default: managed_build
        onboarding_answers:
          anyOf:
            - $ref: '#/components/schemas/OnboardingAnswers'
            - type: 'null'
          description: >-
            Signup questions — persisted server-side for GTM attribution, parity
            with the card path (the no-CC cohort is the highest-sales-relevance
            cohort; client-event-only isn't joinable with the server-side funnel
            data). The $5/answer credit is NOT minted here — the comped window
            bills $0, so there is nothing to offset.
      type: object
      required:
        - code
      title: RedeemPromoRequest
    RedeemPromoResponse:
      properties:
        redeemed:
          type: boolean
          title: Redeemed
        code:
          type: string
          title: Code
        plan:
          type: string
          title: Plan
        account_type:
          type: string
          title: Account Type
        subscription_id:
          type: string
          title: Subscription Id
        poc_usage_cap_cents:
          anyOf:
            - type: integer
            - type: 'null'
          title: Poc Usage Cap Cents
          description: >-
            POC promo usage ceiling (cents), granted via the subscription
            webhook (cap_source=poc_promo:*).
        duration_in_months:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration In Months
      type: object
      required:
        - redeemed
        - code
        - plan
        - account_type
        - subscription_id
      title: RedeemPromoResponse
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OnboardingAnswers:
      properties:
        building:
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
          title: Building
          description: What are you building?
        referral_source:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Referral Source
          description: How did you hear about Mixpeek?
      type: object
      title: OnboardingAnswers
      description: |-
        Optional signup questions — each non-empty answer takes $5 off the
        first invoice (max $10). Answers are persisted for GTM attribution.
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing header returns
        403; an invalid or revoked key returns 401.

````