Subscription
Requires the or scope.
Custom subscription discount.
Anchor to FieldsFields
- entitledLines (SubscriptionDiscountEntitledLines!)
- id (ID!)
- recurringCycleLimit (Int)
- rejectionReason (SubscriptionDiscountRejectionReason)
- targetType (DiscountTargetType!)
- title (String)
- type (DiscountType!)
- usageCount (Int!)
- value (SubscriptionDiscountValue!)
- Anchor to entitledLinesentitled•Subscription
Lines Discount Entitled Lines! non-null Entitled line items used to apply the subscription discount on.
Show fields
- •ID!non-null
The unique ID.
- Anchor to recurringCycleLimitrecurring•Int
Cycle Limit The maximum number of times the subscription discount will be applied on orders.
- Anchor to rejectionReasonrejection•Subscription
Reason Discount Rejection Reason The reason that the discount on the subscription draft is rejected.
Show enum values
- Anchor to targetTypetarget•Discount
Type Target Type! non-null Type of line the discount applies on.
Show enum values
- Anchor to titletitle•String
The title associated with the subscription discount.
- Anchor to typetype•Discount
Type! non-null The type of the subscription discount.
Show enum values
- Anchor to usageCountusage•Int!
Count non-null The number of times the discount was applied.
- Anchor to valuevalue•Subscription
Discount Value! non-null The value of the subscription discount.
Show union types
Anchor to MutationsMutations
Deprecated mutations
- subscriptionDraftDiscountAdd (SubscriptionDraftDiscountAddPayload): deprecated
- subscriptionDraftDiscountUpdate (SubscriptionDraftDiscountUpdatePayload): deprecated
- subscriptionDraftFreeShippingDiscountAdd (SubscriptionDraftFreeShippingDiscountAddPayload): deprecated
- subscriptionDraftFreeShippingDiscountUpdate (SubscriptionDraftFreeShippingDiscountUpdatePayload): deprecated
- subscriptionDraftLineRemove (SubscriptionDraftLineRemovePayload): deprecated
- •mutationDeprecated
Show payload
- Anchor to draftIddraft•ID!
Id required The ID of the Subscription Contract draft to add a subscription discount to.
- Anchor to inputinput•Subscription
Manual Discount Input! required The properties of the new Subscription Discount.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- Anchor to discountIddiscount•ID!
Id required The gid of the Subscription Discount to update.
- Anchor to draftIddraft•ID!
Id required The ID of the Subscription Contract draft to update a subscription discount on.
- Anchor to inputinput•Subscription
Manual Discount Input! required The properties to update on the Subscription Discount.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- Anchor to draftIddraft•ID!
Id required The ID of the subscription contract draft to add a subscription free shipping discount to.
- Anchor to inputinput•Subscription
Free Shipping Discount Input! required The properties of the new subscription free shipping discount.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- Anchor to discountIddiscount•ID!
Id required The gid of the Subscription Discount to update.
- Anchor to draftIddraft•ID!
Id required The ID of the Subscription Contract draft to update a subscription discount on.
- Anchor to inputinput•Subscription
Free Shipping Discount Input! required The properties to update on the Subscription Free Shipping Discount.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- Anchor to draftIddraft•ID!
Id required The gid of the Subscription Contract draft to remove a subscription line from.
- Anchor to lineIdline•ID!
Id required The gid of the Subscription Line to remove.
Arguments