Skip to main content

SubscriptionDetails

Subscription state for one product area returned in me.subscriptions, including the current plan and any next-plan or fallback pricing.

type SubscriptionDetails {
  id: Int!
  paymentPlan: PaymentPlan
  isActive: Boolean!
  isExpired: Boolean!
  isCancelled: Boolean!
  isExpiring: Boolean!
  isCancelling: Boolean!
  startedOn: Int
  cancelledOn: Int
  expiredOn: Int
  renewOn: Int
  updatedAt: Int
  storageDuration: Int
  amount: Float
  products: [SubscriptionProduct]
  intervalType: SubscriptionIntervalType
  interval: Int
  nextAmount: Float
  nextIntervalType: SubscriptionIntervalType
  nextInterval: Int
  nextPaymentPlan: PaymentPlan
  fallbackAfter: Int
  fallbackAmount: Float
  fallbackInterval: Int
  fallbackIntervalType: SubscriptionIntervalType
}

Fields

`SubscriptionDetails.id` ● `Int!` non-null scalar

`SubscriptionDetails.paymentPlan` ● `PaymentPlan` object

`SubscriptionDetails.isActive` ● `Boolean!` non-null scalar

`SubscriptionDetails.isExpired` ● `Boolean!` non-null scalar

`SubscriptionDetails.isCancelled` ● `Boolean!` non-null scalar

`SubscriptionDetails.isExpiring` ● `Boolean!` non-null scalar

`SubscriptionDetails.isCancelling` ● `Boolean!` non-null scalar

`SubscriptionDetails.startedOn` ● `Int` scalar

Subscription start time in Unix seconds.

`SubscriptionDetails.cancelledOn` ● `Int` scalar

Cancellation time in Unix seconds; null when unset.

`SubscriptionDetails.expiredOn` ● `Int` scalar

Subscription expiry time in Unix seconds; null when unset.

`SubscriptionDetails.renewOn` ● `Int` scalar

Renewal time in Unix seconds; null when unset.

`SubscriptionDetails.updatedAt` ● `Int` scalar

Last subscription update time in Unix seconds.

`SubscriptionDetails.storageDuration` ● `Int` scalar

Recording retention duration in months; null for other product areas.

`SubscriptionDetails.amount` ● `Float` scalar

Recurring amount in decimal billing currency units; the currency code is not returned.

`SubscriptionDetails.products` ● `[SubscriptionProduct]` list object

`SubscriptionDetails.intervalType` ● `SubscriptionIntervalType` enum

`SubscriptionDetails.interval` ● `Int` scalar

`SubscriptionDetails.nextAmount` ● `Float` scalar

Next-plan amount in decimal billing currency units; the currency code is not returned.

`SubscriptionDetails.nextIntervalType` ● `SubscriptionIntervalType` enum

`SubscriptionDetails.nextInterval` ● `Int` scalar

`SubscriptionDetails.nextPaymentPlan` ● `PaymentPlan` object

`SubscriptionDetails.fallbackAfter` ● `Int` scalar

Fallback activation time in Unix seconds; null when unset.

`SubscriptionDetails.fallbackAmount` ● `Float` scalar

Fallback amount in decimal billing currency units; the currency code is not returned.

`SubscriptionDetails.fallbackInterval` ● `Int` scalar

`SubscriptionDetails.fallbackIntervalType` ● `SubscriptionIntervalType` enum

Member Of

SubscriptionTypes object

Fields
Member Of