To guarantee the quality of our API connection, we recently conducted an internal audit of existing API endpoints. As a result, we would like to remove information about terms from the response of some Subscription Management + Billing endpoints.
What Piano functionality is affected?
This new update will remove information about terms (for example term ID, term name, term type, term description, etc.) - further referenced as “Terms” information - from the response object for some Subscription Management + Billing API endpoints. More details are available in the following section.
Which endpoints are affected by this change?
We will remove the “Terms” information from the following endpoints in the response object AccessDTO:
/access/list
/user/access/list
/publisher/user/access/list
/access/check/
/publisher/user/access/check
In addition, we will remove the “Terms” information from the Access model in the following endpoints:
/publisher/conversion/list
/user/access/get
/publisher/user/access/grant
/publisher/user/access/revoke
/publisher/user/access/update
/publisher/conversion/get
/publisher/conversion/lastAccess
/publisher/conversion/custom/create
/publisher/conversion/external/create
You can find this information also in the description of each of these endpoints in your API documentation.
What actions are required?
To get the “Terms” information after the Production release, you can use the response object TermConversionDTO.term(Term) in the /publisher/conversion/list endpoint or TermConversion.term(Term) in the /conversion/list endpoint with AID and UID parameters.
Please note that this update is only relevant if you are requesting information about terms from these endpoints.
If you’re not utilizing any or only non-term related information from the above endpoints, no changes on your end are required.
Additionally, we are not removing the above endpoints. We are only removing information about terms from the response of these endpoints.
If you are using the “Terms” information (for example for custom integration with external systems or to create reports) from any of the above endpoints, please reconfigure your setup with the alternate endpoints provided above and ensure the updated calls are correct before January 31, 2023, to avoid data loss.
What if the requested changes were already implemented?
Our marketing team has sent out a few emails over the past few months regarding the Subscription Management + Billing API changes. Clients that have already reconfigured their setup (per previous communication from us) can start using the new approach regardless of our rollout date. Therefore, there will be no impact on them.
Sandbox release
This change is already live on the Piano Sandbox environment (https://sandbox.piano.io/) so you can test your setup using the abovementioned endpoints with the new response format already.
This ensures that you can test in Sandbox first before implementing the change to your Piano Production application.
Please reach out to our Support team at support@piano.io in case of any questions.
Production release date
The Production release will happen on February 1, 2023, at 9 A.M. UTC for US and EU environments and 2 P.M. UTC for AP and AU environments.