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

# Get your subscription

> Returns your Personal account's plan and Premium subscription, any free Premium period from a redeemed code (promotion), and what checkout and the billing portal offer.

<Accordion title="Details">
  * **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:** Changes nothing.
  * **Errors:** only the [errors any request can get](/errors).
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json get /v1/billing
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:
    get:
      tags:
        - billing
      summary: Get your subscription
      description: >-
        Returns your Personal account's plan and Premium subscription, any free
        Premium period from a redeemed code (promotion), and what checkout and
        the billing portal offer.
      operationId: billing.get
      responses:
        '200':
          description: Your subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Billing'
        '400':
          description: 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'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    Billing:
      type: object
      required:
        - plan
        - status
        - interval
        - current_period_end
        - live
        - portal
        - checkout
        - yearly_switch
        - promotion
      properties:
        plan:
          type: string
          enum:
            - free
            - premium
        status:
          type: string
          enum:
            - free
            - active
            - trialing
            - canceling
            - past_due
            - payment_failed
          description: >-
            canceling: Premium until current_period_end, then Free. past_due:
            still Premium while a failed payment is retried. payment_failed: the
            first payment failed, so still Free
        interval:
          anyOf:
            - type: string
              enum:
                - monthly
                - yearly
            - type: 'null'
        current_period_end:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            When the current period ends: the next renewal, the end of a trial,
            or when Premium ends
        live:
          type: boolean
          description: >-
            False when Stripe couldn't be read, so this is the last stored
            subscription
        portal:
          type: boolean
          description: The billing portal can open
        checkout:
          type: object
          required:
            - monthly
            - yearly
          properties:
            monthly:
              type: boolean
            yearly:
              type: boolean
          additionalProperties: false
          description: Which Premium intervals checkout offers
        yearly_switch:
          type: object
          required:
            - available
            - scheduled
            - needs_support
          properties:
            available:
              type: boolean
              description: A monthly subscription can switch to yearly at its next renewal
            scheduled:
              anyOf:
                - type: object
                  required:
                    - schedule_id
                    - starts_at
                  properties:
                    schedule_id:
                      type: string
                    starts_at:
                      type: string
                  additionalProperties: false
                - type: 'null'
            needs_support:
              type: boolean
              description: >-
                The subscription has a scheduled change Pomerado didn't make;
                contact support
          additionalProperties: false
        promotion:
          anyOf:
            - $ref: '#/components/schemas/PromotionSummary'
            - type: 'null'
          description: >-
            The free Premium period from a redeemed code, while it runs; else
            null
      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.