1
0
Files
PayPal-PHP-Server-SDK/doc/models/plan-override.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

157 lines
4.7 KiB
Markdown

# 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.
## Structure
`PlanOverride`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `billingCycles` | [`?(BillingCycleOverride[])`](../../doc/models/billing-cycle-override.md) | Optional | 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.<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `12` | getBillingCycles(): ?array | setBillingCycles(?array billingCycles): void |
| `paymentPreferences` | [`?PaymentPreferencesOverride`](../../doc/models/payment-preferences-override.md) | Optional | The payment preferences to override at subscription level. | getPaymentPreferences(): ?PaymentPreferencesOverride | setPaymentPreferences(?PaymentPreferencesOverride paymentPreferences): void |
| `taxes` | [`?TaxesOverride`](../../doc/models/taxes-override.md) | Optional | The tax details. | getTaxes(): ?TaxesOverride | setTaxes(?TaxesOverride taxes): void |
## Example (as JSON)
```json
{
"billing_cycles": [
{
"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"
},
"sequence": 8,
"total_cycles": 198
},
{
"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"
},
"sequence": 8,
"total_cycles": 198
},
{
"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"
},
"sequence": 8,
"total_cycles": 198
}
],
"payment_preferences": {
"auto_bill_outstanding": false,
"setup_fee": {
"currency_code": "currency_code8",
"value": "value4"
},
"setup_fee_failure_action": "CONTINUE",
"payment_failure_threshold": 104
},
"taxes": {
"percentage": "percentage8",
"inclusive": false
}
}
```