Object that represents rule for wallet recurring transactions.
Name | Type | Description | Notes |
---|---|---|---|
lagoId | UUID | A unique identifier for the recurring transaction rule in the Lago application. Can be used to update a recurring transaction rule. | |
ruleType | RuleTypeEnum | The rule type. Possible values are `interval` or `threshold`. | |
interval | IntervalEnum | The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: `weekly`, `monthly`, `quarterly` or `yearly`. Required only if rule type is set to `interval`. | [optional] |
thresholdCredits | String | The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when rule type is set to `threshold`. | [optional] |
paidCredits | String | The number of paid credits. Required only if there is no granted credits. | |
grantedCredits | String | The number of free granted credits. Required only if there is no paid credits. | |
createdAt | OffsetDateTime | The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created |
Name | Value |
---|---|
INTERVAL | "interval" |
THRESHOLD | "threshold" |
Name | Value |
---|---|
WEEKLY | "weekly" |
MONTHLY | "monthly" |
QUARTERLY | "quarterly" |
YEARLY | "yearly" |