Get subscription phase
Retrieve the details of a phase for an existing subscription.
Authorizations
Response
Type of subscription phase.
setup: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.trial: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.standard: The phase represents a standard recurring billing.
setup, trial, standard "standard"
Activation strategy of subscription phase.
immediately: The phase starts as soon as the subscription is activated.manual: The phase starts when a user manually activates it.start_date: The phase starts on a specified date.quote_signature: The phase starts when the subscription quote is signed.checkout: The phase starts when the subscription checkout is completed.contract_start_date: The phase starts on the start date of the related subscription contract.previous_phase_end: The phase starts when the previous phase ends.
immediately, manual, start_date, quote_signature, checkout, contract_start_date, previous_phase_end "manual"
End strategy of subscription phase.
manual: The phase ends when a user manually stops it.end_date: The phase ends on a specified date.duration: The phase ends after a specific relative duration.contract_end_date: The phase ends on the end date of the related subscription contract.
manual, end_date, duration, contract_end_date "duration"
Date when the subscription phase will start being billed. Only applies to specific_date billing date setting. UTC date time string in the ISO 8601 format.
null
Actual start date of the phase. UTC date time string in the ISO 8601 format.
null
Actual end date of the phase. UTC date time string in the ISO 8601 format.
null
Alignment of product billing cycles. If omitted at creation, the billing cycles alignment configured in the account subscription settings applies.
calendar_period: The billing cycles of the products will be aligned on the calendar period, after the first period which will be invoiced taking into account the prorata of the first cycle compared to the product periodicity.anniversary: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.
calendar_period, anniversary "anniversary"
Calculation method used when transitioning from one phase to the next one.
prorata: The prorated amount between the two phases relative to the end date (the transition date) must be paid.pay_in_full: The full amount for the phase billing period must be paid.none: No amount will need to be paid, phase will simply transition from one to the next.
prorata, pay_in_full, none "prorata"
Subscription phase creation date. UTC date time string in the ISO 8601 format.
"2024-10-12T07:00:01.860Z"
Subscription phase last edition date. UTC date time string in the ISO 8601 format.
"2024-10-12T07:00:01.860Z"

