OBJECT

SubscriptionItem

link GraphQL Schema definition

  • type SubscriptionItem implements OrderItemInterface {
  • # Indicates whether deactivation of the subscription item is allowed.
  • allowDeactivation: Boolean
  • # List of billing events related to the subscription item, including signups,
  • # renewals, and upgrades.
  • #
  • # Arguments
  • # includeAllVersions: Ignore item version when filtering
  • # billings.
  • billings(includeAllVersions: Boolean): [SubscriptionItemBilling]
  • # Indicates whether the subscription item is active and can be deactivated.
  • canDeactivate: Boolean
  • # Indicates whether the subscription item is inactive and can be reinstated.
  • canReinstate: Boolean
  • # Pricing information that your company set up in the cleverbridge platform.
  • clientPricing: Pricing
  • # Coupon code for a promotion associated with the product.
  • couponCode: String
  • # Number of the last successfully paid interval of the subscription item. Counting
  • # starts at 0. For each successfully paid interval, the number is increased by
  • # one.
  • currentInterval: Int
  • # Pricing information that the customer receives during the purchase process.
  • customerPricing: Pricing
  • # Client policy and procedures for deactivation of subscriptions.
  • deactivationPolicy: ClientPolicy
  • # Amount that will be charged on the next billing date.
  • nextBillingAmount: CurrencyAmount
  • # Product details for the item.
  • productInformation: ProductInformation
  • # Promotion associated with the item.
  • promotion: Promotion
  • # Number of items.
  • quantity: Int!
  • # Running number of the item in the subscription.
  • runningNumber: Int!
  • # Status of the subscription item.
  • status: SubscriptionItemStatus
  • # Related subscription.
  • subscription: Subscription
  • # Version of the item.
  • version: Int!
  • # Date and time when the item version became active. Corresponds to the date and
  • # time when payment was received or, for purchase orders, when the purchase order
  • # was processed. null indicates that the item version is not active yet, for
  • # example because the customer upgraded the subscription item starting from the
  • # next renewal date.
  • versionActiveSince: DateTime
  • }