💳 Billing And Usage API
Plan transitions, invoicing, and resource consumption. Namespace-level quota limits and usage tracking.
- Category: Platform
- Complexity: moderate
- Paths: 25 | Schemas: 101
- Tier: Standard
- Related domains:
system,users
Use Cases
Section titled “Use Cases”- Manage subscription plans and billing transitions
- Configure payment methods and invoices
- Track resource quota usage across namespaces
- Monitor usage limits and capacity
Primary Resources
Section titled “Primary Resources”- subscription: Subscription for service entitlements
- quota: Resource quota for usage limits
- usage_report: Usage report for consumption tracking
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| POST | /api/data/namespaces/system/billing/usage_summary | Billing Usage Summary. |
| GET | /api/web/namespaces/{namespace}/usage/invoice_pdf | GetInvoicePdf. |
| GET | /api/web/namespaces/{namespace}/usage/invoices/custom_list | List invoices. |
| POST | /api/web/namespaces/{namespace}/billing/payment_method/{name}/primary | Make credit card primary. |
| POST | /api/web/namespaces/{namespace}/billing/payment_method/{name}/secondary | Make payment method secondary. |
| POST | /api/web/namespaces/{namespace}/billing/payment_method/{name}/swap-primary | Make payment method secondary. |
| POST | /api/web/namespaces/{namespace}/billing/payment_methods | Create payment method specification. |
| DELETE | /api/web/namespaces/{namespace}/billing/payment_methods/{name} | DELETE the specified payment method. |
| GET | /no_auth/namespaces/system/billing/plan_transition | GetPlanTransition. |
| POST | /api/web/namespaces/{namespace}/billing/plan_transition | InitiatePlanTransition. |
| POST | /api/web/namespaces/{metadata.namespace}/quotas | Create Quota. |
| PUT | /api/web/namespaces/{metadata.namespace}/quotas/{metadata.name} | Replace Quota. |
| GET | /api/web/namespaces/{namespace}/quota/limits | Custom GET Quota Limits. |
| GET | /api/web/namespaces/{namespace}/quota/usage | GET Quota Usage. |
| GET | /api/web/namespaces/{namespace}/quotas | List Quota. |
| GET | /api/web/namespaces/{namespace}/quotas/{name} | GET Quota |
| DELETE | /api/web/namespaces/{namespace}/quotas/{name} | DELETE Quota. |
| GET | /api/web/namespaces/{namespace}/subscriptions/custom_list | List Subscriptions. |
| POST | /api/web/namespaces/system/addon/subscribe | Subscribe to XC addon services. |
| POST | /api/web/namespaces/system/addon/unsubscribe | Unsubscribe to XC addon services. |
| POST | /api/web/namespaces/{namespace}/current_usage | List current usage details. |
| POST | /api/web/namespaces/{namespace}/hourly_usage_details | List hourly usage details. |
| POST | /api/web/namespaces/{namespace}/monthly_usage | List monthly usage details. |
| POST | /api/web/namespaces/{namespace}/usage_details | List usage details. |
| GET | /api/web/namespaces/system/usage_plans/current | GET current usage plan. |
| GET | /api/web/namespaces/system/usage_plans/custom_list | List Usage Plans. |