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

# Subscribe To Plan

> Subscribe to a paid plan via Stripe Checkout.

Creates a Stripe Checkout Session in subscription mode. After payment,
the organization's account_type is updated via webhook.

If the organization already has an active subscription, the plan is
changed inline (upgrade/downgrade with proration) instead of creating
a new checkout session.

**Available Plans** (tier minimum is a billing floor; usage above it
bills automatically):
- `managed_build`: Managed Mixpeek Build — $25/mo min, 100K objects/mo
- `managed_scale`: Managed Mixpeek Scale — $250/mo min, 1M objects/mo
- `mvs_build`: MVS Standalone Build — $25/mo min, 1M vectors
- `mvs_scale`: MVS Standalone Scale — $250/mo min, 25M vectors

**Discounts:** each non-empty `onboarding_answers` field takes $5 off the
first invoice (max $10). An explicit `promo_code` is validated and
pre-applied; when both are sent the promo takes checkout's single
discount slot and the onboarding credit lands on the customer balance.
Without either, Stripe's own promo-code field is enabled at checkout.



## OpenAPI

````yaml post /v1/organizations/billing/subscribe
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/subscribe:
    post:
      tags:
        - Organization Billing
      summary: Subscribe To Plan
      description: >-
        Subscribe to a paid plan via Stripe Checkout.


        Creates a Stripe Checkout Session in subscription mode. After payment,

        the organization's account_type is updated via webhook.


        If the organization already has an active subscription, the plan is

        changed inline (upgrade/downgrade with proration) instead of creating

        a new checkout session.


        **Available Plans** (tier minimum is a billing floor; usage above it

        bills automatically):

        - `managed_build`: Managed Mixpeek Build — $25/mo min, 100K objects/mo

        - `managed_scale`: Managed Mixpeek Scale — $250/mo min, 1M objects/mo

        - `mvs_build`: MVS Standalone Build — $25/mo min, 1M vectors

        - `mvs_scale`: MVS Standalone Scale — $250/mo min, 25M vectors


        **Discounts:** each non-empty `onboarding_answers` field takes $5 off
        the

        first invoice (max $10). An explicit `promo_code` is validated and

        pre-applied; when both are sent the promo takes checkout's single

        discount slot and the onboarding credit lands on the customer balance.

        Without either, Stripe's own promo-code field is enabled at checkout.
      operationId: subscribe_to_plan_v1_organizations_billing_subscribe_post
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscribeRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscribeResponse'
        '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:
    SubscribeRequest:
      properties:
        plan:
          type: string
          title: Plan
          description: >-
            Plan slug: managed_build, managed_scale, mvs_build, mvs_scale. The
            tier minimum is a billing floor — usage above it bills automatically
            at the plan's rates.
          examples:
            - managed_build
            - mvs_scale
        success_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Success Url
          description: Redirect URL after successful subscription
          default: https://studio.mixpeek.com/billing?subscription=success
        cancel_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cancel Url
          description: Redirect URL if subscription is cancelled
          default: https://studio.mixpeek.com/billing?subscription=cancelled
        onboarding_answers:
          anyOf:
            - $ref: '#/components/schemas/OnboardingAnswers'
            - type: 'null'
          description: >-
            Optional signup questions; each non-empty answer = $5 off the first
            invoice (max $10).
        promo_code:
          anyOf:
            - type: string
              maxLength: 64
            - type: 'null'
          title: Promo Code
          description: >-
            Optional promo code to pre-apply at checkout. When combined with
            onboarding answers, the promo takes checkout's single discount slot
            and the onboarding credit lands on the customer balance.
      type: object
      required:
        - plan
      title: SubscribeRequest
      description: Request to subscribe to a plan.
    SubscribeResponse:
      properties:
        checkout_url:
          type: string
          title: Checkout Url
          description: Stripe Checkout URL for subscription
          examples:
            - https://checkout.stripe.com/c/pay/cs_live_abc123
        session_id:
          type: string
          title: Session Id
          description: Stripe Checkout Session ID (empty string for inline upgrades)
          examples:
            - cs_live_abc123
            - ''
      type: object
      required:
        - checkout_url
        - session_id
      title: SubscribeResponse
      description: Response with Stripe Checkout Session URL for subscription.
    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.

````