Anchor to section titled 'undefined'

SubscriptionManualDiscount
object

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Custom subscription discount.

Anchor to section titled 'Fields'

Fields

Anchor to SubscriptionManualDiscount.entitledLines
entitledLines
SubscriptionDiscountEntitledLines!
non-null

Entitled line items used to apply the subscription discount on.

Anchor to SubscriptionManualDiscount.id
id
ID!
non-null

The unique ID.

Anchor to SubscriptionManualDiscount.recurringCycleLimit
recurringCycleLimit
Int

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

Anchor to SubscriptionManualDiscount.rejectionReason
rejectionReason
SubscriptionDiscountRejectionReason

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

Anchor to SubscriptionManualDiscount.targetType
targetType
DiscountTargetType!
non-null

Type of line the discount applies on.

Anchor to SubscriptionManualDiscount.title
title
String

The title associated with the subscription discount.

Anchor to SubscriptionManualDiscount.type
type
DiscountType!
non-null

The type of the subscription discount.

Anchor to SubscriptionManualDiscount.usageCount
usageCount
Int!
non-null

The number of times the discount was applied.

Anchor to SubscriptionManualDiscount.value
value
SubscriptionDiscountValue!
non-null

The value of the subscription discount.

Was this section helpful?
Map

Fields and connections from

Possible types in

SubscriptionManualDiscount
Anchor to section titled 'Mutations'

Mutations

Anchor to subscriptionDraftDiscountAdd
subscriptionDraftDiscountAdd
mutation
Access requirements

Adds a subscription discount to a subscription draft.

Anchor to subscriptionDraftDiscountUpdate
subscriptionDraftDiscountUpdate
mutation
Access requirements

Updates a subscription discount on a subscription draft.

Anchor to subscriptionDraftFreeShippingDiscountAdd
subscriptionDraftFreeShippingDiscountAdd
mutation
Access requirements

Adds a subscription free shipping discount to a subscription draft.

Anchor to subscriptionDraftFreeShippingDiscountUpdate
subscriptionDraftFreeShippingDiscountUpdate
mutation
Access requirements

Updates a subscription free shipping discount on a subscription draft.

Anchor to subscriptionDraftLineRemove
subscriptionDraftLineRemove
mutation
Access requirements

Removes a subscription line from a subscription draft.

Was this section helpful?
<~>
SubscriptionManualDiscount Mutations
SubscriptionManualDiscount

Mutated by