Namespace Reference — Modules
Billing
Curated JQL namespaces and examples for billing.
Billing namespaces cover customer accounts, subscription plans, subscriptions, cycles, invoices, invoice items, payments, providers, dedicated accounts, payment attempts, transactions, wallets, and invoice preferences.
Key namespaces and models
billing.Accountbilling.ProductCategorybilling.SubscriptionPlanbilling.SubscriptionPlanItembilling.Subscriptionbilling.SubscriptionItembilling.SubscriptionCyclebilling.Invoicebilling.InvoiceItembilling.Paymentbilling.PaymentProviderbilling.DedicatedAccountbilling.PaymentAttemptbilling.Transactionbilling.RecordBalancebilling.RecordWalletbilling.InvoicePreference
Common controller intents
billing.Subscription.createSubscriptionbilling.Subscription.cancelSubscriptionbilling.Invoice.createInvoicebilling.Invoice.downloadInvoicebilling.Invoice.sendInvoicebilling.Invoice.createPaymentLinkbilling.Invoice.verifyPaymentbilling.Payment.createPaymentbilling.Payment.reversePayment
Common model intents
Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.
Retrieve example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "billing.Invoice",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "billing.Account",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Acme Ltd",
14 "alias": "acme-ltd"
15}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.