PayPal-PHP-Server-SDK/doc/models/plan-request.md

Plan Request

The create plan request details.

Structure

PlanRequest

Fields

Name	Type	Tags	Description	Getter	Setter
productId	string	Required	The ID of the product created through Catalog Products API. Constraints: Minimum Length: 22, Maximum Length: 22, Pattern: ^PROD-[A-Z0-9]*$	getProductId(): string	setProductId(string productId): void
name	string	Required	The plan name. Constraints: Minimum Length: 1, Maximum Length: 127, Pattern: ^.*$	getName(): string	setName(string name): void
status	?string(PlanRequestStatus)	Optional	The initial state of the plan. Allowed input values are CREATED and ACTIVE. Default: PlanRequestStatus::ACTIVE Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$	getStatus(): ?string	setStatus(?string status): void
description	?string	Optional	The detailed description of the plan. Constraints: Minimum Length: 1, Maximum Length: 127, Pattern: ^.*$	getDescription(): ?string	setDescription(?string description): void
billingCycles	SubscriptionBillingCycle[]	Required	An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle. Constraints: Minimum Items: 1, Maximum Items: 12	getBillingCycles(): array	setBillingCycles(array billingCycles): void
paymentPreferences	PaymentPreferences	Required	The payment preferences for a subscription.	getPaymentPreferences(): PaymentPreferences	setPaymentPreferences(PaymentPreferences paymentPreferences): void
merchantPreferences	?MerchantPreferences	Optional	The merchant preferences for a subscription.	getMerchantPreferences(): ?MerchantPreferences	setMerchantPreferences(?MerchantPreferences merchantPreferences): void
taxes	?Taxes	Optional	The tax details.	getTaxes(): ?Taxes	setTaxes(?Taxes taxes): void
quantitySupported	?bool	Optional	Indicates whether you can subscribe to this plan by providing a quantity for the goods or service. Default: false	getQuantitySupported(): ?bool	setQuantitySupported(?bool quantitySupported): void

Example (as JSON)

{
  "product_id": "product_id2",
  "name": "name2",
  "status": "ACTIVE",
  "billing_cycles": [
    {
      "frequency": {
        "interval_unit": "DAY",
        "interval_count": 1
      },
      "tenure_type": "REGULAR",
      "sequence": 8,
      "total_cycles": 1,
      "pricing_scheme": {
        "version": 10,
        "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_time4"
      }
    }
  ],
  "payment_preferences": {
    "auto_bill_outstanding": true,
    "setup_fee_failure_action": "CANCEL",
    "payment_failure_threshold": 0,
    "setup_fee": {
      "currency_code": "currency_code8",
      "value": "value4"
    }
  },
  "quantity_supported": false,
  "description": "description8",
  "merchant_preferences": {
    "return_url": "return_url4",
    "cancel_url": "cancel_url6"
  },
  "taxes": {
    "percentage": "percentage8",
    "inclusive": false
  }
}