Contents
Changelog
June 10, 2024
Announced: March 11, 2024
June 10, 2024
What is changing?
The duration
and duration_unit
request body and response parameters will be removed from three deal-products endpoints on June 10th, 2024:
What is changing?
We’re replacing product durations with a new recurring products feature to allow users to attach products with a recurring billing cycle to deals. Users will be able to see the revenue of recurring products based on the billing frequency, cycles and start dates in reporting and forecasting via the Insights feature. This change should better serve the needs of our customers who sell subscriptions, licenses and recurring products and services.
New fields are now available for customers who meet both of the terms below:
- Have a subscription to Advanced plans and above.
- Have previously used durations in the POST and PUT endpoints to edit the billing frequency and billing cycles (for example, a monthly subscription active for 12 months).
Instead of using product durations in product attachments as a time quantity, users can now use a combination of the product attachment quantity and the product unit fields. For example, a service charged by the number of work hours.
Migration guide
On the API change’s effective date of June 10th, 2024, the product attachments’ duration
and duration_unit
fields will be removed from the API.
- The product attachment
duration
field value will be merged into thequantity
field value wherequantity = quantity * duration
. - The
duration_unit
values will be lost.
To migrate duration data to the new product subscriptions feature, it’s now possible to move values to the new billing frequency
and billing cycles
product attachment fields through these endpoints:
The fields are available in beta testing for users subscribed to the Advanced plan and above with previously used durations. Customers who aren’t included in the beta testing group can contact Pipedrive’s support and ask to be included. These are the new fields request body parameters:
billing_frequency
- Type:
string
- Description:
How often a customer is billed for access to a service or product.
- Values:
one-time, annually, semi-annually, quarterly, monthly, weekly
- Default:
one-time
billing_frequency_cycles
- Type:
number
- Description:
The number of times the billing frequency repeats for a product in a deal. It can be set to null if the number of cycles is infinite, in which case the deal value will be incremented with 1 year of cycles.
- Values:
null
or higher than1
. When billing frequency is set toone-time
, this value must be set tonull
. - Default:
null
Some things to consider when copying the duration
values to the new fields:
- The
duration
value should be set to1
so that it’s no longer considered for the deal value. - The deal value will change if there are amount discounts in either the updated product attachment or additional discounts.
- For companies in the Essential plan, we recommend merging the
duration
value withquantity
and updating the product unit with theduration_unit
value.
If you have any questions or comments, please let us know in the Developer’s Community.