Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

WalletUpdate

namestringOptional

Updated wallet name

expiration_atstring<DateTimeWithZone>Optional

Cancelled date of the subscription

Formatdate-time

applies_toobject<PrepaidCreditAppliesTo>Optional

Indicates whether the prepaid credit applies to the entire invoice or only to specific line items.

PrepaidCreditAppliesTo properties

1 property

fee_typesarray<FeeType>Optional

recurring_transaction_rulesobject<RecurringTransactionRule>[]Optional

List of recurring transaction rules for automatic top-ups

RecurringTransactionRule properties

9 properties

triggerenum<RecurringTransactionTrigger>Required

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+)?$

methodenum<RecurringTransactionMethod>Required

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

WalletUpdate

namestringOptional

Updated wallet name

expiration_atstring<DateTimeWithZone>Optional

Cancelled date of the subscription

Formatdate-time

applies_toobject<PrepaidCreditAppliesTo>Optional

Indicates whether the prepaid credit applies to the entire invoice or only to specific line items.

PrepaidCreditAppliesTo properties

1 property

fee_typesarray<FeeType>Optional

recurring_transaction_rulesobject<RecurringTransactionRule>[]Optional

List of recurring transaction rules for automatic top-ups

RecurringTransactionRule properties

9 properties

triggerenum<RecurringTransactionTrigger>Required

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+)?$

methodenum<RecurringTransactionMethod>Required

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.

WalletUpdate

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Back to top

On this page

On this page

WalletUpdate

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Back to top

On this page

WalletUpdate

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

WalletUpdate

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Back to top

On this page