Skip to main content
Anchor to SubscriptionManualDiscount

SubscriptionManualDiscount

object

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Custom subscription discount.

Anchor to FieldsFields

Anchor to entitledLinesentitledLines
•SubscriptionDiscountEntitledLines!
non-null

Entitled line items used to apply the subscription discount on.

Anchor to idid
•ID!
non-null

The unique ID.

Anchor to recurringCycleLimitrecurringCycleLimit
•Int

The maximum number of times the subscription discount will be applied on orders.

Anchor to rejectionReasonrejectionReason
•SubscriptionDiscountRejectionReason

The reason that the discount on the subscription draft is rejected.

Anchor to targetTypetargetType
•DiscountTargetType!
non-null

Type of line the discount applies on.

Anchor to titletitle
•String

The title associated with the subscription discount.

Anchor to typetype
•DiscountType!
non-null

The type of the subscription discount.

Anchor to usageCountusageCount
•Int!
non-null

The number of times the discount was applied.

Anchor to valuevalue
•SubscriptionDiscountValue!
non-null

The value of the subscription discount.

Was this section helpful?

Anchor to MutationsMutations

Anchor to subscriptionDraftDiscountAddsubscriptionDraftDiscountAdd
•mutation

Adds a subscription discount to a subscription draft.

Arguments

Anchor to draftIddraftId
•ID!
required

The ID of the Subscription Contract draft to add a subscription discount to.

Anchor to inputinput
•SubscriptionManualDiscountInput!
required

The properties of the new Subscription Discount.

Anchor to subscriptionDraftDiscountUpdatesubscriptionDraftDiscountUpdate
•mutation

Updates a subscription discount on a subscription draft.

Arguments

Anchor to draftIddraftId
•ID!
required

The ID of the Subscription Contract draft to update a subscription discount on.

Anchor to discountIddiscountId
•ID!
required

The gid of the Subscription Discount to update.

Anchor to inputinput
•SubscriptionManualDiscountInput!
required

The properties to update on the Subscription Discount.

Anchor to subscriptionDraftFreeShippingDiscountAddsubscriptionDraftFreeShippingDiscountAdd
•mutation

Adds a subscription free shipping discount to a subscription draft.

Arguments

Anchor to draftIddraftId
•ID!
required

The ID of the subscription contract draft to add a subscription free shipping discount to.

Anchor to inputinput
•SubscriptionFreeShippingDiscountInput!
required

The properties of the new subscription free shipping discount.

Anchor to subscriptionDraftFreeShippingDiscountUpdatesubscriptionDraftFreeShippingDiscountUpdate
•mutation

Updates a subscription free shipping discount on a subscription draft.

Arguments

Anchor to draftIddraftId
•ID!
required

The ID of the Subscription Contract draft to update a subscription discount on.

Anchor to discountIddiscountId
•ID!
required

The gid of the Subscription Discount to update.

Anchor to inputinput
•SubscriptionFreeShippingDiscountInput!
required

The properties to update on the Subscription Free Shipping Discount.

Anchor to subscriptionDraftLineRemovesubscriptionDraftLineRemove
•mutation

Removes a subscription line from a subscription draft.

Arguments

Anchor to draftIddraftId
•ID!
required

The gid of the Subscription Contract draft to remove a subscription line from.

Anchor to lineIdlineId
•ID!
required

The gid of the Subscription Line to remove.

Was this section helpful?