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

# Billing status

> The Stripe subscription status and the price per live label.



## OpenAPI

````yaml /console-openapi.json get /api/v1/billing
openapi: 3.1.0
info:
  title: Caretly Console API
  version: 1.0.0
  description: >-
    Read your organisation's usage, API keys and billing status as JSON.
    Authenticate with any of your API keys, live or test. All endpoints are
    read-only.
servers:
  - url: https://caretly.dev/console
security:
  - bearerAuth: []
paths:
  /api/v1/billing:
    get:
      tags:
        - Console API
      summary: Billing status
      description: The Stripe subscription status and the price per live label.
      operationId: getBilling
      responses:
        '200':
          description: Billing status.
          headers:
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Billing'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  headers:
    CacheControl:
      description: Always `no-store`.
      schema:
        type: string
        example: no-store
  schemas:
    Billing:
      type: object
      required:
        - subscription_status
        - billing_active
        - price_per_label
        - currency
      properties:
        subscription_status:
          type:
            - string
            - 'null'
          description: >-
            The Stripe subscription status, such as `active` or `past_due`;
            `null` without a subscription.
          example: active
        billing_active:
          type: boolean
          description: Whether live keys can be used.
        price_per_label:
          type: number
          example: 0.002
        currency:
          type: string
          const: EUR
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong.
  responses:
    Unauthorized:
      description: The API key is missing, invalid, expired or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              This API key has been revoked. Send one of your API keys as
              `Authorization: Bearer <key>`; manage keys at
              https://caretly.dev/console/keys
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        One of your API keys (`zpl_live_…` or `zpl_test_…`), created at
        https://caretly.dev/console/keys. Revoked keys are refused immediately.

````

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