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 subscriptionDraftDiscountAdd subscriptionDraftDiscountAdd • mutation: Adds a subscription discount to a subscription draft.
Anchor to subscriptionDraftDiscountUpdate subscriptionDraftDiscountUpdate • mutation: Updates a subscription discount on a subscription draft.
Anchor to subscriptionDraftFreeShippingDiscountAdd subscriptionDraftFreeShippingDiscountAdd • mutation: Adds a subscription free shipping discount to a subscription draft.
Anchor to subscriptionDraftFreeShippingDiscountUpdate subscriptionDraftFreeShippingDiscountUpdate • mutation: Updates a subscription free shipping discount on a subscription draft.
Anchor to subscriptionDraftLineRemove subscriptionDraftLineRemove • mutation: Removes a subscription line from a subscription draft.

Was this section helpful?