Skip to content
BoxBilling
Search
Ctrl
K
Cancel
GitHub
X
Select theme
Dark
Light
Auto
Getting Started
Introduction
Quickstart
Architecture
Core Concepts
Data Models
Customers
Plans & Pricing
Subscriptions
Usage-Based Billing
Invoicing
Payments & Credits
Payments
Wallets
Coupons & Add-ons
Dunning
Credit Notes
Taxes
Plans & Access
Entitlements
Commitments
Usage Alerts & Thresholds
Platform
Webhooks
Integrations
Audit Logs & Data Exports
API Overview
Introduction
API Reference
Overview
Dashboard
Overview
Get dashboard statistics
Get recent activity feed
Get revenue analytics
Get customer metrics
Get subscription metrics
Get top usage metrics
Get revenue breakdown by plan
Get recent invoices for dashboard
Get recent subscriptions for dashboard
Get sparkline data for stat cards
Get revenue analytics deep-dive
Customers
Overview
List customers
Create customer
Get customer current usage
Get customer projected usage
Get customer past usage
Generate customer portal URL
Get customer health indicator
List customer applied add-ons
List customer integration mappings
Get customer
Update customer
Delete customer
List customer applied coupons
Billable Metrics
Overview
List billable metrics
Create billable metric
Get billable metrics statistics
Get plan counts per billable metric
Get plans using a billable metric
Get billable metric
Update billable metric
Delete billable metric
List metric filters
Create metric filter
Delete metric filter
Plans
Overview
List plans
Create plan
Get subscription counts per plan
Get plan
Update plan
Delete plan
Simulate plan pricing
Subscriptions
Overview
List subscriptions
Create subscription
Bulk pause subscriptions
Bulk resume subscriptions
Bulk terminate subscriptions
Get subscription
Update subscription
Terminate subscription
Get next billing date for a subscription
Preview plan change with price comparison and proration
Activate pending subscription
Pause subscription
Resume subscription
Cancel subscription
Get subscription lifecycle timeline
Get daily usage trend for a subscription
Get subscription entitlements
Events
Overview
Estimate fees for a hypothetical event
List events
Ingest event
Get event volume (events per hour)
Get event
Reprocess an event
Ingest event batch
Fees
Overview
List fees
Get fee
Update fee
Invoices
Overview
List invoices
Create a one-off invoice
Bulk finalize draft invoices
Bulk void invoices
Preview invoice
Get invoice
Update invoice
Delete draft invoice
Finalize invoice
Mark invoice paid
Void invoice
List invoice settlements
Send invoice email
Send payment reminder for overdue invoice
Get invoice PDF for inline preview
Download invoice PDF
Payments
Overview
List payments
Get payment
Delete payment
Record manual payment
Create checkout session
Handle payment webhook
Mark payment paid
Refund payment
Retry failed payment
Payment Methods
Overview
List payment methods
Create payment method
Get payment method
Delete payment method
Set default payment method
Create setup session
Wallets
Overview
List wallets
Create wallet
Get wallet
Update wallet
Terminate wallet
Top up wallet
List wallet transactions
Get wallet balance timeline
Get wallet depletion forecast
Transfer credits between wallets
Coupons
Overview
List coupons
Create coupon
Get coupon
Update coupon
Terminate coupon
Apply coupon to customer
Remove applied coupon
Get coupon analytics
Duplicate coupon
Add-ons
Overview
List add-ons
Create add-on
Get application counts per add-on
Get application history for an add-on
Get add-on
Update add-on
Delete add-on
Apply add-on to customer
Credit Notes
Overview
List credit notes
Create credit note
Get credit note
Update credit note
Finalize credit note
Void credit note
Send credit note email
Download credit note PDF
Taxes
Overview
List taxes
Create tax
List applied taxes
Apply tax to entity
Remove applied tax
Get tax application counts
Get entities a tax is applied to
Get tax
Update tax
Delete tax
Webhooks
Overview
List webhook endpoints
Create webhook endpoint
Get delivery stats per endpoint
Get webhook endpoint
Update webhook endpoint
Delete webhook endpoint
List recent webhooks
Get webhook details
Get webhook delivery attempts
Retry failed webhook
Organizations
Overview
List organizations
Create organization
Get current organization
Update current organization
List API keys
Create API key
Rotate API key
Revoke API key
Dunning
Overview
List dunning campaigns
Create dunning campaign
Get dunning campaign performance stats
Get dunning campaign
Update dunning campaign
Delete dunning campaign
Get campaign execution history
Get campaign timeline
Preview campaign execution
Payment Requests
Overview
List payment requests
Create payment request
Batch create payment requests for all customers with overdue invoices
Get payment request
Get payment attempt history
Commitments
Overview
List plan commitments
Create commitment
Update commitment
Delete commitment
Thresholds
Overview
List plan usage thresholds
Create plan usage threshold
List subscription usage thresholds
Create subscription usage threshold
Get current subscription usage
Delete usage threshold
Data Exports
Overview
List data exports
Create data export
Estimate export size
Get data export
Download data export
Integrations
Overview
List integrations
Create integration
Get integration
Update integration
Delete integration
Test integration connection
List integration customer mappings
List integration field mappings
List integration sync history
Audit Logs
Overview
List audit logs
Get audit trail for a resource
Billing Entities
Overview
List billing entities
Create billing entity
Get customer counts per billing entity
Get billing entity by code
Delete billing entity
Update billing entity
Features
Overview
List features
Create feature
Get plan counts per feature
Get feature by code
Delete feature
Update feature
Entitlements
Overview
List entitlements
Create entitlement
Copy entitlements from one plan to another
Delete entitlement
Update entitlement
Usage Alerts
Overview
List usage alerts
Create usage alert
Get usage alert
Delete usage alert
Update usage alert
Get usage alert status with current usage
List alert trigger history
Test a usage alert by checking current usage
Portal
Overview
Generate a portal JWT for a customer
Get portal dashboard summary
Get customer profile
Update customer profile
Get organization branding for portal
List customer invoices
Get invoice detail
Download invoice PDF
Preview invoice PDF inline
Pay an outstanding invoice
List payments for an invoice
Get current usage
List customer payments
Get wallet balance and transactions
List wallet transactions
Get wallet balance timeline
Request a wallet top-up
List customer payment methods
Add a payment method
Remove a payment method
Set default payment method
List customer subscriptions
Get subscription detail
List available plans
Preview plan change with proration
Change subscription plan
List available add-ons
List purchased add-ons
Purchase an add-on
List applied coupons
Redeem a coupon code
Get usage trend for a subscription
Get plan limits vs current usage
Get projected end-of-period usage
Notifications
Overview
List notifications
Get unread notification count
Mark a notification as read
Mark all notifications as read
Search
Global search across customers, invoices, subscriptions, and plans
Operations
Root
Research
Event Ingestion Summary
Ingestion Pattern Comparison
Capacity Planning
Comparison Matrix
API Direct Write
Direct ClickHouse Ingestion
Streaming Ingestion
GitHub
X
Select theme
Dark
Light
Auto
Overview
Dashboard
Section titled “Dashboard”
Analytics dashboard and overview statistics.
