RecurringTransactionRule

Condition that triggers the recurring transaction rule

Value in"INTERVAL" | "THRESHOLD"

paid_creditsstringOptional

Number of paid credits to be added when the rule is triggered. Must be a positive value

Match^(0|[1-9]\d*)(\.\d+)?$

granted_creditsstringOptional

Number of granted credits to be added when the rule is triggered. Must be a positive value

Match^(0|[1-9]\d*)(\.\d+)?$

Method for recurring transaction execution

Value in"FIXED" | "TARGET"

intervalenum<BillingCycle>Optional

The billing cycle indicating how often the subscription is charged

Value in"WEEKLY" | "MONTHLY" | "QUARTERLY" | "YEARLY"

started_atstring<DateTimeWithZone>Optional

Start date of the recurring wallet transaction rule

Formatdate-time

expiration_atstring<DateTimeWithZone>Optional

Expiration date of the recurring wallet transaction rule

Formatdate-time

threshold_creditsstringOptional

Threshold of credits that triggers the recurring transaction rule.

target_ongoing_balancestringOptional

Target ongoing balance that triggers the recurring transaction rule.

Back to top