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

# Get Credits

> Get the current plan and remaining email, image, and monthly credits for the API key owner. Requires API key with billing:read permission.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/billing/credits
openapi: 3.1.0
info:
  title: Migma.ai API (v1)
  description: >-
    API for managing brands, contacts, email generation, sending, and
    integrations.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.migma.ai
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Projects/Brands
    description: Manage projects (brands) and import from websites
  - name: Contacts
    description: Manage your contacts, segments, tags, and topics
  - name: Segments
    description: Create and manage dynamic contact segments
  - name: Tags
    description: Organize contacts with tags
  - name: Topics
    description: Manage subscription topics and preferences
  - name: Emails
    description: Generate, send, and export emails
  - name: Email Validation
    description: Validate email content for compatibility and deliverability
  - name: Email Previews
    description: Preview emails across devices and email clients
  - name: Domains
    description: Manage sending domains and verification
  - name: Webhooks
    description: Manage webhook endpoints for real-time event notifications
  - name: Events
    description: Record customer events and conversions
  - name: Integrations
    description: Third-party platform integrations
  - name: Campaigns
    description: Create, schedule, send, and manage email campaigns
  - name: Billing
    description: View your plan and credits and create billing links
  - name: Project Editing
    description: Edit project assets, logos, images, and knowledge base entries
paths:
  /v1/billing/credits:
    get:
      tags:
        - Billing
      summary: Get Credits
      description: >-
        Get the current plan and remaining email, image, and monthly credits for
        the API key owner. Requires API key with billing:read permission.
      operationId: GetCredits
      responses:
        '200':
          description: Plan and remaining credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseBillingCredits'
              example:
                success: true
                data:
                  currentPlan: premium
                  isExpired: false
                  planExpiry: '2026-09-14T00:00:00.000Z'
                  hasCredits: true
                  emailCreditsRemainingToday: 40
                  imageCreditsRemainingToday: 25
                  monthlyCreditsRemaining: 310
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    ApiResponseBillingCredits:
      allOf:
        - $ref: '#/components/schemas/ApiResponse'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/BillingCredits'
    ApiResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          nullable: true
        error:
          type: string
          nullable: true
      required:
        - success
    BillingCredits:
      type: object
      properties:
        currentPlan:
          type: string
          description: The account's current plan
        isExpired:
          type: boolean
          description: Whether the current plan has expired
        planExpiry:
          type: string
          description: Date the current plan period ends (ISO 8601)
        hasCredits:
          type: boolean
          description: Whether the account has credits available right now
        emailCreditsRemainingToday:
          type: number
          description: Email generation credits remaining today
        imageCreditsRemainingToday:
          type: number
          description: Image generation credits remaining today
        monthlyCreditsRemaining:
          type: number
          description: Credits remaining in the current monthly period
      required:
        - currentPlan
        - isExpired
        - planExpiry
        - hasCredits
        - emailCreditsRemainingToday
        - imageCreditsRemainingToday
        - monthlyCreditsRemaining
    ApiError:
      type: object
      properties:
        success:
          type: boolean
          default: false
        error:
          type: string
        code:
          type: string
          description: >-
            Machine-readable error code (e.g., IDEMPOTENCY_CONFLICT,
            DOMAIN_CLAIMABLE).
        data:
          type: object
          description: >-
            Additional structured context for the error, such as the affected
            domain.
          additionalProperties: true
      required:
        - success
        - error
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Forbidden - Missing required permissions or access denied
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where
        YOUR_API_KEY is obtained from the Migma dashboard under Settings →
        Developers → API Keys.

````