PayPal · Schema

Payment Preferences

The payment preferences for a subscription.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
auto_bill_outstanding	boolean	Indicates whether to automatically bill the outstanding amount in the next billing cycle.
setup_fee	object	The initial set-up fee for the service.
setup_fee_failure_action	string	The action to take on the subscription if the initial payment for the setup fails.
payment_failure_threshold	integer	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 cons

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/payment_preferences",
  "title": "Payment Preferences",
  "description": "The payment preferences for a subscription.",
  "type": "object",
  "properties": {
    "auto_bill_outstanding": {
      "type": "boolean",
      "description": "Indicates whether to automatically bill the outstanding amount in the next billing cycle.",
      "default": true
    },
    "setup_fee": {
      "description": "The initial set-up fee for the service.",
      "$ref": "#/components/schemas/money"
    },
    "setup_fee_failure_action": {
      "type": "string",
      "description": "The action to take on the subscription if the initial payment for the setup fails.",
      "minLength": 1,
      "maxLength": 24,
      "pattern": "^[A-Z_]+$",
      "default": "CANCEL",
      "enum": [
        "CONTINUE",
        "CANCEL"
      ]
    },
    "payment_failure_threshold": {
      "type": "integer",
      "description": "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.",
      "minimum": 0,
      "maximum": 999,
      "default": 0
    }
  }
}