Introducing Subscriptions APIs

We have added a brand new Subscriptions resource to our API which represents the Recurring Revenue feature inside Pipedrive.

Subscriptions represent the revenue that is occurring over time with payments either in set or varying amounts. Subscriptions have two types - installment and recurring. Installment Subscription occurs over time with payments in varying amounts and payment dates. Recurring Subscription occurs over fixed intervals of time with payments of the same amount.

The Subscriptions resource includes the following endpoints:

• GET /subscriptions/{id}
• GET /subscriptions/find/{dealId}
• GET /subscriptions/{id}/payments
• POST /subscriptions/recurring
• POST /subscriptions/installment
• PUT /subscriptions/recurring/{id}
• PUT /subscriptions/installment/{id}
• PUT /subscriptions/recurring/{id}/cancel
• DELETE /subscriptions/{id}

To be able to use an endpoint using OAuth authorization, the endpoint needs to be added to a scope. We have added the endpoints of the Subscriptions resource to our deals:read and deals:full scopes. You can read more about the scopes and permission explanations here.

If you wish to update the scopes of an already approved or published app, be sure to learn how changing the scopes will affect your existing users.

Published on August 6, 2020