Type alias Subscription

Subscription: { addons: SubscriptionAddon[]; billingId?: string; cancellationDate?: Date; crmId?: string; currentBillingPeriodEnd?: Date; effectiveEndDate?: Date; endDate?: Date; experimentInfo?: ExperimentInfo | null; futureUpdates: SubscriptionFutureUpdateDataFragment[]; id: string; latestInvoice?: SubscriptionInvoiceFragment; metadata?: Metadata | null; paymentCollection: PaymentCollection; plan: Plan; price: SubscriptionPrice | null; prices: Price[]; pricingType: PricingType; resourceId?: string; scheduledUpdates?: CustomerPortalSubscriptionScheduledUpdateDataFragment[]; startDate: Date; status: SubscriptionStatus; totalPrice: TotalPriceFragment | null | undefined; trialEndDate?: Date }

Type declaration

  • addons: SubscriptionAddon[]
  • Optional billingId?: string
  • Optional cancellationDate?: Date
  • Optional crmId?: string
  • Optional currentBillingPeriodEnd?: Date
  • Optional effectiveEndDate?: Date

    The calculated end date after which the subscription will be canceled, which takes trial expiration and scheduled cancellations into consideration

  • Optional endDate?: Date
  • Optional experimentInfo?: ExperimentInfo | null
  • futureUpdates: SubscriptionFutureUpdateDataFragment[]

    Future updates can be of 2 types SubscriptionScheduleStatus.Scheduled or SubscriptionScheduleStatus.PendingPayment

  • id: string
  • Optional latestInvoice?: SubscriptionInvoiceFragment
  • Optional metadata?: Metadata | null
  • paymentCollection: PaymentCollection
  • plan: Plan
  • price: SubscriptionPrice | null

    Deprecated

    use prices instead with totalPrice

  • prices: Price[]
  • pricingType: PricingType
  • Optional resourceId?: string
  • Optional scheduledUpdates?: CustomerPortalSubscriptionScheduledUpdateDataFragment[]

    Deprecated

    use futureUpdates instead with filter for SubscriptionScheduleStatus.Scheduled

  • startDate: Date
  • status: SubscriptionStatus
  • totalPrice: TotalPriceFragment | null | undefined
  • Optional trialEndDate?: Date

Settings

Member Visibility

Theme