lxbfYeaa/PayPal-PHP-Server-SDK
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-Server-SDK
Code Pull Requests Activity

2.0.0 Release (#58)

Browse Source 
* Automated commit message

* Automated commit message

* add changelog

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
This commit is contained in:
Patrick Powers
2025-11-13 16:32:53 -06:00
committed by GitHub
parent 6da8b9b5b8
commit 1fc2cf1e07
488 changed files with 32110 additions and 4157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
doc/models/billing-cycle-override.md Normal file
View File

@@ -0,0 +1,61 @@
# Billing Cycle Override
The billing cycle details to override at subscription level. The subscription billing cycle definition has to adhere to the plan billing cycle definition.
## Structure
`BillingCycleOverride`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `pricingScheme` | [`?SubscriptionPricingScheme`](../../doc/models/subscription-pricing-scheme.md) | Optional | The pricing scheme details. | getPricingScheme(): ?SubscriptionPricingScheme | setPricingScheme(?SubscriptionPricingScheme pricingScheme): void |
| `sequence` | `int` | Required | The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial cycle runs before the regular cycle.<br><br>**Constraints**: `>= 1`, `<= 99` | getSequence(): int | setSequence(int sequence): void |
| `totalCycles` | `?int` | Optional | The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).<br><br>**Constraints**: `>= 0`, `<= 999` | getTotalCycles(): ?int | setTotalCycles(?int totalCycles): void |
## Example (as JSON)
```json
{
"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": 58,
"total_cycles": 248
}
```