> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipedrive: Get Installments

> List installments added to a list of deals. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List installments added to a list of deals.

<Info>
  Tool ID: `pipedrive_get_installments`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
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

```bash theme={null}
deepline tools execute pipedrive_get_installments --input '{
  "deal_ids": [
    123
  ]
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

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

Use `deepline tools get 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`.                                                                       |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Lists installments attached to a list of deals. Only available in Growth and above plans.",
    "properties": {
      "deal_ids": {
        "type": "array",
        "description": "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.",
        "items": {
          "type": "integer"
        }
      },
      "cursor": {
        "type": "string",
        "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
      },
      "limit": {
        "type": "integer",
        "description": "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."
      },
      "sort_by": {
        "type": "string",
        "description": "The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.",
        "default": "id",
        "enum": [
          "id",
          "billing_date",
          "deal_id"
        ]
      },
      "sort_direction": {
        "type": "string",
        "description": "The sorting direction. Supported values: `asc`, `desc`.",
        "default": "asc",
        "enum": [
          "asc",
          "desc"
        ]
      }
    },
    "required": [
      "deal_ids"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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).             |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "If the response is successful or not"
          },
          "data": {
            "type": "array",
            "description": "Array containing data for all installments added to a deal",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the installment"
                },
                "amount": {
                  "type": "number",
                  "description": "The installment amount."
                },
                "billing_date": {
                  "type": "string",
                  "description": "The date on which the installment will be charged."
                },
                "description": {
                  "type": "string",
                  "description": "The name of installment."
                },
                "deal_id": {
                  "type": "integer",
                  "description": "The ID of the deal the installment was added to."
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Pipedrive provider guide](/docs/providers/pipedrive/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)