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

# Read the billing catalogue and current plan

> Returns the purchasable one-off top-up `packs` and monthly `plans` (each with its credits, email fair-use cap and display price in cents), the `currentPlanTier` the wallet subscribes to (omitted when on no plan), and `enabled` — `false` when the deployment has no Stripe secret, meaning every checkout below will return a dry-run stub instead of a payable session. ALWAYS call this before opening a checkout: it is the only source of the valid `packId` / `tierId` values, which are deployment config and not guessable. Read-only.



## OpenAPI

````yaml /openapi.json get /v1/credits/billing
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/credits/billing:
    get:
      tags:
        - Billing
      summary: Read the billing catalogue and current plan
      description: >-
        Returns the purchasable one-off top-up `packs` and monthly `plans` (each
        with its credits, email fair-use cap and display price in cents), the
        `currentPlanTier` the wallet subscribes to (omitted when on no plan),
        and `enabled` — `false` when the deployment has no Stripe secret,
        meaning every checkout below will return a dry-run stub instead of a
        payable session. ALWAYS call this before opening a checkout: it is the
        only source of the valid `packId` / `tierId` values, which are
        deployment config and not guessable. Read-only.
      operationId: getBillingCatalogue
      responses:
        '200':
          description: >-
            The catalogue, the Stripe-enabled flag and the currently subscribed
            tier.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enabled:
                    type: boolean
                  packs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        name:
                          type: string
                          minLength: 1
                        credits:
                          type: integer
                          minimum: 0
                          exclusiveMinimum: true
                          maximum: 9007199254740991
                        priceCents:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                        - id
                        - name
                        - credits
                        - priceCents
                      additionalProperties: false
                  plans:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        name:
                          type: string
                          minLength: 1
                        monthlySmsCredits:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        emailFairUseCap:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        priceCents:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                        - id
                        - name
                        - monthlySmsCredits
                        - emailFairUseCap
                        - priceCents
                      additionalProperties: false
                  currentPlanTier:
                    type: string
                    minLength: 1
                required:
                  - enabled
                  - packs
                  - plans
                additionalProperties: false
                description: >-
                  The catalogue, the Stripe-enabled flag and the currently
                  subscribed tier.
                example:
                  enabled: true
                  packs:
                    - id: topup-500
                      name: 500 SMS
                      credits: 500
                      priceCents: 2500
                    - id: topup-2000
                      name: 2000 SMS
                      credits: 2000
                      priceCents: 9000
                  plans:
                    - id: starter
                      name: Starter
                      monthlySmsCredits: 200
                      emailFairUseCap: 5000
                      priceCents: 1900
                    - id: pro
                      name: Pro
                      monthlySmsCredits: 1000
                      emailFairUseCap: 20000
                      priceCents: 4900
                  currentPlanTier: starter
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````