SubscriptionManualDiscount object

Custom subscription discount.

Required access

Requires either all_subscription_contracts or own_subscription_contracts scope.

On this page

Fields

  • entitledLines ([SubscriptionDiscountEntitledLines!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondiscountentitledlines))
    Entitled line items used to apply the subscription discount on.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    The unique identifier.
  • recurringCycleLimit ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The maximum number of times the subscription discount will be applied on orders.
  • rejectionReason ([SubscriptionDiscountRejectionReason](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondiscountrejectionreason))
    The reason that the discount on the subscription draft is rejected.
  • targetType ([DiscountTargetType!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discounttargettype))
    Type of line the discount applies on.
  • title ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The title associated with the subscription discount.
  • type ([DiscountType!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discounttype))
    The type of the subscription discount.
  • usageCount ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The number of times the discount was applied.
  • value ([SubscriptionDiscountValue!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondiscountvalue))
    The value of the subscription discount.

Types that return SubscriptionManualDiscount

  • [SubscriptionContract.discounts](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract#discounts-2021-01)

An auto-generated type for paginating through multiple SubscriptionManualDiscounts.

On this page

Fields

  • edges ([[SubscriptionManualDiscountEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionmanualdiscount))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one SubscriptionManualDiscount and a cursor during pagination.

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([SubscriptionManualDiscount!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionmanualdiscount))
    The item at the end of SubscriptionManualDiscountEdge.

Types that return SubscriptionManualDiscountEdge

  • [SubscriptionManualDiscountConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionmanualdiscount#edges-2021-01)