On this page
No Headings
external_customer_idrequiredstringExternal system reference to the customer
statusrequiredstring"ACTIVE", "TERMINATED", "PENDING"Current status of the wallet
available_balanceobjectongoing_usageobjectThe ongoing usage of the wallet, and it reflects all current usage and draft invoices including taxes.
net_balanceobjectThis represents the real-time balance after accounting for current usage,.
namestringHuman-readable wallet name
rate_amountrequiredstringPrice charged per credit unit
available_creditsstringCurrent credit balance available
ongoing_usage_creditsstringThis reflects all current usage and draft invoices.
net_balance_creditsstringThis represents the real time balance after accounting for current usage.
consumed_creditsstringTotal credits consumed so far
created_atobjectdate-timeDate and time when the wallet was created, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
expiration_atobjectdate-timeDate and time when the wallet is set to expire, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
terminated_atobjectdate-timeDate and time when the wallet was terminated, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
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.
idstringUnique identifier for the wallet