Interface CurrentPhase

Object representing the current phase in an org's subscription schedule

Hierarchy

  • CurrentPhase

Properties

current? effective end? features? fragments? plans? trial

Properties

Optional current

current?: {
    effective: Date;
    end: Date;
}

The effective and end date of the current billing period

For trial periods, this will be the start and end of the trial phase, no matter how long it is.

Type declaration

  • effective: Date
  • end: Date

effective

effective: Date

When the current phase became effective

Optional end

end?: Date

When the current phase will end (if defined)

Optional features

features?: `feature:${string}@plan:${string}@${string}`[]

The set of versioned features the customer is subscribed to in this phase

Optional fragments

fragments?: `feature:${string}@plan:${string}@${string}`[]

One-off versioned features that the customer is subscribed to

Optional plans

plans?: `plan:${string}@${string}`[]

The set of plans the customer is currently subscribed to in this phase

trial

trial: boolean

Whether or not this is a trial phase

Settings

Member Visibility

Theme

Generated using TypeDoc