Subscriptions
Returns details of an installment or a recurring Subscription
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True |
ID of the Subscription. |
AddTime | Datetime | True |
AddTime. |
CadenceType | String | False |
Interval between payments. The allowed values are weekly, monthly, quarterly, yearly. |
Currency | String | False |
The currency of the Installment Subscription. Accepts a 3-character currency code. |
CycleAmount | Double | False |
Amount of each payment. |
CyclesCount | Integer | False |
Shows how many payments the Subscription has. |
DealId | Integer | False |
ID of the Deal this Installment Subscription is associated with. |
Description | String | False |
Description of the Recurring Subscription. |
EndDate | String | False |
EndDate. |
FinalStatus | String | True |
FinalStatus. |
Infinite | Boolean | False |
This indicates that the Recurring Subscription will last until it's manually canceled or deleted. |
IsActive | Boolean | True |
IsActive. |
LifetimeValue | Double | True |
LifetimeValue. |
StartDate | String | False |
Start date of the Recurring Subscription. Format: YYYY-MM-DD |
UpdateTime | Datetime | False |
UpdateTime. |
UserId | Integer | True |
UserId. |
SubscriptionType | String | True |
SubscriptionType. The allowed values are recurring, installment. The default value is recurring. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Payments | String |
Array of payments. |
EffectiveDate | Date |
Array of payments. |
UpdateDealValue | Boolean |
Indicates that the Deal value must be set to Recurring Subscription's MRR value. |