bxb 0.6.0

BoxBilling

bxb

A comprehensive usage-based billing platform API. Manage customers, plans, subscriptions, invoices, payments, wallets, coupons, credit notes, taxes, webhooks, and more.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.6.0
• Package version: 0.6.0
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/boxbilling/bxb.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/boxbilling/bxb.git)

Then import the package:

import bxb

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import bxb

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import bxb
from bxb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = bxb.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with bxb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bxb.AddOnsApi(api_client)
    apply_add_on_request = bxb.ApplyAddOnRequest() # ApplyAddOnRequest | 

    try:
        # Apply add-on to customer
        api_response = api_instance.apply_add_on_v1_add_ons_apply_post(apply_add_on_request)
        print("The response of AddOnsApi->apply_add_on_v1_add_ons_apply_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddOnsApi->apply_add_on_v1_add_ons_apply_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AddOnsApi	apply_add_on_v1_add_ons_apply_post	POST /v1/add_ons/apply	Apply add-on to customer
AddOnsApi	create_add_on_v1_add_ons_post	POST /v1/add_ons/	Create add-on
AddOnsApi	delete_add_on_v1_add_ons_code_delete	DELETE /v1/add_ons/{code}	Delete add-on
AddOnsApi	get_add_on_applications_v1_add_ons_code_applications_get	GET /v1/add_ons/{code}/applications	Get application history for an add-on
AddOnsApi	get_add_on_v1_add_ons_code_get	GET /v1/add_ons/{code}	Get add-on
AddOnsApi	get_application_counts_v1_add_ons_application_counts_get	GET /v1/add_ons/application_counts	Get application counts per add-on
AddOnsApi	list_add_ons_v1_add_ons_get	GET /v1/add_ons/	List add-ons
AddOnsApi	update_add_on_v1_add_ons_code_put	PUT /v1/add_ons/{code}	Update add-on
AuditLogsApi	get_resource_audit_trail_v1_audit_logs_resource_type_resource_id_get	GET /v1/audit_logs/{resource_type}/{resource_id}	Get audit trail for a resource
AuditLogsApi	list_audit_logs_v1_audit_logs_get	GET /v1/audit_logs/	List audit logs
BillableMetricsApi	create_billable_metric_filter_v1_billable_metrics_code_filters_post	POST /v1/billable_metrics/{code}/filters	Create metric filter
BillableMetricsApi	create_billable_metric_v1_billable_metrics_post	POST /v1/billable_metrics/	Create billable metric
BillableMetricsApi	delete_billable_metric_filter_v1_billable_metrics_code_filters_filter_id_delete	DELETE /v1/billable_metrics/{code}/filters/{filter_id}	Delete metric filter
BillableMetricsApi	delete_billable_metric_v1_billable_metrics_metric_id_delete	DELETE /v1/billable_metrics/{metric_id}	Delete billable metric
BillableMetricsApi	get_billable_metric_plan_counts_v1_billable_metrics_plan_counts_get	GET /v1/billable_metrics/plan_counts	Get plan counts per billable metric
BillableMetricsApi	get_billable_metric_v1_billable_metrics_metric_id_get	GET /v1/billable_metrics/{metric_id}	Get billable metric
BillableMetricsApi	get_billable_metrics_stats_v1_billable_metrics_stats_get	GET /v1/billable_metrics/stats	Get billable metrics statistics
BillableMetricsApi	get_metric_plans_v1_billable_metrics_metric_id_plans_get	GET /v1/billable_metrics/{metric_id}/plans	Get plans using a billable metric
BillableMetricsApi	list_billable_metric_filters_v1_billable_metrics_code_filters_get	GET /v1/billable_metrics/{code}/filters	List metric filters
BillableMetricsApi	list_billable_metrics_v1_billable_metrics_get	GET /v1/billable_metrics/	List billable metrics
BillableMetricsApi	update_billable_metric_v1_billable_metrics_metric_id_put	PUT /v1/billable_metrics/{metric_id}	Update billable metric
BillingEntitiesApi	create_billing_entity_v1_billing_entities_post	POST /v1/billing_entities/	Create billing entity
BillingEntitiesApi	delete_billing_entity_v1_billing_entities_code_delete	DELETE /v1/billing_entities/{code}	Delete billing entity
BillingEntitiesApi	get_billing_entity_v1_billing_entities_code_get	GET /v1/billing_entities/{code}	Get billing entity by code
BillingEntitiesApi	get_customer_counts_v1_billing_entities_customer_counts_get	GET /v1/billing_entities/customer_counts	Get customer counts per billing entity
BillingEntitiesApi	list_billing_entities_v1_billing_entities_get	GET /v1/billing_entities/	List billing entities
BillingEntitiesApi	update_billing_entity_v1_billing_entities_code_patch	PATCH /v1/billing_entities/{code}	Update billing entity
CommitmentsApi	create_commitment_v1_plans_plan_code_commitments_post	POST /v1/plans/{plan_code}/commitments	Create commitment
CommitmentsApi	delete_commitment_v1_commitments_commitment_id_delete	DELETE /v1/commitments/{commitment_id}	Delete commitment
CommitmentsApi	list_commitments_for_plan_v1_plans_plan_code_commitments_get	GET /v1/plans/{plan_code}/commitments	List plan commitments
CommitmentsApi	update_commitment_v1_commitments_commitment_id_put	PUT /v1/commitments/{commitment_id}	Update commitment
CouponsApi	apply_coupon_v1_coupons_apply_post	POST /v1/coupons/apply	Apply coupon to customer
CouponsApi	create_coupon_v1_coupons_post	POST /v1/coupons/	Create coupon
CouponsApi	duplicate_coupon_v1_coupons_code_duplicate_post	POST /v1/coupons/{code}/duplicate	Duplicate coupon
CouponsApi	get_coupon_analytics_v1_coupons_code_analytics_get	GET /v1/coupons/{code}/analytics	Get coupon analytics
CouponsApi	get_coupon_v1_coupons_code_get	GET /v1/coupons/{code}	Get coupon
CouponsApi	list_coupons_v1_coupons_get	GET /v1/coupons/	List coupons
CouponsApi	remove_applied_coupon_v1_coupons_applied_applied_coupon_id_delete	DELETE /v1/coupons/applied/{applied_coupon_id}	Remove applied coupon
CouponsApi	terminate_coupon_v1_coupons_code_delete	DELETE /v1/coupons/{code}	Terminate coupon
CouponsApi	update_coupon_v1_coupons_code_put	PUT /v1/coupons/{code}	Update coupon
CreditNotesApi	create_credit_note_v1_credit_notes_post	POST /v1/credit_notes/	Create credit note
CreditNotesApi	download_credit_note_pdf_v1_credit_notes_credit_note_id_download_pdf_post	POST /v1/credit_notes/{credit_note_id}/download_pdf	Download credit note PDF
CreditNotesApi	finalize_credit_note_v1_credit_notes_credit_note_id_finalize_post	POST /v1/credit_notes/{credit_note_id}/finalize	Finalize credit note
CreditNotesApi	get_credit_note_v1_credit_notes_credit_note_id_get	GET /v1/credit_notes/{credit_note_id}	Get credit note
CreditNotesApi	list_credit_notes_v1_credit_notes_get	GET /v1/credit_notes/	List credit notes
CreditNotesApi	send_credit_note_email_v1_credit_notes_credit_note_id_send_email_post	POST /v1/credit_notes/{credit_note_id}/send_email	Send credit note email
CreditNotesApi	update_credit_note_v1_credit_notes_credit_note_id_put	PUT /v1/credit_notes/{credit_note_id}	Update credit note
CreditNotesApi	void_credit_note_v1_credit_notes_credit_note_id_void_post	POST /v1/credit_notes/{credit_note_id}/void	Void credit note
CustomersApi	create_customer_v1_customers_post	POST /v1/customers/	Create customer
CustomersApi	delete_customer_v1_customers_customer_id_delete	DELETE /v1/customers/{customer_id}	Delete customer
CustomersApi	generate_portal_url_v1_customers_external_id_portal_url_get	GET /v1/customers/{external_id}/portal_url	Generate customer portal URL
CustomersApi	get_current_usage_v1_customers_external_id_current_usage_get	GET /v1/customers/{external_id}/current_usage	Get customer current usage
CustomersApi	get_customer_health_v1_customers_customer_id_health_get	GET /v1/customers/{customer_id}/health	Get customer health indicator
CustomersApi	get_customer_v1_customers_customer_id_get	GET /v1/customers/{customer_id}	Get customer
CustomersApi	get_past_usage_v1_customers_external_id_past_usage_get	GET /v1/customers/{external_id}/past_usage	Get customer past usage
CustomersApi	get_projected_usage_v1_customers_external_id_projected_usage_get	GET /v1/customers/{external_id}/projected_usage	Get customer projected usage
CustomersApi	list_applied_add_ons_for_customer_v1_customers_customer_id_applied_add_ons_get	GET /v1/customers/{customer_id}/applied_add_ons	List customer applied add-ons
CustomersApi	list_applied_coupons_v1_customers_customer_id_applied_coupons_get	GET /v1/customers/{customer_id}/applied_coupons	List customer applied coupons
CustomersApi	list_customers_v1_customers_get	GET /v1/customers/	List customers
CustomersApi	list_integration_mappings_for_customer_v1_customers_customer_id_integration_mappings_get	GET /v1/customers/{customer_id}/integration_mappings	List customer integration mappings
CustomersApi	update_customer_v1_customers_customer_id_put	PUT /v1/customers/{customer_id}	Update customer
DashboardApi	get_customer_metrics_dashboard_customers_get	GET /dashboard/customers	Get customer metrics
DashboardApi	get_recent_activity_dashboard_activity_get	GET /dashboard/activity	Get recent activity feed
DashboardApi	get_recent_invoices_dashboard_recent_invoices_get	GET /dashboard/recent_invoices	Get recent invoices for dashboard
DashboardApi	get_recent_subscriptions_dashboard_recent_subscriptions_get	GET /dashboard/recent_subscriptions	Get recent subscriptions for dashboard
DashboardApi	get_revenue_analytics_dashboard_revenue_analytics_get	GET /dashboard/revenue_analytics	Get revenue analytics deep-dive
DashboardApi	get_revenue_by_plan_dashboard_revenue_by_plan_get	GET /dashboard/revenue_by_plan	Get revenue breakdown by plan
DashboardApi	get_revenue_dashboard_revenue_get	GET /dashboard/revenue	Get revenue analytics
DashboardApi	get_sparklines_dashboard_sparklines_get	GET /dashboard/sparklines	Get sparkline data for stat cards
DashboardApi	get_stats_dashboard_stats_get	GET /dashboard/stats	Get dashboard statistics
DashboardApi	get_subscription_metrics_dashboard_subscriptions_get	GET /dashboard/subscriptions	Get subscription metrics
DashboardApi	get_usage_metrics_dashboard_usage_get	GET /dashboard/usage	Get top usage metrics
DataExportsApi	create_data_export_v1_data_exports_post	POST /v1/data_exports/	Create data export
DataExportsApi	download_data_export_v1_data_exports_export_id_download_get	GET /v1/data_exports/{export_id}/download	Download data export
DataExportsApi	estimate_data_export_v1_data_exports_estimate_post	POST /v1/data_exports/estimate	Estimate export size
DataExportsApi	get_data_export_v1_data_exports_export_id_get	GET /v1/data_exports/{export_id}	Get data export
DataExportsApi	list_data_exports_v1_data_exports_get	GET /v1/data_exports/	List data exports
DunningApi	create_dunning_campaign_v1_dunning_campaigns_post	POST /v1/dunning_campaigns/	Create dunning campaign
DunningApi	delete_dunning_campaign_v1_dunning_campaigns_campaign_id_delete	DELETE /v1/dunning_campaigns/{campaign_id}	Delete dunning campaign
DunningApi	get_campaign_timeline_v1_dunning_campaigns_campaign_id_timeline_get	GET /v1/dunning_campaigns/{campaign_id}/timeline	Get campaign timeline
DunningApi	get_dunning_campaign_v1_dunning_campaigns_campaign_id_get	GET /v1/dunning_campaigns/{campaign_id}	Get dunning campaign
DunningApi	get_execution_history_v1_dunning_campaigns_campaign_id_execution_history_get	GET /v1/dunning_campaigns/{campaign_id}/execution_history	Get campaign execution history
DunningApi	get_performance_stats_v1_dunning_campaigns_performance_stats_get	GET /v1/dunning_campaigns/performance_stats	Get dunning campaign performance stats
DunningApi	list_dunning_campaigns_v1_dunning_campaigns_get	GET /v1/dunning_campaigns/	List dunning campaigns
DunningApi	preview_campaign_v1_dunning_campaigns_campaign_id_preview_post	POST /v1/dunning_campaigns/{campaign_id}/preview	Preview campaign execution
DunningApi	update_dunning_campaign_v1_dunning_campaigns_campaign_id_put	PUT /v1/dunning_campaigns/{campaign_id}	Update dunning campaign
EntitlementsApi	copy_entitlements_v1_entitlements_copy_post	POST /v1/entitlements/copy	Copy entitlements from one plan to another
EntitlementsApi	create_entitlement_v1_entitlements_post	POST /v1/entitlements/	Create entitlement
EntitlementsApi	delete_entitlement_v1_entitlements_entitlement_id_delete	DELETE /v1/entitlements/{entitlement_id}	Delete entitlement
EntitlementsApi	list_entitlements_v1_entitlements_get	GET /v1/entitlements/	List entitlements
EntitlementsApi	update_entitlement_v1_entitlements_entitlement_id_patch	PATCH /v1/entitlements/{entitlement_id}	Update entitlement
EventsApi	create_event_v1_events_post	POST /v1/events/	Ingest event
EventsApi	create_events_batch_v1_events_batch_post	POST /v1/events/batch	Ingest event batch
EventsApi	estimate_fees_v1_events_estimate_fees_post	POST /v1/events/estimate_fees	Estimate fees for a hypothetical event
EventsApi	get_event_v1_events_event_id_get	GET /v1/events/{event_id}	Get event
EventsApi	get_event_volume_v1_events_volume_get	GET /v1/events/volume	Get event volume (events per hour)
EventsApi	list_events_v1_events_get	GET /v1/events/	List events
EventsApi	reprocess_event_v1_events_event_id_reprocess_post	POST /v1/events/{event_id}/reprocess	Reprocess an event
FeaturesApi	create_feature_v1_features_post	POST /v1/features/	Create feature
FeaturesApi	delete_feature_v1_features_code_delete	DELETE /v1/features/{code}	Delete feature
FeaturesApi	get_feature_plan_counts_v1_features_plan_counts_get	GET /v1/features/plan_counts	Get plan counts per feature
FeaturesApi	get_feature_v1_features_code_get	GET /v1/features/{code}	Get feature by code
FeaturesApi	list_features_v1_features_get	GET /v1/features/	List features
FeaturesApi	update_feature_v1_features_code_patch	PATCH /v1/features/{code}	Update feature
FeesApi	get_fee_v1_fees_fee_id_get	GET /v1/fees/{fee_id}	Get fee
FeesApi	list_fees_v1_fees_get	GET /v1/fees/	List fees
FeesApi	update_fee_v1_fees_fee_id_put	PUT /v1/fees/{fee_id}	Update fee
IntegrationsApi	create_integration_v1_integrations_post	POST /v1/integrations/	Create integration
IntegrationsApi	delete_integration_v1_integrations_integration_id_delete	DELETE /v1/integrations/{integration_id}	Delete integration
IntegrationsApi	get_integration_v1_integrations_integration_id_get	GET /v1/integrations/{integration_id}	Get integration
IntegrationsApi	list_integration_customers_v1_integrations_integration_id_customers_get	GET /v1/integrations/{integration_id}/customers	List integration customer mappings
IntegrationsApi	list_integration_mappings_v1_integrations_integration_id_mappings_get	GET /v1/integrations/{integration_id}/mappings	List integration field mappings
IntegrationsApi	list_integration_sync_history_v1_integrations_integration_id_sync_history_get	GET /v1/integrations/{integration_id}/sync_history	List integration sync history
IntegrationsApi	list_integrations_v1_integrations_get	GET /v1/integrations/	List integrations
IntegrationsApi	test_integration_connection_v1_integrations_integration_id_test_post	POST /v1/integrations/{integration_id}/test	Test integration connection
IntegrationsApi	update_integration_v1_integrations_integration_id_put	PUT /v1/integrations/{integration_id}	Update integration
InvoicesApi	bulk_finalize_invoices_v1_invoices_bulk_finalize_post	POST /v1/invoices/bulk_finalize	Bulk finalize draft invoices
InvoicesApi	bulk_void_invoices_v1_invoices_bulk_void_post	POST /v1/invoices/bulk_void	Bulk void invoices
InvoicesApi	create_one_off_invoice_v1_invoices_one_off_post	POST /v1/invoices/one_off	Create a one-off invoice
InvoicesApi	delete_invoice_v1_invoices_invoice_id_delete	DELETE /v1/invoices/{invoice_id}	Delete draft invoice
InvoicesApi	download_invoice_pdf_v1_invoices_invoice_id_download_pdf_post	POST /v1/invoices/{invoice_id}/download_pdf	Download invoice PDF
InvoicesApi	finalize_invoice_v1_invoices_invoice_id_finalize_post	POST /v1/invoices/{invoice_id}/finalize	Finalize invoice
InvoicesApi	get_invoice_v1_invoices_invoice_id_get	GET /v1/invoices/{invoice_id}	Get invoice
InvoicesApi	list_invoice_settlements_v1_invoices_invoice_id_settlements_get	GET /v1/invoices/{invoice_id}/settlements	List invoice settlements
InvoicesApi	list_invoices_v1_invoices_get	GET /v1/invoices/	List invoices
InvoicesApi	mark_invoice_paid_v1_invoices_invoice_id_pay_post	POST /v1/invoices/{invoice_id}/pay	Mark invoice paid
InvoicesApi	preview_invoice_pdf_v1_invoices_invoice_id_pdf_preview_get	GET /v1/invoices/{invoice_id}/pdf_preview	Get invoice PDF for inline preview
InvoicesApi	preview_invoice_v1_invoices_preview_post	POST /v1/invoices/preview	Preview invoice
InvoicesApi	send_invoice_email_v1_invoices_invoice_id_send_email_post	POST /v1/invoices/{invoice_id}/send_email	Send invoice email
InvoicesApi	send_invoice_reminder_v1_invoices_invoice_id_send_reminder_post	POST /v1/invoices/{invoice_id}/send_reminder	Send payment reminder for overdue invoice
InvoicesApi	update_invoice_v1_invoices_invoice_id_put	PUT /v1/invoices/{invoice_id}	Update invoice
InvoicesApi	void_invoice_v1_invoices_invoice_id_void_post	POST /v1/invoices/{invoice_id}/void	Void invoice
NotificationsApi	get_unread_count_v1_notifications_unread_count_get	GET /v1/notifications/unread_count	Get unread notification count
NotificationsApi	list_notifications_v1_notifications_get	GET /v1/notifications/	List notifications
NotificationsApi	mark_all_as_read_v1_notifications_read_all_post	POST /v1/notifications/read_all	Mark all notifications as read
NotificationsApi	mark_as_read_v1_notifications_notification_id_read_post	POST /v1/notifications/{notification_id}/read	Mark a notification as read
OrganizationsApi	create_api_key_v1_organizations_current_api_keys_post	POST /v1/organizations/current/api_keys	Create API key
OrganizationsApi	create_organization_v1_organizations_post	POST /v1/organizations/	Create organization
OrganizationsApi	get_current_org_v1_organizations_current_get	GET /v1/organizations/current	Get current organization
OrganizationsApi	list_api_keys_v1_organizations_current_api_keys_get	GET /v1/organizations/current/api_keys	List API keys
OrganizationsApi	list_organizations_v1_organizations_get	GET /v1/organizations/	List organizations
OrganizationsApi	revoke_api_key_v1_organizations_current_api_keys_api_key_id_delete	DELETE /v1/organizations/current/api_keys/{api_key_id}	Revoke API key
OrganizationsApi	rotate_api_key_v1_organizations_current_api_keys_api_key_id_rotate_post	POST /v1/organizations/current/api_keys/{api_key_id}/rotate	Rotate API key
OrganizationsApi	update_current_org_v1_organizations_current_put	PUT /v1/organizations/current	Update current organization
PaymentMethodsApi	create_payment_method_v1_payment_methods_post	POST /v1/payment_methods/	Create payment method
PaymentMethodsApi	create_setup_session_v1_payment_methods_setup_post	POST /v1/payment_methods/setup	Create setup session
PaymentMethodsApi	delete_payment_method_v1_payment_methods_payment_method_id_delete	DELETE /v1/payment_methods/{payment_method_id}	Delete payment method
PaymentMethodsApi	get_payment_method_v1_payment_methods_payment_method_id_get	GET /v1/payment_methods/{payment_method_id}	Get payment method
PaymentMethodsApi	list_payment_methods_v1_payment_methods_get	GET /v1/payment_methods/	List payment methods
PaymentMethodsApi	set_default_payment_method_v1_payment_methods_payment_method_id_set_default_post	POST /v1/payment_methods/{payment_method_id}/set_default	Set default payment method
PaymentRequestsApi	batch_create_payment_requests_v1_payment_requests_batch_post	POST /v1/payment_requests/batch	Batch create payment requests for all customers with overdue invoices
PaymentRequestsApi	create_payment_request_v1_payment_requests_post	POST /v1/payment_requests/	Create payment request
PaymentRequestsApi	get_payment_attempt_history_v1_payment_requests_request_id_attempts_get	GET /v1/payment_requests/{request_id}/attempts	Get payment attempt history
PaymentRequestsApi	get_payment_request_v1_payment_requests_request_id_get	GET /v1/payment_requests/{request_id}	Get payment request
PaymentRequestsApi	list_payment_requests_v1_payment_requests_get	GET /v1/payment_requests/	List payment requests
PaymentsApi	create_checkout_session_v1_payments_checkout_post	POST /v1/payments/checkout	Create checkout session
PaymentsApi	delete_payment_v1_payments_payment_id_delete	DELETE /v1/payments/{payment_id}	Delete payment
PaymentsApi	get_payment_v1_payments_payment_id_get	GET /v1/payments/{payment_id}	Get payment
PaymentsApi	handle_webhook_v1_payments_webhook_provider_post	POST /v1/payments/webhook/{provider}	Handle payment webhook
PaymentsApi	list_payments_v1_payments_get	GET /v1/payments/	List payments
PaymentsApi	mark_payment_paid_v1_payments_payment_id_mark_paid_post	POST /v1/payments/{payment_id}/mark-paid	Mark payment paid
PaymentsApi	record_manual_payment_v1_payments_record_post	POST /v1/payments/record	Record manual payment
PaymentsApi	refund_payment_v1_payments_payment_id_refund_post	POST /v1/payments/{payment_id}/refund	Refund payment
PaymentsApi	retry_payment_v1_payments_payment_id_retry_post	POST /v1/payments/{payment_id}/retry	Retry failed payment
PlansApi	create_plan_v1_plans_post	POST /v1/plans/	Create plan
PlansApi	delete_plan_v1_plans_plan_id_delete	DELETE /v1/plans/{plan_id}	Delete plan
PlansApi	get_plan_v1_plans_plan_id_get	GET /v1/plans/{plan_id}	Get plan
PlansApi	get_subscription_counts_v1_plans_subscription_counts_get	GET /v1/plans/subscription_counts	Get subscription counts per plan
PlansApi	list_plans_v1_plans_get	GET /v1/plans/	List plans
PlansApi	simulate_plan_pricing_v1_plans_plan_id_simulate_post	POST /v1/plans/{plan_id}/simulate	Simulate plan pricing
PlansApi	update_plan_v1_plans_plan_id_put	PUT /v1/plans/{plan_id}	Update plan
PortalApi	add_portal_payment_method	POST /portal/payment_methods	Add a payment method
PortalApi	download_portal_invoice_pdf	GET /portal/invoices/{invoice_id}/download_pdf	Download invoice PDF
PortalApi	get_portal_auth_token	GET /portal/auth/{external_id}	Generate a portal JWT for a customer
PortalApi	get_portal_branding	GET /portal/branding	Get organization branding for portal
PortalApi	get_portal_current_usage	GET /portal/current_usage	Get current usage
PortalApi	get_portal_customer	GET /portal/customer	Get customer profile
PortalApi	get_portal_dashboard_summary	GET /portal/dashboard_summary	Get portal dashboard summary
PortalApi	get_portal_invoice	GET /portal/invoices/{invoice_id}	Get invoice detail
PortalApi	get_portal_projected_usage	GET /portal/usage/projected	Get projected end-of-period usage
PortalApi	get_portal_subscription	GET /portal/subscriptions/{subscription_id}	Get subscription detail
PortalApi	get_portal_usage_limits	GET /portal/usage/limits	Get plan limits vs current usage
PortalApi	get_portal_usage_trend	GET /portal/usage/trend	Get usage trend for a subscription
PortalApi	get_portal_wallet	GET /portal/wallet	Get wallet balance and transactions
PortalApi	get_portal_wallet_balance_timeline	GET /portal/wallet/{wallet_id}/balance_timeline	Get wallet balance timeline
PortalApi	list_portal_add_ons	GET /portal/add_ons	List available add-ons
PortalApi	list_portal_coupons	GET /portal/coupons	List applied coupons
PortalApi	list_portal_invoice_payments	GET /portal/invoices/{invoice_id}/payments	List payments for an invoice
PortalApi	list_portal_invoices	GET /portal/invoices	List customer invoices
PortalApi	list_portal_payment_methods	GET /portal/payment_methods	List customer payment methods
PortalApi	list_portal_payments	GET /portal/payments	List customer payments
PortalApi	list_portal_plans	GET /portal/plans	List available plans
PortalApi	list_portal_purchased_add_ons	GET /portal/add_ons/purchased	List purchased add-ons
PortalApi	list_portal_subscriptions	GET /portal/subscriptions	List customer subscriptions
PortalApi	list_portal_wallet_transactions	GET /portal/wallet/{wallet_id}/transactions	List wallet transactions
PortalApi	pay_portal_invoice	POST /portal/invoices/{invoice_id}/pay	Pay an outstanding invoice
PortalApi	portal_change_plan	POST /portal/subscriptions/{subscription_id}/change_plan	Change subscription plan
PortalApi	portal_change_plan_preview	POST /portal/subscriptions/{subscription_id}/change_plan_preview	Preview plan change with proration
PortalApi	portal_purchase_add_on	POST /portal/add_ons/{add_on_id}/purchase	Purchase an add-on
PortalApi	portal_redeem_coupon	POST /portal/coupons/redeem	Redeem a coupon code
PortalApi	portal_wallet_top_up	POST /portal/wallet/{wallet_id}/top_up	Request a wallet top-up
PortalApi	preview_portal_invoice_pdf	GET /portal/invoices/{invoice_id}/pdf_preview	Preview invoice PDF inline
PortalApi	remove_portal_payment_method	DELETE /portal/payment_methods/{payment_method_id}	Remove a payment method
PortalApi	set_portal_default_payment_method	POST /portal/payment_methods/{payment_method_id}/set_default	Set default payment method
PortalApi	update_portal_profile	PATCH /portal/profile	Update customer profile
SearchApi	global_search_v1_search_get	GET /v1/search/	Global search across customers, invoices, subscriptions, and plans
SubscriptionsApi	activate_subscription_v1_subscriptions_subscription_id_activate_post	POST /v1/subscriptions/{subscription_id}/activate	Activate pending subscription
SubscriptionsApi	bulk_pause_subscriptions_v1_subscriptions_bulk_pause_post	POST /v1/subscriptions/bulk_pause	Bulk pause subscriptions
SubscriptionsApi	bulk_resume_subscriptions_v1_subscriptions_bulk_resume_post	POST /v1/subscriptions/bulk_resume	Bulk resume subscriptions
SubscriptionsApi	bulk_terminate_subscriptions_v1_subscriptions_bulk_terminate_post	POST /v1/subscriptions/bulk_terminate	Bulk terminate subscriptions
SubscriptionsApi	cancel_subscription_v1_subscriptions_subscription_id_cancel_post	POST /v1/subscriptions/{subscription_id}/cancel	Cancel subscription
SubscriptionsApi	change_plan_preview_v1_subscriptions_subscription_id_change_plan_preview_post	POST /v1/subscriptions/{subscription_id}/change_plan_preview	Preview plan change with price comparison and proration
SubscriptionsApi	create_subscription_v1_subscriptions_post	POST /v1/subscriptions/	Create subscription
SubscriptionsApi	get_next_billing_date_v1_subscriptions_subscription_id_next_billing_date_get	GET /v1/subscriptions/{subscription_id}/next_billing_date	Get next billing date for a subscription
SubscriptionsApi	get_subscription_entitlements_v1_subscriptions_external_id_entitlements_get	GET /v1/subscriptions/{external_id}/entitlements	Get subscription entitlements
SubscriptionsApi	get_subscription_lifecycle_v1_subscriptions_subscription_id_lifecycle_get	GET /v1/subscriptions/{subscription_id}/lifecycle	Get subscription lifecycle timeline
SubscriptionsApi	get_subscription_v1_subscriptions_subscription_id_get	GET /v1/subscriptions/{subscription_id}	Get subscription
SubscriptionsApi	get_usage_trend_v1_subscriptions_subscription_id_usage_trend_get	GET /v1/subscriptions/{subscription_id}/usage_trend	Get daily usage trend for a subscription
SubscriptionsApi	list_subscriptions_v1_subscriptions_get	GET /v1/subscriptions/	List subscriptions
SubscriptionsApi	pause_subscription_v1_subscriptions_subscription_id_pause_post	POST /v1/subscriptions/{subscription_id}/pause	Pause subscription
SubscriptionsApi	resume_subscription_v1_subscriptions_subscription_id_resume_post	POST /v1/subscriptions/{subscription_id}/resume	Resume subscription
SubscriptionsApi	terminate_subscription_v1_subscriptions_subscription_id_delete	DELETE /v1/subscriptions/{subscription_id}	Terminate subscription
SubscriptionsApi	update_subscription_v1_subscriptions_subscription_id_put	PUT /v1/subscriptions/{subscription_id}	Update subscription
TaxesApi	apply_tax_v1_taxes_apply_post	POST /v1/taxes/apply	Apply tax to entity
TaxesApi	create_tax_v1_taxes_post	POST /v1/taxes/	Create tax
TaxesApi	delete_tax_v1_taxes_code_delete	DELETE /v1/taxes/{code}	Delete tax
TaxesApi	get_application_counts_v1_taxes_application_counts_get	GET /v1/taxes/application_counts	Get tax application counts
TaxesApi	get_applied_entities_v1_taxes_code_applied_entities_get	GET /v1/taxes/{code}/applied_entities	Get entities a tax is applied to
TaxesApi	get_tax_v1_taxes_code_get	GET /v1/taxes/{code}	Get tax
TaxesApi	list_applied_taxes_v1_taxes_applied_get	GET /v1/taxes/applied	List applied taxes
TaxesApi	list_taxes_v1_taxes_get	GET /v1/taxes/	List taxes
TaxesApi	remove_applied_tax_v1_taxes_applied_applied_tax_id_delete	DELETE /v1/taxes/applied/{applied_tax_id}	Remove applied tax
TaxesApi	update_tax_v1_taxes_code_put	PUT /v1/taxes/{code}	Update tax
ThresholdsApi	create_plan_usage_threshold_v1_plans_plan_code_usage_thresholds_post	POST /v1/plans/{plan_code}/usage_thresholds	Create plan usage threshold
ThresholdsApi	create_subscription_usage_threshold_v1_subscriptions_subscription_id_usage_thresholds_post	POST /v1/subscriptions/{subscription_id}/usage_thresholds	Create subscription usage threshold
ThresholdsApi	delete_usage_threshold_v1_usage_thresholds_threshold_id_delete	DELETE /v1/usage_thresholds/{threshold_id}	Delete usage threshold
ThresholdsApi	get_current_usage_v1_subscriptions_subscription_id_current_usage_get	GET /v1/subscriptions/{subscription_id}/current_usage	Get current subscription usage
ThresholdsApi	list_plan_usage_thresholds_v1_plans_plan_code_usage_thresholds_get	GET /v1/plans/{plan_code}/usage_thresholds	List plan usage thresholds
ThresholdsApi	list_subscription_usage_thresholds_v1_subscriptions_subscription_id_usage_thresholds_get	GET /v1/subscriptions/{subscription_id}/usage_thresholds	List subscription usage thresholds
UsageAlertsApi	create_usage_alert_v1_usage_alerts_post	POST /v1/usage_alerts/	Create usage alert
UsageAlertsApi	delete_usage_alert_v1_usage_alerts_alert_id_delete	DELETE /v1/usage_alerts/{alert_id}	Delete usage alert
UsageAlertsApi	get_usage_alert_status_v1_usage_alerts_alert_id_status_get	GET /v1/usage_alerts/{alert_id}/status	Get usage alert status with current usage
UsageAlertsApi	get_usage_alert_v1_usage_alerts_alert_id_get	GET /v1/usage_alerts/{alert_id}	Get usage alert
UsageAlertsApi	list_alert_triggers_v1_usage_alerts_alert_id_triggers_get	GET /v1/usage_alerts/{alert_id}/triggers	List alert trigger history
UsageAlertsApi	list_usage_alerts_v1_usage_alerts_get	GET /v1/usage_alerts/	List usage alerts
UsageAlertsApi	test_usage_alert_v1_usage_alerts_alert_id_test_post	POST /v1/usage_alerts/{alert_id}/test	Test a usage alert by checking current usage
UsageAlertsApi	update_usage_alert_v1_usage_alerts_alert_id_patch	PATCH /v1/usage_alerts/{alert_id}	Update usage alert
WalletsApi	create_wallet_v1_wallets_post	POST /v1/wallets/	Create wallet
WalletsApi	get_balance_timeline_v1_wallets_wallet_id_balance_timeline_get	GET /v1/wallets/{wallet_id}/balance_timeline	Get wallet balance timeline
WalletsApi	get_depletion_forecast_v1_wallets_wallet_id_depletion_forecast_get	GET /v1/wallets/{wallet_id}/depletion_forecast	Get wallet depletion forecast
WalletsApi	get_wallet_v1_wallets_wallet_id_get	GET /v1/wallets/{wallet_id}	Get wallet
WalletsApi	list_wallet_transactions_v1_wallets_wallet_id_transactions_get	GET /v1/wallets/{wallet_id}/transactions	List wallet transactions
WalletsApi	list_wallets_v1_wallets_get	GET /v1/wallets/	List wallets
WalletsApi	terminate_wallet_v1_wallets_wallet_id_delete	DELETE /v1/wallets/{wallet_id}	Terminate wallet
WalletsApi	top_up_wallet_v1_wallets_wallet_id_top_up_post	POST /v1/wallets/{wallet_id}/top_up	Top up wallet
WalletsApi	transfer_credits_v1_wallets_transfer_post	POST /v1/wallets/transfer	Transfer credits between wallets
WalletsApi	update_wallet_v1_wallets_wallet_id_put	PUT /v1/wallets/{wallet_id}	Update wallet
WebhooksApi	create_webhook_endpoint_v1_webhook_endpoints_post	POST /v1/webhook_endpoints/	Create webhook endpoint
WebhooksApi	delete_webhook_endpoint_v1_webhook_endpoints_endpoint_id_delete	DELETE /v1/webhook_endpoints/{endpoint_id}	Delete webhook endpoint
WebhooksApi	get_delivery_stats_v1_webhook_endpoints_delivery_stats_get	GET /v1/webhook_endpoints/delivery_stats	Get delivery stats per endpoint
WebhooksApi	get_webhook_delivery_attempts_v1_webhook_endpoints_hooks_webhook_id_delivery_attempts_get	GET /v1/webhook_endpoints/hooks/{webhook_id}/delivery_attempts	Get webhook delivery attempts
WebhooksApi	get_webhook_endpoint_v1_webhook_endpoints_endpoint_id_get	GET /v1/webhook_endpoints/{endpoint_id}	Get webhook endpoint
WebhooksApi	get_webhook_v1_webhook_endpoints_hooks_webhook_id_get	GET /v1/webhook_endpoints/hooks/{webhook_id}	Get webhook details
WebhooksApi	list_webhook_endpoints_v1_webhook_endpoints_get	GET /v1/webhook_endpoints/	List webhook endpoints
WebhooksApi	list_webhooks_v1_webhook_endpoints_hooks_list_get	GET /v1/webhook_endpoints/hooks/list	List recent webhooks
WebhooksApi	retry_webhook_v1_webhook_endpoints_hooks_webhook_id_retry_post	POST /v1/webhook_endpoints/hooks/{webhook_id}/retry	Retry failed webhook
WebhooksApi	update_webhook_endpoint_v1_webhook_endpoints_endpoint_id_put	PUT /v1/webhook_endpoints/{endpoint_id}	Update webhook endpoint
DefaultApi	root_get	GET /	Root

Documentation For Models

• AddOnCreate
• AddOnResponse
• AddOnUpdate
• AggregationType
• Amount
• Amount1
• Amount2
• AmountCents
• AmountCents1
• AmountCents2
• AmountCents3
• ApiKeyCreate
• ApiKeyCreateResponse
• ApiKeyListResponse
• AppSchemasUsageCurrentUsageResponse
• AppSchemasUsageThresholdCurrentUsageResponse
• AppliedAddOnDetailResponse
• AppliedAddOnResponse
• AppliedCouponResponse
• AppliedTaxResponse
• ApplyAddOnRequest
• ApplyCouponRequest
• ApplyTaxRequest
• AuditLogResponse
• BalanceTimelinePoint
• BalanceTimelineResponse
• BatchPaymentRequestResponse
• BatchPaymentRequestResult
• BillableMetricCreate
• BillableMetricFilterCreate
• BillableMetricFilterResponse
• BillableMetricResponse
• BillableMetricStats
• BillableMetricUpdate
• BillableMetricUsage
• BillingEntityCreate
• BillingEntityResponse
• BillingEntityUpdate
• BillingTime
• BulkFinalizeRequest
• BulkFinalizeResponse
• BulkFinalizeResult
• BulkSubscriptionRequest
• BulkSubscriptionResponse
• BulkSubscriptionResult
• BulkTerminateRequest
• BulkVoidRequest
• BulkVoidResponse
• BulkVoidResult
• CampaignPreviewInvoiceGroup
• CampaignPreviewResponse
• CampaignTimelineEvent
• CampaignTimelineResponse
• ChangePlanPreviewRequest
• ChangePlanPreviewResponse
• ChargeFilterInput
• ChargeInput
• ChargeModel
• ChargeOutput
• ChargeSimulationResult
• ChargeUsage
• CheckoutSessionCreate
• CheckoutSessionResponse
• CollectionMetrics
• CommitmentCreateAPI
• CommitmentResponse
• CommitmentUpdate
• CouponAnalyticsResponse
• CouponCreate
• CouponExpiration
• CouponFrequency
• CouponResponse
• CouponStatus
• CouponType
• CouponUpdate
• CreditAmountCents
• CreditAmountCents1
• CreditNoteCreate
• CreditNoteItemCreate
• CreditNoteReason
• CreditNoteResponse
• CreditNoteStatus
• CreditNoteType
• CreditNoteUpdate
• CreditStatus
• Credits
• CustomerCreate
• CustomerHealthResponse
• CustomerHealthStatus
• CustomerIntegrationMappingResponse
• CustomerMetricsResponse
• CustomerResponse
• CustomerUpdate
• DailyRevenuePoint
• DashboardStatsResponse
• DataExportCreate
• DataExportEstimate
• DataExportResponse
• DepletionForecastResponse
• DunningCampaignCreate
• DunningCampaignPerformanceStats
• DunningCampaignResponse
• DunningCampaignThresholdCreate
• DunningCampaignThresholdResponse
• DunningCampaignUpdate
• EndpointDeliveryStats
• EntitiesInnerValue
• EntitlementCopyRequest
• EntitlementCreate
• EntitlementResponse
• EntitlementUpdate
• EstimateFeesRequest
• EstimateFeesResponse
• EventBatchCreate
• EventBatchResponse
• EventCreate
• EventReprocessResponse
• EventResponse
• EventVolumePoint
• EventVolumeResponse
• ExecutionHistoryEntry
• ExecutionHistoryInvoice
• ExportType
• FeatureCreate
• FeatureResponse
• FeatureType
• FeatureUpdate
• FeePaymentStatus
• FeePreview
• FeeResponse
• FeeType
• FeeUpdate
• GlobalSearchResponse
• HTTPValidationError
• InitialGrantedCredits
• IntegrationCreate
• IntegrationCustomerResponse
• IntegrationMappingResponse
• IntegrationResponse
• IntegrationSyncHistoryResponse
• IntegrationUpdate
• InvoiceLineItem
• InvoicePreviewRequest
• InvoicePreviewResponse
• InvoiceResponse
• InvoiceSettlementResponse
• InvoiceStatus
• InvoiceUpdate
• LifecycleEvent
• LocationInner
• ManualPaymentCreate
• NetRevenueMetrics
• NextBillingDateResponse
• NotificationCountResponse
• NotificationResponse
• OneOffInvoiceCreate
• OrganizationCreate
• OrganizationCreateResponse
• OrganizationResponse
• OrganizationUpdate
• PaymentAttemptEntry
• PaymentAttemptHistoryResponse
• PaymentMethodCreate
• PaymentMethodResponse
• PaymentProvider
• PaymentRequestCreate
• PaymentRequestInvoiceResponse
• PaymentRequestResponse
• PaymentResponse
• PaymentStatus
• PercentageRate
• PlanCreate
• PlanInterval
• PlanResponse
• PlanRevenueBreakdown
• PlanSimulateRequest
• PlanSimulateResponse
• PlanSummary
• PlanUpdate
• PortalAddOnResponse
• PortalAppliedCouponResponse
• PortalBrandingResponse
• PortalChangePlanRequest
• PortalDashboardSummaryResponse
• PortalNextBillingInfo
• PortalPayNowRequest
• PortalPayNowResponse
• PortalPlanResponse
• PortalProfileUpdate
• PortalProjectedUsageItem
• PortalProjectedUsageResponse
• PortalPurchaseAddOnResponse
• PortalPurchasedAddOnResponse
• PortalQuickActions
• PortalRedeemCouponRequest
• PortalSubscriptionResponse
• PortalTokenResponse
• PortalTopUpRequest
• PortalTopUpResponse
• PortalUpcomingCharge
• PortalUrlResponse
• PortalUsageLimitItem
• PortalUsageLimitsResponse
• PortalUsageProgress
• PortalUsageTrendPoint
• PortalUsageTrendResponse
• ProrationDetail
• Quantity
• Rate
• Rate1
• RateAmount
• RecentActivityResponse
• RecentInvoiceItem
• RecentSubscriptionItem
• RefundAmountCents
• RefundAmountCents1
• RefundRequest
• RefundStatus
• RevenueAnalyticsResponse
• RevenueByPlanResponse
• RevenueByTypeBreakdown
• RevenueDataPoint
• RevenueResponse
• SearchResult
• SendReminderResponse
• SetupSessionCreate
• SetupSessionResponse
• SparklineData
• SparklinePoint
• SubscriptionCreate
• SubscriptionLifecycleResponse
• SubscriptionMetricsResponse
• SubscriptionPlanBreakdown
• SubscriptionResponse
• SubscriptionStatus
• SubscriptionUpdate
• TaxApplicationCountsResponse
• TaxAppliedEntitiesResponse
• TaxCreate
• TaxResponse
• TaxUpdate
• TaxesAmountCents
• TaxesAmountCents1
• TerminationAction
• ThresholdValue
• ThresholdValue1
• TopCustomerRevenue
• TotalAmountCents
• TotalAmountCents1
• TrendIndicator
• UnitPrice
• UsageAlertCreate
• UsageAlertResponse
• UsageAlertStatusResponse
• UsageAlertTriggerResponse
• UsageAlertUpdate
• UsageMetricVolume
• UsageMetricsResponse
• UsageThresholdCreateAPI
• UsageThresholdResponse
• UsageTrendPoint
• UsageTrendResponse
• ValidationError
• WalletCreate
• WalletResponse
• WalletStatus
• WalletTopUp
• WalletTransactionResponse
• WalletTransferRequest
• WalletTransferResponse
• WalletUpdate
• WebhookDeliveryAttemptResponse
• WebhookEndpointCreate
• WebhookEndpointResponse
• WebhookEndpointUpdate
• WebhookResponse

Documentation For Authorization

Endpoints do not require authorization.

Author