| Name | Type | Description | Notes |
|---|---|---|---|
| dealId | Number | ID of the Deal this Recurring Subscription is associated with | |
| currency | String | The currency of the Recurring Subscription. Accepts a 3-character currency code. | |
| description | String | Description of the Recurring Subscription | [optional] |
| cadenceType | String | Interval between payments | |
| cyclesCount | Number | Shows how many payments the Subscription has. Note that one field must be set: cycles_count or infinite. If cycles_count is set, then cycle_amount and start_date are also required. | [optional] |
| cycleAmount | Number | Amount of each payment | [optional] |
| startDate | Date | Start date of the Recurring Subscription. Format: YYYY-MM-DD | [optional] |
| infinite | Boolean | This indicates that the Recurring Subscription will last until it's manually canceled or deleted. Note that only one field must be set: cycles_count or infinite. | [optional] |
| payments | [Object] | Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD). | [optional] |
| updateDealValue | Boolean | Indicates that the Deal value must be set to Recurring Subscription's MRR value | [optional] |
-
weekly(value:"weekly") -
monthly(value:"monthly") -
quarterly(value:"quarterly") -
yearly(value:"yearly")