1
0
Files
PayPal-PHP-Server-SDK/doc/models/subscription-pricing-scheme.md
Patrick Powers 1fc2cf1e07 2.0.0 Release (#58)
* Automated commit message

* Automated commit message

* add changelog

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2025-11-13 16:32:53 -06:00

3.2 KiB

Subscription Pricing Scheme

The pricing scheme details.

Structure

SubscriptionPricingScheme

Fields

Name Type Tags Description Getter Setter
version ?int Optional The version of the pricing scheme.

Constraints: >= 0, <= 999
getVersion(): ?int setVersion(?int version): void
fixedPrice ?Money Optional The currency and amount for a financial transaction, such as a balance or payment due. getFixedPrice(): ?Money setFixedPrice(?Money fixedPrice): void
pricingModel ?string(SubscriptionPricingModel) Optional The pricing model for tiered plan. The tiers parameter is required.

Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$
getPricingModel(): ?string setPricingModel(?string pricingModel): void
tiers ?(PricingTier[]) Optional An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified.

Constraints: Minimum Items: 1, Maximum Items: 32
getTiers(): ?array setTiers(?array tiers): void
createTime ?string Optional The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
getCreateTime(): ?string setCreateTime(?string createTime): void
updateTime ?string Optional The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
getUpdateTime(): ?string setUpdateTime(?string updateTime): void

Example (as JSON)

{
  "version": 172,
  "fixed_price": {
    "currency_code": "currency_code4",
    "value": "value0"
  },
  "pricing_model": "VOLUME",
  "tiers": [
    {
      "starting_quantity": "starting_quantity8",
      "ending_quantity": "ending_quantity6",
      "amount": {
        "currency_code": "currency_code6",
        "value": "value0"
      }
    },
    {
      "starting_quantity": "starting_quantity8",
      "ending_quantity": "ending_quantity6",
      "amount": {
        "currency_code": "currency_code6",
        "value": "value0"
      }
    },
    {
      "starting_quantity": "starting_quantity8",
      "ending_quantity": "ending_quantity6",
      "amount": {
        "currency_code": "currency_code6",
        "value": "value0"
      }
    }
  ],
  "create_time": "create_time2"
}