Pipedrive: Get Installments

List the payment installments on a set of Pipedrive deals.

Tool ID: pipedrive_get_installments

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pipedrive_get_installments',
  {
    "deal_ids": [
      123
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pipedrive_get_installments --input '{
  "deal_ids": [
    123
  ]
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "success": true,
    "data": [
      {
        "id": 123,
        "amount": 123,
        "billing_date": "2026-01-15T12:00:00Z"
      }
    ]
  }
}

Use deepline describe pipedrive_get_installments --json for the latest machine-readable contract.

Input reference

Lists installments attached to a list of deals. Only available in Growth and above plans.

Name	Type	Required	Default	Details
`payload.deal_ids`	`array`	Yes	—	An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
`payload.cursor`	`string`	No	—	For pagination, the marker (an opaque string value) representing the first item on the next page
`payload.limit`	`integer`	No	—	For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
`payload.sort_by`	`"id" \| "billing_date" \| "deal_id"`	No	`"id"`	The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`. Allowed: `id`, `billing_date`, `deal_id`.
`payload.sort_direction`	`"asc" \| "desc"`	No	`"asc"`	The sorting direction. Supported values: `asc`, `desc`. Allowed: `asc`, `desc`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.success`	`boolean`	No	—	If the response is successful or not
`result.data.data`	`array`	No	—	Array containing data for all installments added to a deal
`result.data.data[].id`	`integer`	No	—	The ID of the installment
`result.data.data[].amount`	`number`	No	—	The installment amount.
`result.data.data[].billing_date`	`string`	No	—	The date on which the installment will be charged.
`result.data.data[].description`	`string`	No	—	The name of installment.
`result.data.data[].deal_id`	`integer`	No	—	The ID of the deal the installment was added to.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation