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

# Get plan status

> Owner or admin only. Returns the plan, the subscription state, the current period, any pending cancellation or scheduled switch, the saved card, and whether the workspace can start a trial. Timestamps are Unix seconds.




## OpenAPI

````yaml /openapi/billing.yaml get /workspaces/{workspaceId}/billing/subscription
openapi: 3.1.0
info:
  title: Connie Billing API
  version: 1.0.0
  description: >
    Endpoints the Connie web app uses for billing. They authenticate with your
    signed-in browser session — see
    https://docs.connie.ai/api-reference/authentication. These are the app's own
    endpoints and can change when the app changes.
servers:
  - url: https://connie.ai/api
security:
  - sessionCookie: []
tags:
  - name: Credits
    description: >
      The workspace's credit balance. Any member can read the balance and plan
      prices; plan details and everything else in Billing are for workspace
      owners and admins only.
  - name: Plan
    description: The workspace's plan and subscription. Owners and admins only.
  - name: Usage log
    description: >-
      Every credit used or added, as shown in Settings > Logs. Owners and admins
      only.
paths:
  /workspaces/{workspaceId}/billing/subscription:
    get:
      tags:
        - Plan
      summary: Get plan status
      description: >
        Owner or admin only. Returns the plan, the subscription state, the
        current period, any pending cancellation or scheduled switch, the saved
        card, and whether the workspace can start a trial. Timestamps are Unix
        seconds.
      operationId: getPlanStatus
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      responses:
        '200':
          description: Plan status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AdminOnly'
components:
  parameters:
    workspaceId:
      name: workspaceId
      in: path
      required: true
      description: The workspace id, as in the app URL `connie.ai/<workspaceId>/...`.
      schema:
        type: string
        format: uuid
  schemas:
    PlanStatus:
      type: object
      properties:
        tier:
          $ref: '#/components/schemas/PlanTier'
        subscriptionState:
          type: string
          description: '`free` when there is no paid plan.'
          enum:
            - free
            - trialing
            - active
            - past_due
            - paused
            - canceled
            - unpaid
            - incomplete_expired
        limits:
          type: object
          properties:
            credits:
              type: integer
              description: >-
                Credits the plan grants each month. On Free, the one-time
                welcome grant.
        trialEnd:
          type:
            - integer
            - 'null'
          description: When the trial ends (Unix seconds).
        trialEligible:
          type: boolean
          description: >-
            Whether this workspace can start the Starter trial. Only true on
            Free.
        subscription:
          description: Null on Free.
          oneOf:
            - type: 'null'
            - type: object
              properties:
                status:
                  type: string
                billingInterval:
                  type: string
                  enum:
                    - month
                    - year
                currentPeriodStart:
                  type: integer
                currentPeriodEnd:
                  type: integer
                  description: When the plan next renews (Unix seconds).
                cancelAtPeriodEnd:
                  type: boolean
                  description: The plan is cancelled and ends at `currentPeriodEnd`.
                cancelAt:
                  type:
                    - integer
                    - 'null'
                lastCreditGrantAt:
                  type:
                    - integer
                    - 'null'
                defaultPaymentMethod:
                  oneOf:
                    - $ref: '#/components/schemas/PaymentMethod'
                    - type: 'null'
        effectivePaymentMethod:
          description: The card that will be charged, if any.
          oneOf:
            - $ref: '#/components/schemas/PaymentMethod'
            - type: 'null'
        pendingDowngradeTier:
          description: A switch scheduled for the end of the period.
          oneOf:
            - $ref: '#/components/schemas/PlanTier'
            - type: 'null'
        pendingDowngradeInterval:
          type:
            - string
            - 'null'
          enum:
            - month
            - year
            - null
        pendingActions:
          description: Open billing issues, such as a failed payment.
          oneOf:
            - type: 'null'
            - type: object
              properties:
                count:
                  type: integer
                hasErrors:
                  type: boolean
                hasWarnings:
                  type: boolean
        customer:
          description: The billing contact.
          oneOf:
            - type: 'null'
            - type: object
              properties:
                email:
                  type:
                    - string
                    - 'null'
                name:
                  type:
                    - string
                    - 'null'
    PlanTier:
      type: string
      description: >
        The plan, as a stable id. In the app, `starter`, `plus` and `build` are
        the Starter plans (2,500, 10,000 and 22,000 credits a month) and
        `scale`, `growth` and `pro_max` are the Scale plans (35,000, 55,000 and
        100,000).
      enum:
        - free
        - starter
        - plus
        - build
        - scale
        - growth
        - pro_max
    PaymentMethod:
      type: object
      properties:
        card:
          type: object
          properties:
            brand:
              type:
                - string
                - 'null'
              example: visa
            last4:
              type:
                - string
                - 'null'
            exp_month:
              type:
                - integer
                - 'null'
            exp_year:
              type:
                - integer
                - 'null'
    Error:
      type: object
      properties:
        error:
          type: string
          description: A readable message.
        code:
          type: string
          description: A machine-readable code, when the route sets one.
  responses:
    Unauthorized:
      description: No valid session, or the session has expired (`SESSION_EXPIRED`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    AdminOnly:
      description: >-
        You are not a member of this workspace, or you are not an owner or
        admin.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: header
      name: Cookie
      description: >-
        The full Cookie header copied from a signed-in connie.ai browser
        request. See the Authentication page.

````

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