Usage Based Billing API v1

Retrieves a paginated list of all taxes

Creates a new tax that can be applied to invoices

Retrieves an existing tax by its unique code

Deletes an existing tax

Updates an existing tax

Delete a plan by providing the plan ID.

Retrieves the current billing period usage information for a specific customer

Retrieves historical usage information for a specific customer across previous billing periods

Updates an existing subscription's details such as name, or metadata.

This endpoint allows you to cancel an existing subscription.

Voids a credit note, making it no longer available for use.

Retrieves all usage-based alerts configured for a specific subscription.

Establishes a new usage-based alert for a subscription to notify merchants when consumption reaches specified thresholds.

Retrieves detailed information about a specific alert identified by its unique code within a subscription.

Permanently deletes a subscription alert identified by its unique code.

Updates the configuration of an existing subscription alert.

Retrieves a comprehensive list of all features defined in your system.

Creates a new feature that represents a capability or functionality that can be entitled to customers.

Retrieves complete details of a specific feature including all its privileges and configuration.

Permanently deletes a feature from the system.

Updates an existing feature's properties including name, description, and privileges.

Removes a specific privilege from a feature definition.

Retrieve all entitlements assigned to a specific plan

Assign a feature to a plan with specific privilege values.

Update privilege values for one or more plan entitlements.

Get details of a specific entitlement for a plan

Remove a feature entitlement from a plan

Remove a specific privilege from a plan entitlement

Retrieve effective entitlements for a subscription, including plan defaults and subscription-specific overrides

This endpoint performs partial updates to subscription entitlements.

Remove a subscription-specific entitlement override, reverting to plan defaults

Remove a specific privilege override from a subscription entitlement, reverting to plan default for that privilege