PayPal · Schema

Pricing Scheme

The pricing scheme details.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
version integer The version of the pricing scheme.
fixed_price object The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price chan
pricing_model string The pricing model for tiered plan. The `tiers` parameter is required.
tiers array An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified.
create_time object The date and time when this pricing scheme was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
update_time object The date and time when this pricing scheme was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
View JSON Schema on GitHub

JSON Schema

paypal-pricing-scheme-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pricing_scheme",
  "title": "Pricing Scheme",
  "description": "The pricing scheme details.",
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "description": "The version of the pricing scheme.",
      "minimum": 0,
      "maximum": 999,
      "readOnly": true
    },
    "fixed_price": {
      "description": "The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected.",
      "$ref": "#/components/schemas/money"
    },
    "pricing_model": {
      "type": "string",
      "description": "The pricing model for tiered plan. The `tiers` parameter is required.",
      "minLength": 1,
      "maxLength": 24,
      "pattern": "^[A-Z_]+$",
      "enum": [
        "VOLUME",
        "TIERED"
      ]
    },
    "tiers": {
      "type": "array",
      "description": "An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified.",
      "minItems": 1,
      "maxItems": 32,
      "items": {
        "$ref": "#/components/schemas/pricing_tier"
      }
    },
    "create_time": {
      "description": "The date and time when this pricing scheme was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
      "readOnly": true,
      "$ref": "#/components/schemas/date_time"
    },
    "update_time": {
      "description": "The date and time when this pricing scheme was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
      "readOnly": true,
      "$ref": "#/components/schemas/date_time"
    }
  }
}