forked from LiveCarta/PayPal-PHP-Server-SDK
6da8b9b5b8
* Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com> Co-authored-by: Patrick Powers <patickpowers@hey.com>
47 lines
3.1 KiB
Markdown
47 lines
3.1 KiB
Markdown
|
|
# Billing Cycle
|
|
|
|
The billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle. The sequence of the billing cycle will be in the following order - free trial billing cycle(s), discounted trial billing cycle(s), regular billing cycle(s).
|
|
|
|
## Structure
|
|
|
|
`BillingCycle`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `tenureType` | [`string(TenureType)`](../../doc/models/tenure-type.md) | Required | The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.<br><br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getTenureType(): string | setTenureType(string tenureType): void |
|
|
| `pricingScheme` | [`?PricingScheme`](../../doc/models/pricing-scheme.md) | Optional | The pricing scheme details. | getPricingScheme(): ?PricingScheme | setPricingScheme(?PricingScheme pricingScheme): void |
|
|
| `frequency` | `mixed` | Optional | The frequency details for this billing cycle. | getFrequency(): | setFrequency( frequency): 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>**Default**: `1`<br><br>**Constraints**: `>= 0`, `<= 999` | getTotalCycles(): ?int | setTotalCycles(?int totalCycles): void |
|
|
| `sequence` | `?int` | Optional | 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>**Default**: `1`<br><br>**Constraints**: `>= 1`, `<= 3` | getSequence(): ?int | setSequence(?int sequence): void |
|
|
| `startDate` | `?string` | Optional | The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.<br><br>**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `10`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])$` | getStartDate(): ?string | setStartDate(?string startDate): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"tenure_type": "REGULAR",
|
|
"total_cycles": 1,
|
|
"sequence": 1,
|
|
"pricing_scheme": {
|
|
"price": {
|
|
"currency_code": "currency_code8",
|
|
"value": "value4"
|
|
},
|
|
"pricing_model": "AUTO_RELOAD",
|
|
"reload_threshold_amount": {
|
|
"currency_code": "currency_code0",
|
|
"value": "value6"
|
|
}
|
|
},
|
|
"frequency": {
|
|
"key1": "val1",
|
|
"key2": "val2"
|
|
},
|
|
"start_date": "start_date0"
|
|
}
|
|
```
|
|
|