PayPal-PHP-Server-SDK/doc/models/payment-preferences-override.md

Payment Preferences Override

The payment preferences to override at subscription level.

Structure

PaymentPreferencesOverride

Fields

Name	Type	Tags	Description	Getter	Setter
autoBillOutstanding	?bool	Optional	Indicates whether to automatically bill the outstanding amount in the next billing cycle.	getAutoBillOutstanding(): ?bool	setAutoBillOutstanding(?bool autoBillOutstanding): void
setupFee	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getSetupFee(): ?Money	setSetupFee(?Money setupFee): void
setupFeeFailureAction	?string(SetupFeeFailureAction)	Optional	The action to take on the subscription if the initial payment for the setup fails. Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$	getSetupFeeFailureAction(): ?string	setSetupFeeFailureAction(?string setupFeeFailureAction): void
paymentFailureThreshold	?int	Optional	The maximum number of payment failures before a subscription is suspended. For example, if payment_failure_threshold is 2, the subscription automatically updates to the SUSPEND state if two consecutive payments fail. Constraints: >= 0, <= 999	getPaymentFailureThreshold(): ?int	setPaymentFailureThreshold(?int paymentFailureThreshold): void

Example (as JSON)

{
  "auto_bill_outstanding": false,
  "setup_fee": {
    "currency_code": "currency_code8",
    "value": "value4"
  },
  "setup_fee_failure_action": "CONTINUE",
  "payment_failure_threshold": 80
}