Skip to main content

Interface: TieredDiscount

A tiered discount definition scoped to a bundle product, a single product, or a collection (via the corresponding optional fields), including eligible charge and line item types and the ordered list of tiers.

Properties

collection_id?

optional collection_id: string

Collection scope: Recharge collection id when the discount applies to a collection. Present when the discount targets a collection.


created_at

created_at: string

Created timestamp (ISO 8601).


eligible_charge_types

eligible_charge_types: EligibleChargeType[]

Charge types (checkout vs recurring) this discount applies to.


eligible_line_item_types

eligible_line_item_types: EligibleLineItemType[]

Line item types (subscription vs onetime) this discount applies to.


external_bundle_product_id?

optional external_bundle_product_id: object

Bundle scope: external bundle product id on the ecommerce platform. Present when the discount targets one bundle product.

ecommerce

ecommerce: string


external_product_id?

optional external_product_id: object

Single-product scope: external product id on the ecommerce platform. Present when the discount targets one product.

ecommerce

ecommerce: string


id

id: number

Incentive config id.


lookup_key

lookup_key: string

Stable identifier for this tiered discount configuration.


name

name: string

Internal name for the Tiered Discount.


shopify_display_name

shopify_display_name: string

Shopify automatic discount title used at checkout; may be null.


status

status: TieredDiscountStatus

Publication and lifecycle state.


tiers

tiers: object[]

Ordered tiers as returned by the API (each entry wraps one tier object).

tier

tier: Tier


updated_at

updated_at: string

Updated timestamp (ISO 8601).