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

# Redeem a free Premium code

> Redeems a code for free Premium on your Personal account, such as 6 months of Premium with no card.

<Accordion title="Details">
  An account already paying through Stripe gets the free months after its paid period, with nothing charged; Stripe bills again by itself afterwards. A code is single use, and an account gets each offer once; repeating your own redemption answers the same. An unknown, used, revoked or expired code, or an offer the account already had, is invalid\_code; five of those in an hour wait an hour (redeem\_throttled). While a free period runs another code is promotion\_already\_active and stays unused.

  * **Callers:** an API key, an MCP OAuth token or a Dashboard session.
  * **Permission:** any signed-in member, for their own records; an API key also needs `billing:manage`.
  * **Effect:** Creates or changes something.
  * **Errors:** [`invalid_code`](/errors#invalid_code), [`promotion_already_active`](/errors#promotion_already_active), [`billing_attention_needed`](/errors#billing_attention_needed), [`redeem_throttled`](/errors#redeem_throttled), [`not_configured`](/errors#not_configured), and the [errors any request can get](/errors).
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json post /v1/billing/redeem
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: account
    x-group: Account
  - name: api_keys
    x-group: API keys
  - name: connected_apps
    x-group: Connected apps
  - name: usage
    x-group: Usage
  - name: quota
    x-group: Quota
  - name: billing
    x-group: Billing
  - name: integrations
    x-group: Integrations
  - name: connect
    x-group: Connect
  - name: logins
    x-group: Saved logins
  - name: two_factor
    x-group: 2FA
  - name: login_access
    x-group: Login access
  - name: tools
    x-group: Tools
  - name: webhooks
    x-group: Webhooks
  - name: runs
    x-group: Runs
  - name: builds
    x-group: Builds
  - name: jobs
    x-group: Jobs
  - name: files
    x-group: Files
  - name: team
    x-group: Team
paths:
  /v1/billing/redeem:
    post:
      tags:
        - billing
      summary: Redeem a free Premium code
      description: >-
        Redeems a code for free Premium on your Personal account, such as 6
        months of Premium with no card.
      operationId: billing.redeem
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - code
              properties:
                code:
                  type: string
                  description: >-
                    The code as sent, such as ABCD-EFGH-JKMN-PQRS; case, dashes
                    and spaces are ignored, and I and L read as 1, O as 0
                  minLength: 1
                  maxLength: 64
              additionalProperties: false
      responses:
        '200':
          description: The free Premium period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingRedeemed'
        '400':
          description: invalid_code, invalid_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: promotion_already_active, billing_attention_needed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: request_too_large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: redeem_throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: not_configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    BillingRedeemed:
      type: object
      required:
        - status
        - promotion
      properties:
        status:
          type: string
          enum:
            - redeemed
        promotion:
          $ref: '#/components/schemas/PromotionSummary'
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
    PromotionSummary:
      type: object
      required:
        - offer_name
        - ends_at
        - billing_resumes_at
      properties:
        offer_name:
          type: string
          description: The offer, such as 6 months of Premium
        ends_at:
          type: string
          description: When the free Premium period ends (ISO 8601)
        billing_resumes_at:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            When Stripe bills again (ISO 8601), for an account that also pays
            through Stripe; else null
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.