Changelog

This update enhances usage-based billing capabilities by introducing support for usage volume tiers across multiple APIs, including usage buckets, account services, share plans, and price plans. New properties have been added to define tier calculation types, usage classes, thresholds, and units, enabling more precise and flexible tiered pricing models. Price plan APIs have also been extended to include usage unit details for both rate and tier overrides. Additionally, new APIs have been introduced to retrieve available tier calculation types and to support batch rerating operations, improving both configurability and operational efficiency.

This release introduces significant enhancements to pricing flexibility and contract lifecycle management, along with a few important breaking changes. The Price Change API has been updated to support more advanced tiered pricing capabilities, including a new percentage-based tier charge type. As part of this, tiered pricing updates now require explicit TierChargeType values, and the pricing field has shifted from “Amount” to “tierAmount” for tier-level changes, with “Amount” now reserved for base price adjustments. Additionally, contract cancellation behavior has been standardized, preventing direct status updates via patch and instead requiring early termination workflows, with billing responsible for executing cancellations based on configured dates.

This update introduces targeted enhancements to invoicing, payments, and usage management while improving overall API reliability. New fields have been added to support more granular control over invoice delivery behavior, including the ability to track skipped email delivery and prevent sending zero-charge invoices, as well as improved visibility into payment method deactivation reasons. Several fixes address issues with JSON API logging, usage bucket operations, and error handling, including more accurate messaging and improved response codes for external integration failures such as Adyen. Additionally, a new endpoint for retrieving account price book region data has been introduced, further expanding configuration and reporting capabilities.

This update enhances share plan management by expanding the level of detail and configurability available across account and participation APIs. Additional fields have been introduced to provide greater visibility into share plan attributes, including plan type, associated services, usage frequency, billing activity, and price book information. Support has also been added for product code associations within share plan participation, along with a new owner-level setting to enable share plan product code customization.

This update enhances pricing and usage rating flexibility by introducing more granular classification and condition-based logic. Account price plan APIs now include service category details, improving visibility and segmentation of services. A significant change has been made to usage rate groups, replacing the previous filter-based model with a more robust condition-based structure, enabling more precise and flexible rating criteria through the new UsageRateGroupConditionDTO. Additional enhancements include support for usage class resolver configuration, allowing more advanced control over how usage is categorized and processed.

This release focuses on improving API reliability, data handling, and pricing flexibility within v10. Key fixes address caching issues in multi-server environments that could cause incorrect 404 responses, resolve problems with the notStartsWith filter operator, and correct multiple issues affecting data imports. The release also deprecates the v10 Invoice Item creation endpoint and enhances several existing APIs, including expanded account discount visibility, enriched pricing and price change tracking models, improved usage aggregation controls, and additional metadata across invoice items and webhook configurations.

This release introduces Version 10 of the API while formally deprecating Version 5, alongside the removal of several legacy usage and identifier endpoints. Key enhancements focus on improving flexibility, observability, and data consistency across billing and authentication workflows. Notable updates include support for defining effective start dates on initial rate plans, the addition of session expiration details to authentication responses across multiple login endpoints, and refinements to billing structures such as the removal of outdated BillGroup fields. Tax handling has also been enhanced through asynchronous tax jurisdiction retrieval via AvaTax, and webhook configurations have been extended with additional formatting options. Improvements to rerating and usage rating include added audit fields and updated aggregation metadata.

This update introduces several enhancements and fixes to improve API reliability, expand payment capabilities, and extend functionality in v9. It resolves concurrency issues that could cause failures during simultaneous API calls, addresses errors with sales orders containing tax addresses, and fixes account-level tax exemption issues affecting versions prior to v9. It also corrects a problem where reverse charges tied to currency-converted tax adjustments were not properly applied to subsequent invoices. Additionally, ServiceDetailDTO has been extended to include ServicePricebookSetting data.

This release introduces Version 9 APIs in billing platform version 10.7, with a strong focus on security, observability, and event-driven capabilities. Webhook functionality has been significantly enhanced with support for OAuth 2.0 client credentials, expanded monitoring capabilities, and the ability to trigger events from dunning processes, along with a new “Payment Status Updated” webhook. API reliability and security have also been improved through better error handling, support for idempotency keys to prevent duplicate operations, and the introduction of client ID and secret-based authentication for API users as an alternative to traditional credentials.

This release focuses on performance and visibility improvements, including optimized API response times and a fix to ensure accurate exception data is returned from the DataImportHistory detail endpoint. It also introduces new user login history APIs, enabling retrieval of login activity by user ID or username, along with supporting metadata for enhanced auditing and tracking.