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

# Get the credit balance, saved card and monthly spend

> Your credit balance in photos, the packs on sale, the saved card and how much of the monthly cap is spent.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/me/credits
openapi: 3.1.0
info:
  title: rial API
  version: 0.1.0
  description: 'Prove a photo is real. Base URL: https://api.rial.io'
  contact:
    name: rial-platform team
    url: https://github.com/Rial-ventures-Inc/rial-platform
  license:
    name: UNLICENSED — proprietary, internal use only
servers:
  - url: https://api.rial.io
    description: Production
security: []
tags:
  - name: Verifications
    description: >-
      Create, fetch, list, and finalize verifications. The core of the API —
      every tenant integration starts here.
  - name: Templates
    description: >-
      Publish, update, revoke and inspect link templates — the reusable capture
      links behind `/l/{token}` (a compact JWT carrying the org and template
      slugs; the legacy `/l/{org}/{slug}` keeps resolving). Callable with a
      secret key; each publish snapshots a versioned capture spec (GET-83).
  - name: Databases
    description: >-
      Create, update, inspect and synchronize tenant-scoped databases used by
      reusable verification templates. Callable with a dashboard session or
      secret API key.
  - name: Credits
    description: >-
      Prepaid photo credits at US$0.20 a photo, bought in packs by an agent with
      the card a person saved, under a monthly spend cap. While credits remain,
      Pro features are on. Callable with a dashboard session or secret API key.
paths:
  /v1/me/credits:
    get:
      tags:
        - Credits
      summary: Get the credit balance, saved card and monthly spend
      description: >-
        Your credit balance in photos, the packs on sale, the saved card and how
        much of the monthly cap is spent.
      responses:
        '200':
          description: >-
            Prepaid credits, the packs on sale and how much of the monthly cap
            is used.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credits'
        '401':
          description: The session or secret API key is invalid.
        '403':
          description: A person needs billing rights; a secret API key always may.
        '503':
          description: Billing storage unavailable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      decline_code:
                        type: string
                      month_spent_cents:
                        type: integer
                      monthly_cap_cents:
                        type: integer
                      idempotency_key:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
      security:
        - bearerApiKey: []
components:
  schemas:
    Credits:
      type: object
      properties:
        balance_cents:
          type: integer
        photos_available:
          type: integer
          minimum: 0
        price_per_photo_cents:
          type: integer
        packs:
          type: array
          items:
            type: object
            properties:
              photos:
                type: integer
              amount_cents:
                type: integer
            required:
              - photos
              - amount_cents
        payment_method:
          type:
            - object
            - 'null'
          properties:
            brand:
              type: string
            last4:
              type: string
        monthly_cap_cents:
          type:
            - integer
            - 'null'
        month_spent_cents:
          type: integer
      required:
        - balance_cents
        - photos_available
        - price_per_photo_cents
        - packs
        - payment_method
        - monthly_cap_cents
        - month_spent_cents
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: rk_secret_<key>
      description: >-
        Secret API key, created in the dashboard under Settings → API. Send it
        as `Authorization: Bearer rk_secret_…` from your server only.
        Publishable keys (`pk_live_…`) are for the native SDKs and reach the
        capture endpoints alone. An unknown key returns 401.

````

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