> ## 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: Update Installment

> Update an installment added to a deal. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Update an installment added to a deal.

<Info>
  Tool ID: `pipedrive_update_installment`
</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_update_installment',
  {
    "id": 123,
    "installment_id": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute pipedrive_update_installment --input '{
  "id": 123,
  "installment_id": 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_update_installment --json` for the latest machine-readable contract.

## Input reference

Edits an installment added to a deal. Only available in Growth and above plans.

| Name                     | Type      | Required | Default | Details                                                                              |
| ------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------ |
| `payload.id`             | `integer` | Yes      | —       | The ID of the deal                                                                   |
| `payload.installment_id` | `integer` | Yes      | —       | The ID of the installment                                                            |
| `payload.description`    | `string`  | No       | —       | The name of the installment.                                                         |
| `payload.amount`         | `number`  | No       | —       | The installment amount. Must be a positive number (excluding 0).                     |
| `payload.billing_date`   | `string`  | No       | —       | The date on which the installment will be charged. Must be in the format YYYY-MM-DD. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Edits an installment added to a deal. Only available in Growth and above plans.",
    "properties": {
      "id": {
        "type": "integer",
        "description": "The ID of the deal"
      },
      "installment_id": {
        "type": "integer",
        "description": "The ID of the installment"
      },
      "description": {
        "type": "string",
        "description": "The name of the installment."
      },
      "amount": {
        "type": "number",
        "description": "The installment amount. Must be a positive number (excluding 0)."
      },
      "billing_date": {
        "type": "string",
        "description": "The date on which the installment will be charged. Must be in the format YYYY-MM-DD."
      }
    },
    "required": [
      "id",
      "installment_id"
    ],
    "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`              | `object`  | No       | —       | —                                                  |
| `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": "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)