GraphQL OBJECT
Subscription
The subscription.
link Definition
- type Subscription {
- # Unique ID of the subscription.
- Int! :
- # Status of the subscription.
- SubscriptionStatus :
- # Renewal type of the subscription.
- SubscriptionRenewalType :
- # Indicates whether the client account uses Subscription Management 2.0 and the
- # renewal type can be updated.
- Boolean :
- # Indicates whether the subscription uses management model 1.0 or 2.0.
- SubscriptionManagementModelEnum :
- # Next billing date and time.
- DateTime :
- # Date and time when next billing reminder is sent.
- DateTime :
- # Next renewal date and time.
- DateTime :
- # Coupon code of a cart level promotion associated with the subscription.
- String :
- # Customer who signed up for the subscription.
- Customer :
- # List of billings related to the subscription, including signups, renewals, and
- # upgrades.
- SubscriptionBilling] : [
- # List of emails generated for the subscription.
- Email] : [
- # 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.
- Boolean, : Boolean): [SubscriptionItem] ( :
- # Parameters of the subscription.
- SubscriptionParameter] : [
- # Parameters of the subscription.
- SubscriptionParameter] @deprecated( reason: "Renamed to extraParameters." ) : [
- # Promotion associated with the subscription.
- Promotion :
- # 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.
- DateTime :
- # Pricing information that the customer will be charged for the next billing.
- Pricing :
- # Customer renewal pricing information.
- Pricing! :
- # Customer renewal pricing information of next subscription interval.
- Pricing! :
- # Price that will be charged on the next billing date.
- Price :
- # Amount that will be charged on the next billing date.
- CurrencyAmount @deprecated( reason: "Use nextBillingPrice instead." ) :
- # Number of the last successfully paid subscription interval of the subscription.
- # Counting starts at 0. For each successfully paid interval, the number is
- # increased by one.
- Int @deprecated( reason: "Use currentSubscriptionInterval instead." ) :
- # Number of the last successfully paid subscription interval of the subscription.
- # Counting starts at 0. For each successfully paid interval, the number is
- # increased by one.
- Int :
- # Number of the last successfully paid billing interval of the current
- # subscription interval. Only relevant if subscription term differs billing term.
- Int :
- # Length of billing intervals in months. Billing terms are also referred to as
- # payment schedules.
- Int :
- # Length of billing intervals in days. Billing terms are also referred to as
- # payment schedules.
- Int :
- # Billing intervals per subscription interval.
- Int :
- # Link for a customer to change their payment information.
- #
- # Arguments
- # returnUrl: If set a session Url is created and the returnUrl is
- # used after the change payment is completed
- String): String ( :
- # List of PDF documents sent to the customer as an email attachment.
- PurchaseDocument] : [
- # The business model that applies to this subscription.
- BusinessModel! :
- # The URL for the subscription self service page (if applicable).
- String :
- # Interval data.
- SubscriptionIntervalData] : [
- # Latest purchase of subscription.
- Purchase :
- # The client the subscription belongs to.
- Client :
- # Indicates whether the prices in stored in the subscription are the same after
- # recalculation with the current product setup.
- Boolean :
- # Renewal quotes of the subscription. By default only active and valid renewal
- # quotes are returned.
- #
- # Arguments
- # includeInactiveRenewalQuotes: Also include inactive renewal
- # quotes.
- # includeExpiredRenewalQuotes: Also include expired renewal
- # quotes.
- (
- Boolean, :
- Boolean :
- ): [RenewalQuote]
- }
link Required by
- AcceptRenewalQuoteResultnull
- ApplyCouponToSubscriptionPayloadPayload for applying a coupon code to a subscription.
- CreateSubscriptionPayloadPayload for created subscription.
- CustomerCustomer profile and transaction data.
- querynull
- RenewalQuoteRenewalQuote.
- RenewSubscriptionResultSubscription renewal information.
- SubscriptionItemItem of a subscription.
- UpdateNextBillingDatePayloadPayload for updated next billing date for the subscription.
- UpdateRenewalTypePayloadPayload for update of subscription renewal type.
- UpdateSubscriptionResultSubscription update information.
- UpgradeSubscriptionResultSubscription upgrade information.