On this page
No Headings
objectexternal_customer_idrequiredstringExternal reference to the customer
currencyrequiredobject^[A-Z]{3}$Currency in which the wallet operates
namestringName of the wallet
rate_amountrequiredstring^(?!0+(?:\.0+)?$)\d+(\.\d+)?$Cost rate per credit unit, must be non zero positive value
paid_creditsstring^(0|[1-9]\d*)(\.\d+)?$Number of paid credits to initialize, must be positive value
granted_creditsstring^(0|[1-9]\d*)(\.\d+)?$Number of granted credits to initialize, must be positive value
expiration_atobjectdate-timeCancelled date of the subscription
applies_toobjectIndicates whether the prepaid credit applies to the entire invoice or only to specific line items.
fee_typesarrayitemsstring"SUBSCRIPTION", "COMMITMENT", "CHARGE"Types of fees that wallet prepaid credits can be applied to
recurring_transaction_rulesarrayList of recurring transaction rules for automatic top-ups
itemsobjectDefines a recurring wallet transaction rule that triggers based on specific conditions.
triggerrequiredstring"INTERVAL", "THRESHOLD"Condition that triggers the recurring transaction rule
paid_creditsstring^(0|[1-9]\d*)(\.\d+)?$Number of paid credits to be added when the rule is triggered. Must be a positive value
granted_creditsstring^(0|[1-9]\d*)(\.\d+)?$Number of granted credits to be added when the rule is triggered. Must be a positive value
methodrequiredstring"FIXED", "TARGET"Method for recurring transaction execution
intervalstring"WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY"The billing cycle indicating how often the subscription is charged
started_atobjectdate-timeStart date of the recurring wallet transaction rule
expiration_atobjectdate-timeExpiration date of the recurring wallet transaction rule
threshold_creditsstringThreshold of credits that triggers the recurring transaction rule.
target_ongoing_balancestringTarget ongoing balance that triggers the recurring transaction rule.