The ID of the deal this recurring subscription is associated with
currencystring
Required
The currency of the recurring subscription. Accepts a 3-character currency code.
infiniteboolean
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`.
paymentsarray
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).
start_datestring
Required
The start date of the recurring subscription. Format: YYYY-MM-DD
descriptionstring
The description of the recurring subscription
cadence_typestring
Required
The interval between payments
cycle_amountinteger
Required
The amount of each payment
cycles_countinteger
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.
update_deal_valueboolean
Indicates that the deal value must be set to recurring subscription"s MRR value
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not