Release 10.8

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.

In addition, this release delivers a broad set of new v10 APIs that expand operational control and system visibility. These include capabilities for retrying failed bill runs, managing and validating usage data imports, accessing detailed tax summaries on invoice items, and tracking order and rerating activity. New scheduling endpoints support data exports and rerating workflows, while enhanced SMTP configuration APIs improve email integration options. Supporting endpoints such as API version discovery and system health checks further strengthen integration reliability, collectively making the platform more robust, transparent, and easier to manage at scale.

⚠️

NOTE: API version 5 is deprecated as of this release

📘

NOTE: API version v10 is introduced in this release

Deprecated APIs

• Account/Service/UsageIdentifier?prefix (Get)
• Account/Service/UsageIdentifier/Paged?prefix (Get)
• usage/billingtype (Get, Post, Put, Delete)
• usage/billingtype/type (Get)

Updated APIs

• Added support to set the effective start date of the initial Rate Plan on Account Packages, Package Services, and Package Frequencies
• v10/AuthorizationServer/Api/V10/Access/Login (Post):
  AuthenticateResponse DTO added:
  DateTime? SessionExpires { get; set; }
• v10/AuthorizationServer/Api/V10/ServiceAccess/Login (Post):
  AuthenticateResponse DTO added:
  DateTime? SessionExpires { get; set; }
• v10/AuthorizationServer/Api/V10/CustomerPortal/Access/Login (Post):
  AuthenticateResponse DTO added:
  DateTime? SessionExpires { get; set; }
• v10/BillGroup (Get, Post, Put, Patch, Delete):
  Removed from BillGroupDTO:
  • AdvanceInvoiceDays
  • InvoiceCloseThresholdAmount
  • UsageBillingTypeId
  • UsageBillingTypeName
• v10/Internal/Account (Post, Patch):
  In AddressDTO and TaxAddressDTO, added FetchTaxJurisdicationAsync to support retrieving a pCode from AvaTax asynchronously
• v10/Internal/Account/Package (Post, Patch):
  In AddressDTO and TaxAddressDTO, added FetchTaxJurisdicationAsync
• v10/Internal/Account/Package/FromCatalog/Metadata (Post, Patch):
  In AddressDTO and TaxAddressDTO, added FetchTaxJurisdicationAsync
• v10/Internal/Account/[id]/Contact (Post, Patch):
  In AddressDTO and TaxAddressDTO, added FetchTaxJurisdicationAsync
• v10/Internal/Order/[id] (Post, Patch):
  In AddressDTO and TaxAddressDTO, added FetchTaxJurisdicationAsync
• v10/EventSubscription/Webhook (Post, Put, Patch, Get):
  EventSubscriptionWebhookDetailDTO updated with:
  WebhookFormatTypeId { get; set; }
• v10/Rerate (Post, Patch):
  Added int CreatedByUserId
• v10/RerateSchedule (Get):
  Removed property: ScheduledStart
• v10/RerateSchedule/Paged (Get):
  Removed property: ScheduledStart
• v10/RerateSchedule/[id] (Get):
  Removed property: ScheduledStart
• v10/Usage/Rate/Group (Get, Post, Put, Patch, Delete):
  UsageRateGroupDTO updated with:
  • AggregationTypeId { get; set; }
  • AggregationTypeName { get; set; }

New APIs

• JsonApi/ApiVersion/Latest (Get)
• v10/BillRun/History/[id]/Recovery (Post):
  Allows a bill run in a failed state to be retried
  Note: This API does not retry subscription or usage billing stages
• v10/DataImport/Usage/[apifeedname] (Post)
• v10/DataImport/Usage/Download?FileKey="[Path and File Name]" (Get):
  Allows you to verify if a usage file has been uploaded successfully
• v10/DataImport/Usage/History/[id]/Reprocess (Post)
• v10/Invoice/Item/TaxSummary (Get)
• v10/Invoice/Item/[invoiceItemId]/TaxSummary (Get)
• v10/Order/[orderId]/Status (Get)
• v10/Order/[orderId]/PackageTracking/Paged (Get)
• v10/RerateScheduleTracking/ByRerateSchedule/[id] (Get)
• v10/RerateScheduleTracking/ByRerateSchedule/[id]/Paged (Get)
• v10/Rerate/Pending (Get)
• v10/RerateSchedule (Get)
• v10/Rerate/Now (Post)
• v10/Schedule/DataExport (Get, Post)
• v10/Schedule/DataExport/[id] (Put)
• v10/Schedule/Rerate (Get, Put, Post)
• v10/SMTP/Setting/SMTPAuth (Post)
• v10/SMTP/Setting/SMTPAuth/[id] (Put, Get)
• v10/SMTP/Setting/GoogleJWT (Post)
• v10/SMTP/Setting/GoogleJWT/[id}] (Put, Get)