The billing cycle details to override at subscription level. The subscription billing cycle definition has to adhere to the plan billing cycle definition.
The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.
sequence
integer
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 cycl
total_cycles
integer
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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/billing_cycle_override",
"title": "Billing Cycle Override",
"description": "The billing cycle details to override at subscription level. The subscription billing cycle definition has to adhere to the plan billing cycle definition.",
"type": "object",
"properties": {
"pricing_scheme": {
"description": "The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.",
"$ref": "#/components/schemas/pricing_scheme"
},
"sequence": {
"type": "integer",
"description": "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.",
"minimum": 1,
"maximum": 99
},
"total_cycles": {
"type": "integer",
"description": "The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between <code>1</code> and <code>999</code> for <code>total_cycles</code>). Regular billing cycles can be executed infinite times (value of <code>0</code> for <code>total_cycles</code>) or a finite number of times (value between <code>1</code> and <code>999</code> for <code>total_cycles</code>).",
"minimum": 0,
"maximum": 999
}
},
"required": [
"sequence"
]
}