OBJECT

Subscription

link GraphQL Schema definition

  • type Subscription {
  • # List of billings related to the subscription, including signups, renewals, and
  • # upgrades.
  • billings: [SubscriptionBilling]
  • # Indicates whether the client account uses Subscription Management 2.0 and the
  • # renewal type can be updated.
  • canUpdateRenewalType: Boolean
  • # Link for a customer to change their payment information.
  • changePaymentUrl: String
  • # Number of the last successfully paid interval of the subscription. Counting
  • # starts at 0. For each successfully paid interval, the number is increased by
  • # one.
  • currentInterval: Int
  • # Customer who signed up for the subscription.
  • customer: Customer
  • # List of emails generated for the subscription.
  • emails: [Email]
  • # Unique ID of the subscription.
  • id: Int!
  • # List of subscription items.
  • #
  • # Arguments
  • # includeOldVersions: Set to true to not only get the current
  • # version of the subscription item but also previous versions.
  • # hideInactiveItems: Set to true to get only active subscription
  • # items.
  • items(includeOldVersions: Boolean, hideInactiveItems: Boolean): [SubscriptionItem]
  • # Amount that will be charged on the next billing date.
  • nextBillingAmount: CurrencyAmount
  • # Next billing date and time.
  • nextBillingDate: DateTime
  • # Date and time when next billing reminder is sent.
  • nextBillingReminderDate: DateTime
  • # Parameters of the subscription.
  • parameters: [SubscriptionParameter]
  • # List of PDF documents sent to the customer as an email attachment.
  • purchaseDocuments: [PurchaseDocument]
  • # Renewal type of the subscription.
  • renewalType: SubscriptionRenewalType
  • # Date and time when subscription is paid for the first time. If a purchase order
  • # is used, this is the date when the subscription is processed for the first time.
  • startDate: DateTime
  • # Status of the subscription.
  • status: SubscriptionStatus
  • }