integrations

List billing events (internal)

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

mcp.json 
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}
Close
GET /billing/history
Access token

Lists the organization's billing events (subscription, invoicing, payment method, case billing and admin actions) newest first, filterable by category and caseId; 50 by default, at most 200, paged with limit and skip. Requires an org admin, owner or billing role. Adjustments made by Hearsay staff show a neutral description, no reason and no createdBy.

Headers

  • organization string Required

    id of the selected (active) organization

Query parameters

  • category string

    Values are subscription, invoicing, payment_method, case_billing, or admin.

  • caseId string
  • limit number
  • skip number

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • id string Required
      • type string Required

        Values are subscribed, plan_upgraded, plan_canceled, payment_succeeded, payment_failed, grace_started, grace_recovered, card_added, card_removed, extraction_code_paid, charge_recorded, invoice_created, invoice_paid, invoice_failed, refunded, dispute_created, case_pro_upgraded, tokens_granted, admin_draft, admin_draft_ready, admin_comp, admin_void, admin_profile_updated, migrated_to_case_billing, credit_granted, credit_deducted, credit_reversed, addon_activated, or addon_canceled.

      • category string Required

        Values are subscription, invoicing, payment_method, case_billing, or admin.

      • description string Required
      • case string | null Required
      • createdBy string | null Required
      • metadata object Required
      • createdAt string(date-time) Required
    • statusCode number Required
    • timestamp string(date-time) Required
GET /billing/history 
curl \
 --request GET 'http://api.example.com/billing/history' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "organization: string"
Response examples (200) 
{
  "data": [
    {
      "id": "65a1b2c3d4e5f6a7b8c9d0e5",
      "type": "charge_recorded",
      "category": "case_billing",
      "description": "Charge recorded: Phone collection",
      "case": "65a1b2c3d4e5f6a7b8c9d0e2",
      "createdBy": "65a1b2c3d4e5f6a7b8c9d0e6",
      "metadata": {
        "skuKey": "collection.phone",
        "amountCents": 17900
      },
      "createdAt": "2026-01-15T10:15:00.000Z"
    }
  ],
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}