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

# Get Billing Status

> Get user's billing status, verified against Stripe.



## OpenAPI

````yaml /openapi.json get /api/billing/status
openapi: 3.1.0
info:
  description: >

    The CodeCobra API drives the same product the dashboard does: create a

    project, open a task against it, watch the agent work, and merge what it

    builds.


    ## Authenticating


    Send a personal API key as a bearer token on every request:


    ```

    Authorization: Bearer cc_your_key_here

    ```


    Mint a key from **Settings → API keys** in the dashboard. A key carries the

    full access of the user who created it, including every organization they

    belong to, so treat it like a password and point automations at a user with

    the access they actually need.


    ## What is not here


    A few dashboard actions are deliberately absent, because an API key should
    not

    be able to widen its own reach or start a flow only a browser can finish:


    * signing in, signing up, password resets and two-factor enrolment;

    * creating, listing or revoking API keys — a leaked key cannot mint another;

    * linking or unlinking a Google or GitHub identity;

    * connecting or disconnecting a GitHub App installation, which needs an
    OAuth
      round-trip in a browser to restore.

    Everything else the dashboard can do is in this reference.


    ## Conventions


    Identifiers are UUIDs. Timestamps are ISO 8601 in UTC. Money is a decimal

    string in USD. A failed request returns its reason in the `detail` field
    with

    a conventional status code: `401` for a missing or invalid key, `403` when
    the

    key's user lacks access to the object, `404` when it does not exist, and
    `429`

    when a rate limit is in play.
  title: CodeCobra API
  version: 1.0.0
servers: []
security:
  - ApiKeyBearer: []
tags:
  - description: >-
      The profile behind the API key, plus the app-wide configuration an
      integration needs before it can create anything: the Odoo versions on
      offer and the models a task may run on.
    name: Account
  - description: >-
      Projects are the unit of ownership. A project pins an Odoo version and
      edition, carries the GitHub repositories the agent works in, and holds
      every task underneath it. Deleting one removes its tasks, pods and stored
      files.
    name: Projects
  - description: >-
      A task is one conversation with the agent inside a project. These
      endpoints create tasks, drive the chat, stream the response, manage
      attachments, and start the pod the agent runs in.
    name: Tasks
  - description: >-
      The plan the agent writes before it builds, its revision history, and the
      files a task produces. Approving a plan is what releases the agent to
      start work.
    name: Plans & Artifacts
  - description: >-
      The pull requests a task opens: checking CI, asking the agent to fix a red
      build, choosing a merge target, and merging to a branch that deploys.
    name: Pull Requests & Deploys
  - description: >-
      Odoo databases a task can reach. Credentials are stored per project and
      activated per task; the probe endpoints validate a URL and login before
      anything is saved. Also covers the throwaway Odoo instance a task runs
      against.
    name: Odoo Connections
  - description: >-
      Shared accounts. An organization owns projects on behalf of its members
      and is billed as one entity.
    name: Organizations
  - description: >-
      Who belongs to an organization and at what role, and the invitations that
      put them there.
    name: Members & Invitations
  - description: >-
      Teams group members inside an organization and grant a whole group access
      to a set of projects at once.
    name: Teams
  - description: >-
      The GitHub App installations backing a personal or organization account,
      and the repositories and branches they expose to projects. Connecting and
      disconnecting GitHub needs a browser round-trip and stays in the
      dashboard.
    name: GitHub
  - description: Balance, payment methods, invoices and auto-reload for a personal account.
    name: Billing
  - description: >-
      The same billing operations for an organization, settled against the
      organization's balance rather than a member's.
    name: Organization Billing
  - description: >-
      What has been spent, broken down by task, project or organization, and
      exportable over a date range for billing reconciliation.
    name: Usage
paths:
  /api/billing/status:
    get:
      tags:
        - Billing
      summary: Get Billing Status
      description: Get user's billing status, verified against Stripe.
      operationId: get_billing_status_api_billing_status_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingStatusResponse'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    BillingStatusResponse:
      properties:
        account_balance:
          default: 0
          title: Account Balance
          type: number
        amount_owed:
          default: 0
          title: Amount Owed
          type: number
        auto_reload_amount:
          default: 50
          title: Auto Reload Amount
          type: number
        auto_reload_enabled:
          default: false
          title: Auto Reload Enabled
          type: boolean
        auto_reload_threshold:
          default: 10
          title: Auto Reload Threshold
          type: number
        billing_mode:
          default: prepaid
          title: Billing Mode
          type: string
        billing_suspended:
          default: false
          title: Billing Suspended
          type: boolean
        card:
          anyOf:
            - $ref: '#/components/schemas/CardInfo'
            - type: 'null'
        cards:
          default: []
          items:
            $ref: '#/components/schemas/CardInfo'
          title: Cards
          type: array
        credit_limit:
          default: 0
          title: Credit Limit
          type: number
        default_payment_method_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Default Payment Method Id
        has_free_pricing:
          default: false
          title: Has Free Pricing
          type: boolean
        has_payment_method:
          title: Has Payment Method
          type: boolean
        low_balance:
          default: false
          title: Low Balance
          type: boolean
        remaining_balance:
          default: 0
          title: Remaining Balance
          type: number
        stripe_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Stripe Customer Id
        stripe_publishable_key:
          default: ''
          title: Stripe Publishable Key
          type: string
        unbilled_usage:
          default: 0
          title: Unbilled Usage
          type: number
      required:
        - has_payment_method
      title: BillingStatusResponse
      type: object
    CardInfo:
      properties:
        brand:
          title: Brand
          type: string
        exp_month:
          title: Exp Month
          type: integer
        exp_year:
          title: Exp Year
          type: integer
        id:
          title: Id
          type: string
        last4:
          title: Last4
          type: string
      required:
        - id
        - brand
        - last4
        - exp_month
        - exp_year
      title: CardInfo
      type: object
  securitySchemes:
    ApiKeyBearer:
      description: A personal API key from Settings → API keys.
      scheme: bearer
      type: http

````