> ## Documentation Index > Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get organization messaging usage summary > Returns current-organization usage totals for the active billing period, including spend, limits, and event summary data. ## OpenAPI ````yaml /openapi.json get /usage/summary/my openapi: 3.1.1 info: title: Leadping API description: >- The Leadping API helps businesses capture and manage leads, automate follow-up, send SMS and MMS messages, place calls, track conversations, enforce contact suppression, and analyze communication workflows. Use this OpenAPI 3.1 contract to integrate lead sources, build organization tools, or generate a typed API client. Authenticate protected operations with a Leadping user access token or WorkOS organization API key. Lead intake operations also accept a Leadping source key. termsOfService: https://leadping.ai/docs/terms-of-service contact: name: Leadping Support url: https://leadping.ai/contact email: support@leadping.ai license: name: MIT url: https://opensource.org/licenses/MIT version: v1 summary: Lead management, messaging, calling, and automation API servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: Leadping.Api description: >- Agent-to-agent discovery and request handling for Leadping's supported AI agent integrations. - name: Analytics description: >- Provides lead, communication, conversion, and organization performance analytics. Use these endpoints to measure activity over time, compare outcomes, and power operational dashboards and reporting workflows. - name: Automations description: >- Manages automated lead follow-up workflows and their execution history. Use these endpoints to configure SMS automation steps, preview eligible leads, run workflows, and inspect individual automation executions. - name: BlogArticles description: >- Provides published Leadping blog content. Use these endpoints to list published articles and retrieve an individual article by its public slug. - name: Conversations description: >- Provides lead conversation timelines and inbox-oriented conversation views. Use these endpoints to list recent conversations and retrieve the cross-channel communication history associated with a lead. - name: Feedback description: >- Captures Leadping product feedback and supports administrative triage. Users can submit feedback, while authorized staff can search, inspect, classify, and update feedback throughout the review process. - name: Leads description: >- Manages lead intake, records, assignment, routing, and lifecycle operations. Use these endpoints to ingest leads from trusted sources, search and update lead records, manage ownership and tags, and archive or delete leads. - name: LeadStatusChanges description: >- Manages the auditable history of lead status transitions. Use these endpoints to change a lead's status, correct transition records, search status history, and export status activity for reporting. - name: LeadStatuses description: >- Manages the lead statuses used to classify and track leads throughout their lifecycle. Use these endpoints to list, create, update, and archive organization-specific lead statuses for consistent pipeline organization and reporting. - name: Notifications description: >- Manages user notifications, announcements, and push-notification installations. Use these endpoints to retrieve notification feeds and unread counts, update read state, and register or remove client push installations. - name: OutboundDelivery description: >- Reports outbound delivery pacing and sending capacity for the current organization. Use these endpoints to determine whether outbound communications can proceed and to understand active throttles, limits, or capacity constraints. - name: Sources description: >- Manages lead sources, intake credentials, routing defaults, and attribution. Use these endpoints to create and configure sources, search source records, inspect source activity, rotate intake access, and remove obsolete sources. - name: Suppressions description: >- Manages recipient suppression state for compliant Leadping communication workflows. Use these endpoints to check contact eligibility, record or release suppressions, and review suppression history before sending messages or placing calls. - name: Tags description: >- Manages organization-defined tags for categorizing and routing leads. Use these endpoints to list, create, update, and archive reusable tags that support lead filtering, automation, assignment, and reporting. - name: Users description: >- Manages the current Leadping user's profile, preferences, setup, and account workflows. Use these endpoints to retrieve and update user data, configure communication and compliance preferences, complete onboarding, manage plan-related actions, and request account operations. - name: Calls description: >- Manages outbound Leadping calls and active call-control workflows. Use these endpoints to initiate or cancel a call, retrieve call state, and transfer an active call within supported telephony flows. - name: PhoneNumbers description: >- Manages phone-number discovery, purchasing, assignment, configuration, and compliance. Use these endpoints to search available numbers, manage owned numbers and caller identity, configure messaging or voice behavior, and monitor registration and warmup state. - name: Sms description: >- Sends and manages SMS and MMS communications through Leadping. Use these endpoints to send messages, upload MMS media, and cancel eligible scheduled messages while preserving conversation and delivery tracking. - name: Telephony description: >- Provides shared authentication and bootstrap data for Leadping telephony clients. Use this endpoint to obtain the scoped credentials and configuration required to initialize supported calling experiences. - name: Organizations description: >- Manages Leadping organizations, memberships, invitations, settings, and API credentials. Use these endpoints to maintain organization profiles and branding, manage members and invitations, configure options, and issue or revoke organization API keys. - name: UserDataExports description: >- Creates and delivers user-requested exports of Leadping account data. Use these endpoints to request an export, monitor its preparation status, and download the completed archive through a time-limited redirect. - name: CallEvents description: >- Provides call event records for auditing, diagnostics, and reporting. Use these endpoints to search and inspect lifecycle events emitted as Leadping calls are initiated, connected, completed, or fail. - name: Events description: >- Provides a unified record of Leadping activity across communication channels. Use these endpoints to retrieve event timelines, search event history, inspect event details, and record supported application events. - name: SmsEvents description: >- Provides SMS and MMS event records for delivery tracking and diagnostics. Use these endpoints to search and inspect message lifecycle events, including outbound delivery updates and inbound messaging activity. - name: PaymentMethods description: >- Manages organization payment methods and billing invoices. Use these endpoints to add, confirm, inspect, and remove payment methods or retrieve invoices associated with the current organization's billing account. - name: Transactions description: >- Provides organization wallet and billing transaction records. Use these endpoints to search transaction history, inspect individual charges or credits, review transaction summaries, and issue administrative credits. - name: Usage description: >- Provides billable usage records for Leadping services. Use these endpoints to review messaging and calling consumption, inspect usage summaries, and reconcile provider activity for an organization. - name: Wallets description: >- Manages organization wallet balances, funding, and credit activity. Use these endpoints to inspect wallet state and history, configure wallet behavior, add funds, and record credits or adjustments. externalDocs: description: >- Leadping API documentation, authentication guide, concepts, and integration guidance. url: https://leadping.ai/docs/api-reference paths: /usage/summary/my: get: tags: - Usage summary: Get organization messaging usage summary description: >- Returns current-organization usage totals for the active billing period, including spend, limits, and event summary data. operationId: Usage_GetSummaryForCurrentOrganization parameters: - name: periodStart in: query description: The period start. schema: type: string format: date-time - name: periodEnd in: query description: The period end. schema: type: string format: date-time responses: '200': description: Returns the usage summary response. content: application/json: schema: allOf: - $ref: '#/components/schemas/UsageSummaryResponse' description: Describes usage summary response data used by Leadping. '401': description: Authentication credentials are missing or invalid. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Unauthorized status: 401 detail: The request could not be completed. '403': description: >- The authenticated user or organization does not have permission to perform this operation. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Forbidden status: 403 detail: The request could not be completed. '429': description: The API rate limit for this account or client has been exceeded. headers: Retry-After: description: Number of seconds to wait before retrying the request. schema: minimum: 0 type: integer format: int32 content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Too Many Requests status: 429 detail: The request could not be completed. security: - Bearer: [] components: schemas: UsageSummaryResponse: type: object properties: periodStart: type: string description: UTC timestamp for period start on this usage summary. format: date-time periodEnd: type: string description: UTC timestamp for period end on this usage summary. format: date-time customerChargeTotal: type: number description: The customer charge total for this usage summary. format: double billableQuantityTotal: type: number description: The billable quantity total for this usage summary. format: double transactionCount: type: integer description: The usage record count for this usage summary. format: int32 pendingInvoiceCount: type: integer description: The pending invoice count for this usage summary. format: int32 failedCount: type: integer description: The failed count for this usage summary. format: int32 lines: type: array items: allOf: - $ref: '#/components/schemas/UsageSummaryLine' description: >- Describes usage summary line data used in Leadping API requests and responses. description: The lines included with this usage summary. counters: type: array items: allOf: - $ref: '#/components/schemas/UsageCounterLine' description: >- Describes one named usage total displayed in organization billing and activity summaries. description: The named usage counters included with this usage summary. description: Describes usage summary response data used by Leadping. ProblemDetails: type: object properties: type: type: - 'null' - string description: URI reference that identifies the problem type. title: type: - 'null' - string description: Short, human-readable summary of the problem. status: type: - 'null' - integer description: HTTP status code returned for the problem. format: int32 detail: type: - 'null' - string description: >- Human-readable explanation specific to this occurrence of the problem. instance: type: - 'null' - string description: >- URI reference that identifies this specific occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: >- Validation errors keyed by the JSON request field name. Present for request validation failures. traceId: type: string description: >- Request trace identifier used to correlate this problem with Leadping diagnostics. description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. UsageSummaryLine: type: object properties: channel: allOf: - $ref: '#/components/schemas/UsageChannel' description: >- Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage. billableUnit: allOf: - $ref: '#/components/schemas/BillableUnit' description: >- Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number. status: allOf: - $ref: '#/components/schemas/UsageStatus' description: >- Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed. quantity: type: number description: Quantity for this usage summary line. format: double customerChargeAmount: type: number description: The monetary customer charge amount for this usage summary line. format: double recordCount: type: integer description: The record count for this usage summary line. format: int32 description: >- Describes usage summary line data used in Leadping API requests and responses. UsageCounterLine: type: object properties: key: type: string description: The stable key for this usage counter. label: type: string description: The human-readable label for this usage counter. value: type: number description: Numeric for this usage counter. format: double unit: type: string description: The unit label for this usage counter. sortOrder: type: integer description: The display order for this usage counter. format: int32 description: >- Describes one named usage total displayed in organization billing and activity summaries. UsageChannel: enum: - lead - sms - mms - email - voice - phone_number - warmup - website - openai - domain - 10dlc - payment - connection - automation type: string description: >- Identifies the messaging, calling, phone-number, lookup, or platform channel that generated billable usage. BillableUnit: enum: - lead_received - phone_identity_lookup - sms_segment - mms_message - email_message - voice_minute - phone_number_month - warmup_sms_segment - warmup_voice_minute - website_setup - openai_operation - domain_registration - 10dlc_application - 10dlc_campaign_month - payment_processing_fee - connection_action - automation_run type: string description: >- Identifies the metered unit used to price Leadping usage, such as a message, call minute, lookup, or phone number. UsageStatus: enum: - recorded - rated - pending_invoice - invoiced - charged - failed - refunded_credited - non_billable_internal - blocked_due_to_billing type: string description: >- Describes whether a metered usage record is pending, rated, billed, reconciled, excluded, or failed. securitySchemes: Bearer: type: http description: >- Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_. scheme: bearer bearerFormat: JWT or organization API key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.