Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Subscriptions > Phases

Get subscription phase

Retrieve the details of a phase for an existing subscription.

get/v2/subscriptions/{id}/phases/{phaseId}

Path parameters

idstring required
phaseIdstring required

Response

idstring required

Subscription phase ID.

namestring nullable required

Name of the subscription phase.

type'setup' | 'trial' | 'standard' required

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.
status'pending' | 'active' | 'finished' required

Status of subscription phase.

  • pending: The phase is waiting to start (not started yet).
  • active: The phase is currently in progress.
  • finished: The phase has ended and is complete.
ordernumber required

Order in which the phase is executed within all subscription phases.

activation_strategy'immediately' | 'manual' | 'start_date' | 'quote_signature' | 'checkout' | 'contract_start_date' | 'previous_phase_end' required

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.
end_strategy'manual' | 'end_date' | 'duration' | 'contract_end_date' required

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.
billing_date_setting'phase_start' | 'specific_date' required

Represents when the first billing date occurs.

  • phase_start: Aligns with the start of the phase.
  • specific_date: Occurs on a specified date.
initial_billing_atstring date-time nullable required

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.

starts_atstring date-time nullable required

Actual start date of the phase. UTC date time string in the ISO 8601 format.

ends_atstring date-time nullable required

Actual end date of the phase. UTC date time string in the ISO 8601 format.

billing_cycle_alignment'calendar_period' | 'anniversary' required

Alignment of product billing cycles.

  • 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.
do_not_invoice_phaseboolean required

Indicates if the phase should be invoiced. If set to true, the phase will not generate any invoices.

transition_calculation_method'prorata' | 'pay_in_full' | 'none' required

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.
transition_invoicing_schedule'immediately' required

Represents when the transition amount will be invoiced.

  • immediately: An invoice will be generated immediately with the corresponding amount.
created_atstring date-time required

Subscription phase creation date. UTC date time string in the ISO 8601 format.

updated_atstring date-time required

Subscription phase last edition date. UTC date time string in the ISO 8601 format.

Example response

{
  "id": "sup_1FoLfIQ5VOMbXf",
  "name": "Initial term",
  "type": "standard",
  "status": "pending",
  "activation_strategy": "manual",
  "end_strategy": "duration",
  "duration": {
    "count": 1,
    "period": "years"
  },
  "billing_date_setting": "phase_start",
  "billing_cycle_alignment": "anniversary",
  "transition_calculation_method": "prorata",
  "transition_invoicing_schedule": "immediately",
  "products": [
    {
      "id": "itm_FJKlqUb8COXw55",
      "name": "Product name",
      "description": "A description of the product.",
      "attached_at": "2024-01-15T00:00:00Z",
      "detached_at": "2024-04-15T00:00:00Z",
      "current_period_started_at": "2024-01-15T00:00:00Z",
      "current_period_ends_at": "2024-02-15T00:00:00Z",
      "next_payment_at": "2024-02-15T00:00:00Z",
      "payment_interval": {
        "period": "once"
      },
      "payment_schedule": "start",
      "count": 1
    }
  ],
  "created_at": "2024-10-12T07:00:01.860Z",
  "updated_at": "2024-10-12T07:00:01.860Z"
}