SubscriptionManualDiscount - admin-graphql - OBJECT

Version: 2025-01

Description:

Custom subscription discount.

Access Scopes

the `read_own_subscription_contracts` or `write_own_subscription_contracts` scope.

Fields

  • entitledLines: SubscriptionDiscountEntitledLines! - Entitled line items used to apply the subscription discount on.
  • id: ID! - 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! - Type of line the discount applies on.
  • title: String - The title associated with the subscription discount.
  • type: DiscountType! - The type of the subscription discount.
  • usageCount: Int! - The number of times the discount was applied.
  • value: SubscriptionDiscountValue! - The value of the subscription discount.

Connections

Related queries

Related mutations

  • subscriptionDraftDiscountAdd Adds a subscription discount to a subscription draft.
  • subscriptionDraftDiscountUpdate Updates a subscription discount on a subscription draft.
  • subscriptionDraftFreeShippingDiscountAdd Adds a subscription free shipping discount to a subscription draft.
  • subscriptionDraftFreeShippingDiscountUpdate Updates a subscription free shipping discount on a subscription draft.
  • subscriptionDraftLineRemove Removes a subscription line from a subscription draft.

Related Unions

  • SubscriptionDiscount Subscription draft discount types.

Examples