SubscriptionDiscountRejectionReason enum

Version unstable

The reason a discount on a subscription draft was rejected.

Values

  • USAGE_LIMIT_REACHED

    Discount usage limit has been reached.

  • CUSTOMER_NOT_ELIGIBLE

    Given customer does not qualify for the discount.

  • CUSTOMER_USAGE_LIMIT_REACHED

    Customer usage limit has been reached.

  • INCOMPATIBLE_PURCHASE_TYPE

    Purchase type does not qualify for the discount.

  • INTERNAL_ERROR

    Internal error during discount code validation.

  • NOT_FOUND

    Discount code is not found.

  • NO_ENTITLED_LINE_ITEMS

    Discount does not apply to any of the given line items.

  • NO_ENTITLED_SHIPPING_LINES

    No applicable shipping lines.

  • PURCHASE_NOT_IN_RANGE

    Purchase amount of items does not qualify for the discount.

  • QUANTITY_NOT_IN_RANGE

    Quantity of items does not qualify for the discount.

  • CURRENTLY_INACTIVE

    Discount is inactive.

Types that return SubscriptionDiscountRejectionReason

Version 2021-10 (Release candidate)

The reason a discount on a subscription draft was rejected.

Values

  • USAGE_LIMIT_REACHED

    Discount usage limit has been reached.

  • CUSTOMER_NOT_ELIGIBLE

    Given customer does not qualify for the discount.

  • CUSTOMER_USAGE_LIMIT_REACHED

    Customer usage limit has been reached.

  • INCOMPATIBLE_PURCHASE_TYPE

    Purchase type does not qualify for the discount.

  • INTERNAL_ERROR

    Internal error during discount code validation.

  • NOT_FOUND

    Discount code is not found.

  • NO_ENTITLED_LINE_ITEMS

    Discount does not apply to any of the given line items.

  • NO_ENTITLED_SHIPPING_LINES

    No applicable shipping lines.

  • PURCHASE_NOT_IN_RANGE

    Purchase amount of items does not qualify for the discount.

  • QUANTITY_NOT_IN_RANGE

    Quantity of items does not qualify for the discount.

  • CURRENTLY_INACTIVE

    Discount is inactive.

Types that return SubscriptionDiscountRejectionReason

Version 2021-07 (Latest)

The reason a discount on a subscription draft was rejected.

Values

  • USAGE_LIMIT_REACHED

    Discount usage limit has been reached.

  • CUSTOMER_NOT_ELIGIBLE

    Given customer does not qualify for the discount.

  • CUSTOMER_USAGE_LIMIT_REACHED

    Customer usage limit has been reached.

  • INCOMPATIBLE_PURCHASE_TYPE

    Purchase type does not qualify for the discount.

  • INTERNAL_ERROR

    Internal error during discount code validation.

  • NOT_FOUND

    Discount code is not found.

  • NO_ENTITLED_LINE_ITEMS

    Discount does not apply to any of the given line items.

  • NO_ENTITLED_SHIPPING_LINES

    No applicable shipping lines.

  • PURCHASE_NOT_IN_RANGE

    Purchase amount of items does not qualify for the discount.

  • QUANTITY_NOT_IN_RANGE

    Quantity of items does not qualify for the discount.

  • CURRENTLY_INACTIVE

    Discount is inactive.

Types that return SubscriptionDiscountRejectionReason

Version 2021-04

The reason a discount on a subscription draft was rejected.

Values

  • USAGE_LIMIT_REACHED

    Discount usage limit has been reached.

  • CUSTOMER_NOT_ELIGIBLE

    Given customer does not qualify for the discount.

  • CUSTOMER_USAGE_LIMIT_REACHED

    Customer usage limit has been reached.

  • INCOMPATIBLE_PURCHASE_TYPE

    Purchase type does not qualify for the discount.

  • INTERNAL_ERROR

    Internal error during discount code validation.

  • NOT_FOUND

    Discount code is not found.

  • NO_ENTITLED_LINE_ITEMS

    Discount does not apply to any of the given line items.

  • NO_ENTITLED_SHIPPING_LINES

    No applicable shipping lines.

  • PURCHASE_NOT_IN_RANGE

    Purchase amount of items does not qualify for the discount.

  • QUANTITY_NOT_IN_RANGE

    Quantity of items does not qualify for the discount.

  • CURRENTLY_INACTIVE

    Discount is inactive.

Types that return SubscriptionDiscountRejectionReason