deals_list_installments
Retrieve scheduled payments (installments) for one or more deals by providing deal IDs.
Instructions
List installments attached to one or more deals (API v2).
Installments are scheduled, fixed payments on a deal (the modern replacement for the legacy subscriptions feature). Pass the deal IDs you want installments for.
Common use cases:
Installments of one deal: { "deal_ids": [123] }
Installments across several deals: { "deal_ids": [123, 456, 789] }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Items per page (max 500) | |
| cursor | No | Pagination cursor from a previous call | |
| deal_ids | Yes | Deal IDs to fetch installments for (1-100) |