PayPal · Schema

Plan Override

An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
billing_cycles array An array of billing cycles for trial billing and regular billing. The subscription billing cycle definition has to adhere to the plan billing cycle definition.
payment_preferences object
taxes object
View JSON Schema on GitHub

JSON Schema

paypal-plan-override-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/plan_override",
  "title": "Plan Override",
  "description": "An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object.",
  "type": "object",
  "properties": {
    "billing_cycles": {
      "type": "array",
      "description": "An array of billing cycles for trial billing and regular billing. The subscription billing cycle definition has to adhere to the plan billing cycle definition.",
      "minItems": 1,
      "maxItems": 12,
      "items": {
        "$ref": "#/components/schemas/billing_cycle_override"
      }
    },
    "payment_preferences": {
      "$ref": "#/components/schemas/payment_preferences_override"
    },
    "taxes": {
      "$ref": "#/components/schemas/taxes_override"
    }
  }
}