Versioning
The current version of the API and documentation is built for the latest API version V4. If you use an older version of this API, some endpoints or fields might be missing. New API versions are released when new functionality or bugfixes demands breaking changes to an endpoint.
We recommend everyone use API versions that are considered “under maintenance“. It is advised to update your integrations to the latest API release whenever you need new functionality, or whenever the API falls outside of the maintenance status.
We keep supporting all API versions until the last customer has moved away to new API releases. However, we only deliver bug fixes with the N-1 principle. This means that you can always count on our support with API questions and found issues, but you might be instructed to move your application to a new API version that is still under maintenance in case a bug is found in an End of Maintenance API version.
New API functionality that will be developed on request will only be released in the latest API endpoint version or split to a new API endpoint in case of breaking changes.
Billing API Versions
API Version | API Release Date | Status | Notes |
|---|---|---|---|
v4 |
| Current Version | API extended with ResourceRatePeriod info for the Microsoft NCE billing model and PO numbers. |
v3 |
| Maintenance | |
v2 |
| End of Maintenance | API extended with new endpoints for customer invoices and subscriptionsdetails |
v1 |
| End of Life | Initial release, no longer active |
Status explanation
Status | Description | Support | BugFix releases | Feature Additions |
|---|---|---|---|---|
Current Verion | Latest API release that is fully supported, gets new features implemented to it(as long as they don't break logic) and will get bugfixes first. | Yes | Yes | Yes |
Maintenance | The API is fully supported and maintained with bugfixes when needed. | Yes | Yes | No |
End of Maintenance | The API is supported, but no new development will take place if bugs are discovered. | Yes | No | No |
End of Life | The API is no longer supported, not maintained and can be shutdown at any time | No | No | No |
Release notes
Bugfix and Feature release
We have released a new version for the Billing API consolidated invoices endpoint that introduces a few new features and repairs known bugs that have been reported to us previously.
Fixed Issue(s)
CD-513 Consolidated Invoices missing purchase discount
CD-508 Add error handling for duplicate lineID's in the BIlling API
CD-484 Consolidated Invoices missing unit price and purchase discount at Azure
CD-483 Consolidated Invoices add a subscription end date to the JSON response
CD-482 Consolidated Invoices have lines with negative values
CD-481 Consolidated Invoices have missing CustomerCostCenter
CD-337 ConsolidatedInvoices endpoint has multiple lines with missing sales price information, matching algorithm improvements needed for corrections, refunds, paygo products(Azure Plan and Azure RI) and Microsoft CSP offers with more than one change order per month.
CD-320 Add logic to the Billing API consolidated invoices endpoints to only provide planrateid or rateperiodID.
CD-260 ConsolidatedInvoices endpoint SKU field does not get filled
Bugfix release
We have released a hotfix for the Billing API that affected the supportcenter portal.
Fixed Issue(s)
CD-215 All Billing API file output results on supportcenter portal are named "v2" even if different version is called
Bugfix release
We have released a hotfix for the Billing API that affected v4 endpoints “invoices” and “customerinvoices”.
Fixed Issue(s)
CD-204 - Billing API "Invoice" endpoint v4 has duplicated line items due to "resource rate periods"
Known Issues and limitation
The following issues and limitations are reported to our team and are currently under review, in our backlog, or in development, and will be implemented in future versions.
CD-374 | Add a unique identifier for matching cost and sales price on invoice line item level to invoices/customerinvoices endpoints |
CD-319 | Add "PlanRateID" (Resource Rate ID) to Billing API - invoices/customerinvoices endpoints |
Did you find an issue, or require functionality that is not listed in the above table? Please contact our support team to submit your request.