Choose a version:

SubscriptionDiscount

union

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Subscription draft discount types.

Anchor to Possible typesPossible types

•

OBJECT

Represents an applied code discount.

id• ID! non-null: The unique ID.
redeemCode• String! non-null: The redeem code of the discount that applies on the subscription.
rejectionReason• SubscriptionDiscountRejectionReason: The reason that the discount on the subscription draft is rejected.

•

OBJECT

Custom subscription discount.

entitledLines• SubscriptionDiscountEntitledLines! non-null: Entitled line items used to apply the subscription discount on.
id• ID! non-null: The unique ID.
recurringCycleLimit• Int: The maximum number of times the subscription discount will be applied on orders.
rejectionReason• SubscriptionDiscountRejectionReason: The reason that the discount on the subscription draft is rejected.
targetType• DiscountTargetType! non-null: Type of line the discount applies on.
title• String: The title associated with the subscription discount.
type• DiscountType! non-null: The type of the subscription discount.
usageCount• Int! non-null: The number of times the discount was applied.
value• SubscriptionDiscountValue! non-null: The value of the subscription discount.

Was this section helpful?

Anchor to SubscriptionDiscountAllocation.discount SubscriptionDiscountAllocation.discount • OBJECT: Discount that created the allocation.
Anchor to SubscriptionDiscountConnection.nodes SubscriptionDiscountConnection.nodes • CONNECTION: A list of nodes that are contained in SubscriptionDiscountEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to SubscriptionDiscountEdge.node SubscriptionDiscountEdge.node • OBJECT: The item at the end of SubscriptionDiscountEdge.
Anchor to SubscriptionDraft.discounts SubscriptionDraft.discounts • CONNECTION: The list of subscription discounts which will be associated with the subscription contract.
Anchor to SubscriptionDraft.discountsAdded SubscriptionDraft.discountsAdded • CONNECTION: The list of subscription discounts to be added to the subscription contract.
Anchor to SubscriptionDraft.discountsRemoved SubscriptionDraft.discountsRemoved • CONNECTION: The list of subscription discounts to be removed from the subscription contract.
Anchor to SubscriptionDraft.discountsUpdated SubscriptionDraft.discountsUpdated • CONNECTION: The list of subscription discounts to be updated on the subscription contract.

Was this section helpful?