Get the credit balance

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

GET /billing/credits

Access token

Returns the organization's pre-purchased credit balance in cents, its currency and the share of each invoice the balance covers (effectiveDeductPercentage), with the credit ledger newest first (50 entries by default, paged with limit and skip). Requires an org admin, owner or billing role; returns 403 while credits are turned off.

Headers

organization string Required

id of the selected (active) organization

Query parameters

limit number
skip number

Responses

200 application/json
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  balanceCents number Required
  
  currency string Required
  
  effectiveDeductPercentage number Required
  
  entries array[object] Required
  
  Hide entries attributes Show entries attributes object
  
  type string Required
  
  Values are credit, debit, or reversal.
  
  reason string Required
  
  Values are admin_grant, deduction, or reversal.
  
  deltaCents number Required
  
  balanceAfterCents number Required
  
  description string Required
  
  invoice string | null Required
  
  createdAt string(date-time) Required
- statusCode number Required
- timestamp string(date-time) Required

GET /billing/credits

curl \
 --request GET 'http://api.example.com/billing/credits' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "organization: string"

Response examples (200)

{
  "data": {
    "balanceCents": 20000,
    "currency": "usd",
    "effectiveDeductPercentage": 100,
    "entries": [
      {
        "type": "debit",
        "reason": "deduction",
        "deltaCents": -5000,
        "balanceAfterCents": 20000,
        "description": "Credit applied to invoice in_1QExampleInvoice0001",
        "invoice": "in_1QExampleInvoice0001",
        "createdAt": "2026-01-15T14:30:00.000Z"
      }
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}