apogee-ai-billing¶
Multi-tenant usage metering, plan management and RLS-isolated invoicing.
Esta página está sendo ampliada
As tabelas abaixo são geradas do código-fonte do pacote, portanto estão corretas. Guias narrativos e exemplos comentados estão sendo escritos módulo a módulo.
API pública¶
Tudo abaixo é exportado pela raiz do pacote, então from apogee_ai_billing import X funciona para cada nome.
| Camada | Símbolos |
|---|---|
| Application · DTOs | BenchDTO, InvoiceDTO, RecordDTO, SubscribeDTO |
| Application · Use cases | BenchInvoicingUseCase, GenerateInvoiceUseCase, ListPlansUseCase, RecordUsageUseCase, SubscribePlanUseCase |
| Domain | BillingPeriod, Invoice, InvoiceLine, InvoiceStatus, Plan, PriceTier, Subscription, UsageRecord |
| Domain · Enums | PlanKind |
| Domain · Exceptions | BillingError, InvoiceNotFoundException, PlanNotFoundException, SubscriptionNotFoundException |
| Domain · Protocols (ports) | IInvoiceRepository, IMeter, IPlanRepository, ISubscriptionRepository |
| Infrastructure | CompositeMeter, FlatPlan, InMemoryInvoiceRepository, InMemoryMeter, InMemoryPlanRepository, InMemorySubscriptionRepository, InvoiceBuilder, JsonInvoiceFormatter, MarkdownInvoiceFormatter, RequestMeter, TieredPlan, TokenMeter, UsagePlan |
Instalação¶
A instalação base não tem dependência externa obrigatória. Cada extra habilita um adapter.
| Extra | Traz |
|---|---|
stripe |
stripe>=8.0 |
CLI¶
Instalado como console script e registrado como plugin do apogee, então os mesmos subcomandos funcionam sob o binário global.
Leia a seguir¶
- Instalação
- Referência — todo símbolo público, gerado do código-fonte
- Apogee Framework — como os pacotes se encaixam