Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 122 additions & 0 deletions latest/llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
# Kill Bill Documentation

> Official documentation for Kill Bill, Kaui and plugins.

## Understand Kill Bill and Getting Started with Kill Bill

- https://docs.killbill.io/latest/what_is_kill_bill.html — High-level overview of what Kill Bill is and the problems it solves.
- https://docs.killbill.io/latest/features.html — Summary of Kill Bill's core feature set.
- https://docs.killbill.io/latest/premium_features.html — Overview of premium (paid/enterprise) features on top of open-source Kill Bill.
- https://docs.killbill.io/latest/demo.html — How to spin up and explore the Kill Bill demo environment.
- https://docs.killbill.io/latest/faq.html — Frequently asked questions about Kill Bill.
- https://docs.killbill.io/latest/Kill-Bill-Glossary.html — Glossary of Kill Bill terms and concepts.
- https://docs.killbill.io/latest/getting_started.html — Entry-point guide for installing Kill Bill for the first time.
- https://docs.killbill.io/latest/killbill-changelog.html — Changelog of releases and notable changes to Kill Bill/Kaui.
- https://github.com/killbill/killbill/releases — GitHub releases page for Kill Bill core.
- https://github.com/killbill/killbill-admin-ui-standalone/releases — GitHub releases page for Kaui (the admin UI).
- https://docs.killbill.io/latest/quick_start_with_kaui.html — Quick-start guide to using Kaui.
- https://docs.killbill.io/latest/quick_start_with_kb_api.html — Quick-start guide to using the Kill Bill REST API directly.
- https://docs.killbill.io/latest/stripe_plugin.html — Kill Bill/Stripe Integration demo.
- https://docs.killbill.io/latest/userguide_subscription.html — User guide covering catalog/subscription/entitlement/invoice/payment concepts and workflows.
- https://docs.killbill.io/latest/userguide_payment.html — User guide covering the payment subsystem and workflows.
- https://docs.killbill.io/latest/internationalization.html — Overview of Kill Bill's internationalization/localization support (currencies, languages, time zones).
- https://docs.killbill.io/latest/migration_guide.html — Guide for migrating data/systems into Kill Bill.

## Deploy, Operate, and Integrate

- https://docs.killbill.io/latest/userguide_configuration.html — Reference for configuring Kill Bill (system properties, per-tenant config).
- https://docs.killbill.io/latest/userguide_deployment.html — General guide to deploying Kill Bill in production.
- https://docs.killbill.io/latest/deploy_to_kubernetes.html — Guide to deploying Kill Bill on Kubernetes.
- https://docs.killbill.io/latest/how-to-upgrade-the-database.html — Steps for running database schema upgrades between versions.
- https://docs.killbill.io/latest/PostgreSQL.html — Notes on running Kill Bill with PostgreSQL.
- https://docs.killbill.io/latest/user_management.html — Guide to managing admin users, roles, and permissions.
- https://docs.killbill.io/latest/how-to-use-kpm-diagnostic.html — How to use KPM's diagnostic tooling to troubleshoot a deployment.
- https://apidocs.killbill.io/ — Full REST API reference documentation.
- https://docs.killbill.io/latest/swagger_documentation.html — Guide to the Swagger/OpenAPI spec for the Kill Bill API.
- https://docs.killbill.io/latest/postman.html — Guide to using the Postman collection for exploring the API.
- https://docs.killbill.io/latest/push_notifications.html — Guide to configuring push notifications for Kill Bill events.
- https://docs.killbill.io/latest/kill_bill_events.html — Reference for the Kill Bill event types.
- https://docs.killbill.io/latest/java_client.html — Guide to using the Java client library.
- https://github.com/killbill/killbill-client-ruby — Ruby client library for the Kill Bill API.
- https://github.com/killbill/killbill-client-php — PHP client library for the Kill Bill API.
- https://github.com/killbill/killbill-client-js — JavaScript client library for the Kill Bill API.
- https://github.com/killbill/killbill-client-python — Python client library for the Kill Bill API.
- https://github.com/killbill/kbcli — Command-line client (kbcli) for interacting with Kill Bill.
- https://docs.killbill.io/latest/debugging.html — Tips and tools for debugging a running Kill Bill instance.

## Plugins

- https://docs.killbill.io/latest/plugin_introduction.html — Introduction to the Kill Bill plugin architecture.
- https://docs.killbill.io/latest/plugin_development.html — Guide to developing a custom Kill Bill plugin.
- https://docs.killbill.io/latest/plugin_installation.html — Guide to install and register a plugin.
- https://docs.killbill.io/latest/plugin_management.html — How to manage (install/uninstall/enable/disable) plugins via API.
- https://docs.killbill.io/latest/plugin_use_cases.html — Overview of specific plugin use cases.
- https://docs.killbill.io/latest/email-notification-plugin.html — Setup and usage guide for the email notification plugin.
- https://docs.killbill.io/latest/userguide_analytics.html — Setup and usage guide for the Analytics plugin.
- https://docs.killbill.io/latest/avatax-plugin.html — Setup and usage guide for the Avalara AvaTax tax plugin.
- https://docs.killbill.io/latest/braintree-plugin.html — Setup and usage guide for the Braintree payment plugin.
- https://docs.killbill.io/latest/notification_plugin.html — Reference for building/using generic notification plugins.
- https://docs.killbill.io/latest/payment_plugin.html — Reference for building/using a payment plugin.
- https://docs.killbill.io/latest/payment_control_plugin.html — Reference for payment control plugins (routing/retry logic).
- https://docs.killbill.io/latest/usage_plugin.html — Reference for usage plugins used in metered/consumable billing.
- https://docs.killbill.io/latest/invoice_plugin.html — Reference for invoice plugins that customize invoice generation.
- https://docs.killbill.io/latest/catalog_plugin.html — Reference for catalog plugins that serve dynamic catalogs.
- https://docs.killbill.io/latest/entitlement_plugin.html — Reference for entitlement plugins customizing subscription behavior.
- https://docs.killbill.io/latest/custom-email-invoice-formatter.html — Guide to customizing email invoices.

## Tutorials and Examples

- https://docs.killbill.io/latest/plan_alignment.html — Explanation of plan/phase alignment rules during subscription changes.
- https://docs.killbill.io/latest/overdue.html — Guide to configuring Kill Bill's payment retry system and overdue states.
- https://docs.killbill.io/latest/consumable_in_arrear.html — Tutorial on setting up consumable-in-arrear (usage-based) billing.
- https://docs.killbill.io/latest/ha.html — Guide to configuring Kill Bill for high availability.
- https://docs.killbill.io/latest/catalog-examples.html — Walkthroughs of sample catalog XMLs showing how billing modes, plan phases, multi-plan/add-on setups, billing/subscription alignment rules, usage billing, and catalog versioning each affect resulting invoices.
- https://docs.killbill.io/latest/invoice_examples.html — Walks through how an invoice's charged amount and balance are computed across scenarios like recurring billing, account/invoice credits, item adjustments, and refunds.
- https://docs.killbill.io/latest/invoice_templates.html — Guide to customizing invoice templates.

## AWS

- https://docs.killbill.io/latest/aws.html — Overview of options for running Kill Bill on AWS.
- https://docs.killbill.io/latest/how-to-set-up-a-single-tier-system.html — Guide to setting up a single-tier AWS deployment.
- https://docs.killbill.io/latest/how-to-set-up-a-multi-tier-system.html - Guide to setting up a multi-tier AWS deployment.
- https://docs.killbill.io/latest/how-to-set-up-a-cloud-formation-system.html — Guide to deploying Kill Bill on AWS via CloudFormation.
- https://docs.killbill.io/latest/aws-container.html — Guide to running the Kill Bill container image on AWS.
- https://docs.killbill.io/latest/how-to-maintain-a-single-tier-system.html — Ongoing maintenance guide for a single-tier AWS deployment.
- https://docs.killbill.io/latest/how-to-maintain-a-multi-tier-system.html — Ongoing maintenance guide for a multi-tier AWS deployment.
- https://docs.killbill.io/latest/how-to-maintain-a-cloud-formation-system.html — Ongoing maintenance guide for a CloudFormation-based deployment.
- https://docs.killbill.io/latest/explanation-https-and-certificates.html — Explanation of HTTPS/TLS certificate setup for Kill Bill.
- https://docs.killbill.io/latest/how-to-add-a-certificate-using-ACM.html — Guide to attaching an AWS ACM certificate to a deployment.
- https://docs.killbill.io/latest/using-ses-with-aws.html — Guide to configuring AWS SES for outbound email.
- https://docs.killbill.io/latest/events-to-aws-sqs.html — Guide to forwarding Kill Bill events to AWS SQS.
- https://docs.killbill.io/latest/aws-tools.html — Overview of supporting AWS tooling used with Kill Bill.
- https://docs.killbill.io/latest/metrics-datadog.html — Guide to sending Kill Bill metrics to Datadog.
- https://docs.killbill.io/latest/metrics-newrelic.html — Guide to sending Kill Bill metrics to New Relic.
- https://docs.killbill.io/latest/metrics-cloudwatch.html — Guide to sending Kill Bill metrics to AWS CloudWatch.
- https://docs.killbill.io/latest/errors-rollbar.html — Guide to forwarding Kill Bill errors to Rollbar.
- https://docs.killbill.io/latest/errors-sentry.html — Guide to forwarding Kill Bill errors to Sentry.

## Aviate

- https://docs.killbill.io/latest/what_is_aviate.html — Overview of Aviate and what it adds on top of Kill Bill.
- https://docs.killbill.io/latest/aviate-changelog.html — Changelog of Aviate UI and Aviate plugin.
- https://docs.killbill.io/latest/aviate-deployment-management.html — Guide to managing (adding/editing/deleting) Kill Bill deployments in Aviate UI.
- https://docs.killbill.io/latest/aviate-getting-started.html — Getting-started guide for Aviate.
- https://docs.killbill.io/latest/aviate-catalog-guide.html — Guide to building and managing catalogs in Aviate.
- https://docs.killbill.io/latest/how-to-install-the-aviate-plugin.html — Step-by-step install guide for the Aviate plugin.
- https://docs.killbill.io/latest/aviate-database-migrations.html — Guide to running Aviate's database migrations.
- https://docs.killbill.io/latest/aviate-health.html — Guide to Aviate's health-check endpoints/monitoring.
- https://docs.killbill.io/latest/aviate-custom-invoice-sequencing.html — Guide to configuring custom invoice numbering/sequencing in Aviate.
- https://docs.killbill.io/latest/aviate-catalog-plugin.html — Guide to the Aviate catalog plugin, which lets you manage plans/products/pricelists individually via API (instead of whole XML catalog versions).
- https://docs.killbill.io/latest/aviate-metering.html — Guide to creating billing meters and submitting usage events via Aviate.
- https://docs.killbill.io/latest/aviate-wallet.html — Guide to Aviate's prepaid credit wallet per account.
- https://docs.killbill.io/latest/aviate-coupons.html — Guide to configuring and applying coupons in Aviate.
- https://docs.killbill.io/latest/aviate-tax.html — Guide to tax configuration and calculation in Aviate.
- https://docs.killbill.io/latest/aviate-usage-ai-tutorial.html — End-to-end tutorial simulating AI token billing: setting up a billing meter and usage-based catalog plan, creating a wallet with paid credits and auto top-off, recording usage events, and invoicing.
- https://docs.killbill.io/latest/aviate-tax-tutorial.html — Step-by-step tutorial for setting up tax in Aviate UI.

## Internal

- https://docs.killbill.io/latest/internal_design.html — Overview of Kill Bill's internal architecture and design principles.
- https://docs.killbill.io/latest/entitlement_subsystem.html — Deep dive into the entitlement/subscription subsystem internals.
- https://docs.killbill.io/latest/invoice_subsystem.html — Deep dive into the invoicing subsystem internals.
- https://docs.killbill.io/latest/development.html — Guide for contributors building/developing Kill Bill itself.
Loading