> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runledger.co/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runledger.co/_mcp/server.

# API Reference

## Docs

- [Handle webhooks](https://docs.runledger.co/api-reference/handle-webhooks.md): Thin events, signed to the Standard Webhooks specification.
- [How configuration works](https://docs.runledger.co/api-reference/how-configuration-works.md): Read it, validate it, dry-run it, apply it in the sandbox, or propose it for live.
- [Access, actors and audit](https://docs.runledger.co/api-reference/access-and-audit.md): Scoped keys, who made each change, and the audit log.
- [Test in the sandbox](https://docs.runledger.co/api-reference/test-in-the-sandbox.md): Run a month of settlement in a few seconds.

## API Docs

- API Reference > The four calls [Create a checkout session](https://docs.runledger.co/api-reference/checkout.md)
- API Reference > The four calls [Check, and optionally hold](https://docs.runledger.co/api-reference/check.md)
- API Reference > The four calls [Track an event](https://docs.runledger.co/api-reference/track.md)
- API Reference > The four calls [Trace a model call](https://docs.runledger.co/api-reference/trace.md)
- API Reference > Customers [List customers](https://docs.runledger.co/api-reference/customers/list.md)
- API Reference > Customers [Create a customer](https://docs.runledger.co/api-reference/customers/create.md)
- API Reference > Customers [Retrieve a customer](https://docs.runledger.co/api-reference/customers/retrieve.md)
- API Reference > Customers [Update a customer](https://docs.runledger.co/api-reference/customers/update.md)
- API Reference > Customers > Balances [List a customer's balances](https://docs.runledger.co/api-reference/customers/balances/list.md)
- API Reference > Customers > Usage summary [Retrieve a customer's usage summary](https://docs.runledger.co/api-reference/customers/usage-summary/retrieve.md)
- API Reference > Customers > Auto top-up [Retrieve a customer's auto top-up](https://docs.runledger.co/api-reference/customers/auto-top-up/retrieve.md)
- API Reference > Customers > Auto top-up [Set a customer's auto top-up](https://docs.runledger.co/api-reference/customers/auto-top-up/set.md)
- API Reference > Customers > Auto top-up [Turn off a customer's auto top-up](https://docs.runledger.co/api-reference/customers/auto-top-up/delete.md)
- API Reference > Customer sessions [Create a customer session](https://docs.runledger.co/api-reference/customer-sessions/create.md)
- API Reference > Credits and holds > Credit types [List credit types](https://docs.runledger.co/api-reference/credit-types/list.md)
- API Reference > Credits and holds > Credit types [Create a credit type](https://docs.runledger.co/api-reference/credit-types/create.md)
- API Reference > Credits and holds > Credit types [Retrieve a credit type](https://docs.runledger.co/api-reference/credit-types/retrieve.md)
- API Reference > Credits and holds > Credit types [Update a credit type](https://docs.runledger.co/api-reference/credit-types/update.md)
- API Reference > Credits and holds > Credit grants [List credit grants](https://docs.runledger.co/api-reference/credit-grants/list.md)
- API Reference > Credits and holds > Credit grants [Grant credits](https://docs.runledger.co/api-reference/credit-grants/create.md)
- API Reference > Credits and holds > Credit grants [Retrieve a credit grant](https://docs.runledger.co/api-reference/credit-grants/retrieve.md)
- API Reference > Credits and holds > Credit grants [Void a credit grant](https://docs.runledger.co/api-reference/credit-grants/void.md)
- API Reference > Credits and holds > Holds [List holds](https://docs.runledger.co/api-reference/holds/list.md)
- API Reference > Credits and holds > Holds [Retrieve a hold](https://docs.runledger.co/api-reference/holds/retrieve.md)
- API Reference > Credits and holds > Holds [Extend a hold](https://docs.runledger.co/api-reference/holds/extend.md)
- API Reference > Credits and holds > Holds [Release a hold](https://docs.runledger.co/api-reference/holds/release.md)
- API Reference > Credits and holds > Ledger entries [List ledger entries](https://docs.runledger.co/api-reference/ledger-entries/list.md)
- API Reference > Credits and holds > Ledger entries [Retrieve a ledger entry](https://docs.runledger.co/api-reference/ledger-entries/retrieve.md)
- API Reference > Usage and cost tracking > Events [List events](https://docs.runledger.co/api-reference/events/list.md)
- API Reference > Usage and cost tracking > Events [Track events in a batch](https://docs.runledger.co/api-reference/events/batch.md)
- API Reference > Usage and cost tracking > Events [Preview an event](https://docs.runledger.co/api-reference/events/preview.md)
- API Reference > Usage and cost tracking > Events [Retrieve an event](https://docs.runledger.co/api-reference/events/retrieve.md)
- API Reference > Usage and cost tracking > Costs [List costs](https://docs.runledger.co/api-reference/costs/list.md)
- API Reference > Usage and cost tracking > Costs [Trace model calls in a batch](https://docs.runledger.co/api-reference/costs/batch.md)
- API Reference > Usage and cost tracking > Runs [Summarize runs](https://docs.runledger.co/api-reference/runs/summary.md)
- API Reference > Usage and cost tracking > Runs [Retrieve a run](https://docs.runledger.co/api-reference/runs/retrieve.md)
- API Reference > Usage and cost tracking > Runs [List runs](https://docs.runledger.co/api-reference/runs/list.md)
- API Reference > Outcomes > Outcome definitions [List outcome definitions](https://docs.runledger.co/api-reference/outcome-definitions/list.md)
- API Reference > Outcomes > Outcome definitions [Create an outcome definition](https://docs.runledger.co/api-reference/outcome-definitions/create.md)
- API Reference > Outcomes > Outcome definitions [Retrieve an outcome definition](https://docs.runledger.co/api-reference/outcome-definitions/retrieve.md)
- API Reference > Outcomes > Outcome definitions [Update an outcome definition](https://docs.runledger.co/api-reference/outcome-definitions/update.md)
- API Reference > Outcomes > Outcome definitions [List outcome definition versions](https://docs.runledger.co/api-reference/outcome-definitions/versions.md)
- API Reference > Outcomes > Outcome definition presets [List outcome clock presets](https://docs.runledger.co/api-reference/outcome-definition-presets/list.md)
- API Reference > Outcomes > Outcome charges [List outcome charges](https://docs.runledger.co/api-reference/outcome-charges/list.md)
- API Reference > Outcomes > Outcome charges [Retrieve an outcome charge](https://docs.runledger.co/api-reference/outcome-charges/retrieve.md)
- API Reference > Outcomes > Outcome charges [Confirm an outcome charge early](https://docs.runledger.co/api-reference/outcome-charges/confirm.md)
- API Reference > Outcomes > Outcome charges [Reverse an outcome charge](https://docs.runledger.co/api-reference/outcome-charges/reverse.md)
- API Reference > Outcomes > Reversals [List reversals](https://docs.runledger.co/api-reference/reversals/list.md)
- API Reference > Outcomes > Reversals [Retrieve a reversal](https://docs.runledger.co/api-reference/reversals/retrieve.md)
- API Reference > Outcomes > Disputes [List disputes](https://docs.runledger.co/api-reference/disputes/list.md)
- API Reference > Outcomes > Disputes [Open a dispute](https://docs.runledger.co/api-reference/disputes/create.md)
- API Reference > Outcomes > Disputes [Retrieve a dispute](https://docs.runledger.co/api-reference/disputes/retrieve.md)
- API Reference > Outcomes > Disputes [Resolve a dispute](https://docs.runledger.co/api-reference/disputes/resolve.md)
- API Reference > Plans and billing > Plans [List plans](https://docs.runledger.co/api-reference/plans/list.md)
- API Reference > Plans and billing > Plans [Create a plan](https://docs.runledger.co/api-reference/plans/create.md)
- API Reference > Plans and billing > Plans [Retrieve a plan](https://docs.runledger.co/api-reference/plans/retrieve.md)
- API Reference > Plans and billing > Plans [Update a plan](https://docs.runledger.co/api-reference/plans/update.md)
- API Reference > Plans and billing > Plans [Archive a plan](https://docs.runledger.co/api-reference/plans/archive.md)
- API Reference > Plans and billing > Subscriptions [List subscriptions](https://docs.runledger.co/api-reference/subscriptions/list.md)
- API Reference > Plans and billing > Subscriptions [Create a subscription](https://docs.runledger.co/api-reference/subscriptions/create.md)
- API Reference > Plans and billing > Subscriptions [Retrieve a subscription](https://docs.runledger.co/api-reference/subscriptions/retrieve.md)
- API Reference > Plans and billing > Subscriptions [Update a subscription](https://docs.runledger.co/api-reference/subscriptions/update.md)
- API Reference > Plans and billing > Subscriptions [Change plan](https://docs.runledger.co/api-reference/subscriptions/change-plan.md)
- API Reference > Plans and billing > Subscriptions [Cancel a subscription](https://docs.runledger.co/api-reference/subscriptions/cancel.md)
- API Reference > Plans and billing > Invoices [List invoices](https://docs.runledger.co/api-reference/invoices/list.md)
- API Reference > Plans and billing > Invoices [Retrieve an invoice](https://docs.runledger.co/api-reference/invoices/retrieve.md)
- API Reference > Plans and billing > Invoices [Finalize an invoice now](https://docs.runledger.co/api-reference/invoices/finalize.md)
- API Reference > Plans and billing > Invoices [Retry payment](https://docs.runledger.co/api-reference/invoices/pay.md)
- API Reference > Plans and billing > Checkout sessions [Retrieve a checkout session](https://docs.runledger.co/api-reference/checkout-sessions/retrieve.md)
- API Reference > Spend limits [List spend limits](https://docs.runledger.co/api-reference/spend-limits/list.md)
- API Reference > Spend limits [Create a spend limit](https://docs.runledger.co/api-reference/spend-limits/create.md)
- API Reference > Spend limits [Retrieve a spend limit](https://docs.runledger.co/api-reference/spend-limits/retrieve.md)
- API Reference > Spend limits [Update a spend limit](https://docs.runledger.co/api-reference/spend-limits/update.md)
- API Reference > Spend limits [Delete a spend limit](https://docs.runledger.co/api-reference/spend-limits/delete.md)
- API Reference > Providers and payments > Payment providers [List payment providers](https://docs.runledger.co/api-reference/payment-providers/list.md)
- API Reference > Providers and payments > Payment providers [Connect a payment provider](https://docs.runledger.co/api-reference/payment-providers/create.md)
- API Reference > Providers and payments > Payment providers [Retrieve a payment provider](https://docs.runledger.co/api-reference/payment-providers/retrieve.md)
- API Reference > Providers and payments > Payment providers [Update a payment provider](https://docs.runledger.co/api-reference/payment-providers/update.md)
- API Reference > Providers and payments > Payment providers [Remove a payment provider](https://docs.runledger.co/api-reference/payment-providers/delete.md)
- API Reference > Providers and payments > Payment providers [Resolve which provider a payment would use](https://docs.runledger.co/api-reference/payment-providers/resolve.md)
- API Reference > Providers and payments > Routing rules [List routing rules](https://docs.runledger.co/api-reference/routing-rules/list.md)
- API Reference > Providers and payments > Routing rules [Create a routing rule](https://docs.runledger.co/api-reference/routing-rules/create.md)
- API Reference > Providers and payments > Routing rules [Update a routing rule](https://docs.runledger.co/api-reference/routing-rules/update.md)
- API Reference > Providers and payments > Routing rules [Delete a routing rule](https://docs.runledger.co/api-reference/routing-rules/delete.md)
- API Reference > Providers and payments > Payments [List payments](https://docs.runledger.co/api-reference/payments/list.md)
- API Reference > Providers and payments > Payments [Retrieve a payment](https://docs.runledger.co/api-reference/payments/retrieve.md)
- API Reference > Pricing from cost > Provider price catalog > Providers [List catalog providers](https://docs.runledger.co/api-reference/catalog/providers/list.md)
- API Reference > Pricing from cost > Provider price catalog > Models [List catalog models](https://docs.runledger.co/api-reference/catalog/models/list.md)
- API Reference > Pricing from cost > Provider price catalog > Models [Retrieve a catalog model](https://docs.runledger.co/api-reference/catalog/models/retrieve.md)
- API Reference > Pricing from cost > Provider price catalog > Prices [List catalog price versions](https://docs.runledger.co/api-reference/catalog/prices/list.md)
- API Reference > Pricing from cost > Provider price catalog > Prices [Retrieve a catalog price version](https://docs.runledger.co/api-reference/catalog/prices/retrieve.md)
- API Reference > Pricing from cost > Cost models [List cost models](https://docs.runledger.co/api-reference/cost-models/list.md)
- API Reference > Pricing from cost > Cost models [Create a cost model](https://docs.runledger.co/api-reference/cost-models/create.md)
- API Reference > Pricing from cost > Cost models [Retrieve a cost model](https://docs.runledger.co/api-reference/cost-models/retrieve.md)
- API Reference > Pricing from cost > Cost models [Update a cost model](https://docs.runledger.co/api-reference/cost-models/update.md)
- API Reference > Pricing from cost > Rate cards [List rate cards](https://docs.runledger.co/api-reference/rate-cards/list.md)
- API Reference > Pricing from cost > Rate cards [Create a rate card](https://docs.runledger.co/api-reference/rate-cards/create.md)
- API Reference > Pricing from cost > Rate cards [Retrieve a rate card](https://docs.runledger.co/api-reference/rate-cards/retrieve.md)
- API Reference > Pricing from cost > Rate cards [Activate a rate card](https://docs.runledger.co/api-reference/rate-cards/activate.md)
- API Reference > Pricing from cost > Price rules [List price rules](https://docs.runledger.co/api-reference/price-rules/list.md)
- API Reference > Pricing from cost > Price rules [Create a price rule](https://docs.runledger.co/api-reference/price-rules/create.md)
- API Reference > Pricing from cost > Price rules [Retrieve a price rule](https://docs.runledger.co/api-reference/price-rules/retrieve.md)
- API Reference > Pricing from cost > Price rules [Update a price rule](https://docs.runledger.co/api-reference/price-rules/update.md)
- API Reference > Pricing from cost > Price rules [Delete a price rule](https://docs.runledger.co/api-reference/price-rules/delete.md)
- API Reference > Pricing from cost > Price rules [List price rule versions](https://docs.runledger.co/api-reference/price-rules/versions.md)
- API Reference > Pricing from cost > Margin guardrails [List margin guardrails](https://docs.runledger.co/api-reference/margin-guardrails/list.md)
- API Reference > Pricing from cost > Margin guardrails [Create a margin guardrail](https://docs.runledger.co/api-reference/margin-guardrails/create.md)
- API Reference > Pricing from cost > Margin guardrails [Retrieve a margin guardrail](https://docs.runledger.co/api-reference/margin-guardrails/retrieve.md)
- API Reference > Pricing from cost > Margin guardrails [Update a margin guardrail](https://docs.runledger.co/api-reference/margin-guardrails/update.md)
- API Reference > Pricing from cost > Margin guardrails [Delete a margin guardrail](https://docs.runledger.co/api-reference/margin-guardrails/delete.md)
- API Reference > Pricing from cost > Simulations [List simulations](https://docs.runledger.co/api-reference/simulations/list.md)
- API Reference > Pricing from cost > Simulations [Run a simulation](https://docs.runledger.co/api-reference/simulations/create.md)
- API Reference > Pricing from cost > Simulations [Retrieve a simulation](https://docs.runledger.co/api-reference/simulations/retrieve.md)
- API Reference > Reporting > Reports [Revenue report](https://docs.runledger.co/api-reference/reports/revenue.md)
- API Reference > Reporting > Reports [Outcome report](https://docs.runledger.co/api-reference/reports/outcomes.md)
- API Reference > Reporting > Reports [Margin report](https://docs.runledger.co/api-reference/reports/margin.md)
- API Reference > Reporting > Reports [Credits report](https://docs.runledger.co/api-reference/reports/credits.md)
- API Reference > Reporting > Reports [Payments report](https://docs.runledger.co/api-reference/reports/payments.md)
- API Reference > Reporting > Reports [Allowance use report](https://docs.runledger.co/api-reference/reports/allowance-use.md)
- API Reference > Reporting > Reports [Cost report](https://docs.runledger.co/api-reference/reports/cost.md)
- API Reference > Reporting > Reports [Top-up chargeback report](https://docs.runledger.co/api-reference/reports/topup-chargebacks.md)
- API Reference > Reporting > Reports [Breakage report](https://docs.runledger.co/api-reference/reports/breakage.md)
- API Reference > Reporting > Exports [List exports](https://docs.runledger.co/api-reference/exports/list.md)
- API Reference > Reporting > Exports [Create an export](https://docs.runledger.co/api-reference/exports/create.md)
- API Reference > Reporting > Exports [Retrieve an export](https://docs.runledger.co/api-reference/exports/retrieve.md)
- API Reference > Reporting > Reconciliations [List reconciliations](https://docs.runledger.co/api-reference/reconciliations/list.md)
- API Reference > Reporting > Reconciliations [Retrieve a reconciliation](https://docs.runledger.co/api-reference/reconciliations/retrieve.md)
- API Reference > Webhooks > Event payload [Runledger event](https://docs.runledger.co/api-reference/webhooks/webhook-event.md)
- API Reference > Webhooks > Webhook endpoints [List webhook endpoints](https://docs.runledger.co/api-reference/webhook-endpoints/list.md)
- API Reference > Webhooks > Webhook endpoints [Create a webhook endpoint](https://docs.runledger.co/api-reference/webhook-endpoints/create.md)
- API Reference > Webhooks > Webhook endpoints [Retrieve a webhook endpoint](https://docs.runledger.co/api-reference/webhook-endpoints/retrieve.md)
- API Reference > Webhooks > Webhook endpoints [Update a webhook endpoint](https://docs.runledger.co/api-reference/webhook-endpoints/update.md)
- API Reference > Webhooks > Webhook endpoints [Delete a webhook endpoint](https://docs.runledger.co/api-reference/webhook-endpoints/delete.md)
- API Reference > Webhooks > Webhook endpoints [Rotate a webhook secret](https://docs.runledger.co/api-reference/webhook-endpoints/rotate-secret.md)
- API Reference > Webhooks > Webhook events [List webhook events](https://docs.runledger.co/api-reference/webhook-events/list.md)
- API Reference > Webhooks > Webhook events [Retrieve a webhook event](https://docs.runledger.co/api-reference/webhook-events/retrieve.md)
- API Reference > Webhooks > Webhook events [Redeliver a webhook event](https://docs.runledger.co/api-reference/webhook-events/redeliver.md)
- API Reference > Configuration and access > Configuration [Retrieve the configuration](https://docs.runledger.co/api-reference/config/retrieve.md)
- API Reference > Configuration and access > Configuration [Replace the configuration](https://docs.runledger.co/api-reference/config/replace.md)
- API Reference > Configuration and access > Configuration [Validate a configuration document](https://docs.runledger.co/api-reference/config/validate.md)
- API Reference > Configuration and access > Configuration [Apply a configuration document in the sandbox](https://docs.runledger.co/api-reference/config/apply.md)
- API Reference > Configuration and access > Configuration proposals [List configuration proposals](https://docs.runledger.co/api-reference/config-proposals/list.md)
- API Reference > Configuration and access > Configuration proposals [Propose a configuration change](https://docs.runledger.co/api-reference/config-proposals/create.md)
- API Reference > Configuration and access > Configuration proposals [Retrieve a configuration proposal](https://docs.runledger.co/api-reference/config-proposals/retrieve.md)
- API Reference > Configuration and access > Configuration proposals [Approve a configuration proposal](https://docs.runledger.co/api-reference/config-proposals/approve.md)
- API Reference > Configuration and access > Configuration proposals [Reject a configuration proposal](https://docs.runledger.co/api-reference/config-proposals/reject.md)
- API Reference > Configuration and access > Notification rules [List notification rules](https://docs.runledger.co/api-reference/notification-rules/list.md)
- API Reference > Configuration and access > Notification rules [Create a notification rule](https://docs.runledger.co/api-reference/notification-rules/create.md)
- API Reference > Configuration and access > Notification rules [Update a notification rule](https://docs.runledger.co/api-reference/notification-rules/update.md)
- API Reference > Configuration and access > Notification rules [Delete a notification rule](https://docs.runledger.co/api-reference/notification-rules/delete.md)
- API Reference > Configuration and access > Audit log [List audit events](https://docs.runledger.co/api-reference/audit-events/list.md)
- API Reference > Configuration and access > API keys [List API keys](https://docs.runledger.co/api-reference/api-keys/list.md)
- API Reference > Configuration and access > Account [Retrieve your account](https://docs.runledger.co/api-reference/account/retrieve.md)
- API Reference > Configuration and access > Request logs [List request logs](https://docs.runledger.co/api-reference/request-logs/list.md)
- API Reference > Configuration and access > Request logs [Retrieve a request log](https://docs.runledger.co/api-reference/request-logs/retrieve.md)
- API Reference > Configuration and access > Integration checks [Run an integration check](https://docs.runledger.co/api-reference/integration-checks/create.md)
- API Reference > Sandbox and testing > Test clocks [List test clocks](https://docs.runledger.co/api-reference/test-clocks/list.md)
- API Reference > Sandbox and testing > Test clocks [Create a test clock](https://docs.runledger.co/api-reference/test-clocks/create.md)
- API Reference > Sandbox and testing > Test clocks [Retrieve a test clock](https://docs.runledger.co/api-reference/test-clocks/retrieve.md)
- API Reference > Sandbox and testing > Test clocks [Delete a test clock](https://docs.runledger.co/api-reference/test-clocks/delete.md)
- API Reference > Sandbox and testing > Test clocks [Advance a test clock](https://docs.runledger.co/api-reference/test-clocks/advance.md)
- API Reference > Sandbox and testing > Test helpers [Complete a checkout session](https://docs.runledger.co/api-reference/test-helpers/complete-checkout-session.md)
- API Reference > Sandbox and testing > Test helpers [Send a test webhook event](https://docs.runledger.co/api-reference/test-helpers/send-webhook-event.md)
- API Reference > Sandbox and testing > Test helpers [Simulate an invoice payment](https://docs.runledger.co/api-reference/test-helpers/simulate-invoice-payment.md)
- API Reference > Sandbox and testing > Test helpers [Complete or fail an auto top-up](https://docs.runledger.co/api-reference/test-helpers/resolve-auto-top-up.md)
- API Reference > Sandbox and testing > Reset the sandbox [Reset the sandbox](https://docs.runledger.co/api-reference/sandbox/reset.md)
- API Reference > Prices [Hold a price change for a price rule](https://docs.runledger.co/api-reference/prices/catalog-prices-hold.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.runledger.co/openapi.json)
- [OpenAPI YAML](https://docs.runledger.co/openapi.yaml)