Kibo Commerce · Schema
PricingRuntimeDiscount
Represents a discount for runtime API.
CompanyCommerceE-CommerceHeadless CommerceOrder ManagementB2BConsumerInventoryFulfillment
Properties
| Name | Type | Description |
|---|---|---|
| amount | numbernull | Amount of the discount, as a percentage or monetary amount, for example 15% or $15. Must be either null or greater than zero. |
| amountType | stringnull | Gets or sets the AmountType of the discount. Values: Percentage, Amount, FixedPrice, FreeAutoAdd |
| canBeStackedUpon | booleannull | Indicates whether or not stacking is enabled for this discount |
| code | stringnull | Gets or sets the code associated with the discount. |
| conditions | object | |
| content | objectnull | Gets or sets the content of the discount. |
| customProperties | arraynull | Gets or sets the custom properties of the discount. |
| doesNotApplyToMultiShipToOrders | booleannull | Flag to allow or prevent application to multi-ship-to orders, Only applicable to shipping discounts. |
| doesNotApplyToProductsWithSalePrice | booleannull | Determines whether a discount applies to items with a sale price. Applicable on order and line item discounts. For line items, when this is true, the discount will be disqualified. For order level dis |
| doesNotApplyToSalePrice | booleannull | Determines if the discount should apply to sale price or regular price only. Discounts will apply to sale prices by default. Only applies to LineItem product discounts. |
| expirationDate | stringnull | Gets or sets the expiration date of the discount. |
| hasPurchaseConditions | boolean | Indicates if this discount has purchase conditions that must be met before the discount is applied |
| id | integer | Gets or sets the unique identifier for the discount. |
| includedPriceLists | arraynull | Products receiving a price from a price list specified here or a child of a specified price list can be discounted. |
| isBxGx | booleannull | Readonly property indicating that the condition required purchase is the same as the target items. Used in BxGx and BoGo type discounts. |
| isGroupDiscount | boolean | When set to true then the discount is applied to all of the target items once the minimum quantity per redemption is met. |
| isPublic | booleannull | Gets or sets a value indicating whether the discount is public. |
| isSubscriptionDiscount | booleannull | Gets or sets a value indicating whether the discount is a subscription discount. |
| isUnconditional | boolean | Gets or sets a value indicating whether the discount is unconditional. |
| labels | arraynull | List of distinct labels associated with the discount. |
| maximumDiscountImpactPerOrder | numbernull | Maximum impact this discount can apply on a single order. Must be either null or greater than zero. |
| maximumDiscountImpactPerRedemption | numbernull | Maximum impact this discount can apply on a single line item. Must be either null or greater than zero. |
| maximumRedemptionsPerOrder | integernull | Maximum number of redemptions for the discount per registered user. |
| maximumUsesPerUser | integernull | Maximum number of times a user can redeem this discount. Must be either null or greater than zero. |
| preventLineItemShippingDiscounts | booleannull | Prevents Line Item Shipping discounts from being applied when a Line Item Product discount has been applied |
| preventOrderProductDiscounts | booleannull | Prevents Order Product discounts from being applied when a Line Item Product or Shipping discount has been applied |
| preventOrderShippingDiscounts | booleannull | Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping or Order Product discount has been applied |
| pricingContext | stringnull | The pricing context this discount is applicable to. Values: Any, OnlinePurchase, ContinuityOrder |
| purchaseRequirementType | stringnull | Used to determin how discount is evaluated. When set to TargetOnly, then only the Target is used to drive the purchase requirement. When set to Combination, then the Target and Condition are used to d |
| reevalFreeItemMinOrderPostDiscounts | booleannull | Enables post-order-discount minimum re-evaluation for eligible free-item discounts. Values null and false are treated as disabled. |
| scope | stringnull | Gets or sets the scope of the discount. Values: Order, LineItem |
| stackingLayer | integernull | Indicates which stacking layer this discount is a part of |
| startDate | stringnull | Gets or sets the start date of the discount. |
| target | object | |
| thresholdMessage | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-pricing-runtime-discount-schema.json",
"title": "PricingRuntimeDiscount",
"description": "Represents a discount for runtime API.",
"x-generated": "2026-10-18",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/kibo-commerce-pricing-openapi.yml#/components/schemas/PricingRuntimeDiscount",
"properties": {
"amount": {
"description": " Amount of the discount, as a percentage or monetary amount, for example 15% or $15.\nMust be either null or greater than zero.",
"format": "double",
"type": [
"number",
"null"
]
},
"amountType": {
"description": "Gets or sets the AmountType of the discount.\nValues: Percentage, Amount, FixedPrice, FreeAutoAdd",
"type": [
"string",
"null"
]
},
"canBeStackedUpon": {
"description": "Indicates whether or not stacking is enabled for this discount",
"type": [
"boolean",
"null"
]
},
"code": {
"description": "Gets or sets the code associated with the discount.",
"type": [
"string",
"null"
]
},
"conditions": {
"$ref": "#/$defs/RuntimeDiscountCondition"
},
"content": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Gets or sets the content of the discount.",
"type": [
"object",
"null"
]
},
"customProperties": {
"description": "Gets or sets the custom properties of the discount.",
"items": {
"$ref": "#/$defs/DiscountCustomProperty"
},
"type": [
"array",
"null"
]
},
"doesNotApplyToMultiShipToOrders": {
"description": "Flag to allow or prevent application to multi-ship-to orders,\nOnly applicable to shipping discounts.",
"type": [
"boolean",
"null"
]
},
"doesNotApplyToProductsWithSalePrice": {
"description": "Determines whether a discount applies to items with a sale price. Applicable \non order and line item discounts. For line items, when this is true, the discount will \nbe disqualified. For order level discounts, when true, the discount will not be applied \nto those items that have a sale price.",
"type": [
"boolean",
"null"
]
},
"doesNotApplyToSalePrice": {
"description": "Determines if the discount should apply to sale price or regular price only.\nDiscounts will apply to sale prices by default.\nOnly applies to LineItem product discounts.",
"type": [
"boolean",
"null"
]
},
"expirationDate": {
"description": "Gets or sets the expiration date of the discount.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"hasPurchaseConditions": {
"description": "Indicates if this discount has purchase conditions that must be met before \nthe discount is applied",
"type": "boolean"
},
"id": {
"description": "Gets or sets the unique identifier for the discount.",
"format": "int32",
"type": "integer"
},
"includedPriceLists": {
"description": "Products receiving a price from a price list specified here or a child of a specified \nprice list can be discounted.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"isBxGx": {
"description": "Readonly property indicating that the condition required purchase is the \nsame as the target items. Used in BxGx and BoGo type discounts.",
"type": [
"boolean",
"null"
]
},
"isGroupDiscount": {
"description": "When set to true then the discount is applied to all of the target items once the minimum quantity per redemption is met.",
"type": "boolean"
},
"isPublic": {
"description": "Gets or sets a value indicating whether the discount is public.",
"type": [
"boolean",
"null"
]
},
"isSubscriptionDiscount": {
"description": "Gets or sets a value indicating whether the discount is a subscription discount.",
"type": [
"boolean",
"null"
]
},
"isUnconditional": {
"description": "Gets or sets a value indicating whether the discount is unconditional.",
"type": "boolean"
},
"labels": {
"description": "List of distinct labels associated with the discount.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"maximumDiscountImpactPerOrder": {
"description": "Maximum impact this discount can apply on a single order.\n Must be either null or greater than zero.",
"format": "double",
"type": [
"number",
"null"
]
},
"maximumDiscountImpactPerRedemption": {
"description": "Maximum impact this discount can apply on a single line item.\n Must be either null or greater than zero.",
"format": "double",
"type": [
"number",
"null"
]
},
"maximumRedemptionsPerOrder": {
"description": "Maximum number of redemptions for the discount per registered user.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"maximumUsesPerUser": {
"description": "Maximum number of times a user can redeem this discount.\n Must be either null or greater than zero.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"preventLineItemShippingDiscounts": {
"description": "Prevents Line Item Shipping discounts from being applied when a Line Item Product \ndiscount has been applied",
"type": [
"boolean",
"null"
]
},
"preventOrderProductDiscounts": {
"description": "Prevents Order Product discounts from being applied when a Line Item Product \nor Shipping discount has been applied",
"type": [
"boolean",
"null"
]
},
"preventOrderShippingDiscounts": {
"description": "Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping \nor Order Product discount has been applied",
"type": [
"boolean",
"null"
]
},
"pricingContext": {
"description": "The pricing context this discount is applicable to.\nValues: Any,\nOnlinePurchase,\nContinuityOrder",
"type": [
"string",
"null"
]
},
"purchaseRequirementType": {
"description": "Used to determin how discount is evaluated. When set to TargetOnly, then only the Target is\nused to drive the purchase requirement. When set to Combination, then the Target and Condition\nare used to drive the purchase requirement.",
"type": [
"string",
"null"
]
},
"reevalFreeItemMinOrderPostDiscounts": {
"description": "Enables post-order-discount minimum re-evaluation for eligible free-item discounts.\nValues null and false are treated as disabled.",
"type": [
"boolean",
"null"
]
},
"scope": {
"description": "Gets or sets the scope of the discount.\nValues: Order, LineItem",
"type": [
"string",
"null"
]
},
"stackingLayer": {
"description": "Indicates which stacking layer this discount is a part of",
"format": "int32",
"type": [
"integer",
"null"
]
},
"startDate": {
"description": "Gets or sets the start date of the discount.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"target": {
"$ref": "#/$defs/RuntimeDiscountTarget"
},
"thresholdMessage": {
"$ref": "#/$defs/ThresholdMessage"
}
},
"type": "object",
"$defs": {
"CategoryDiscountCondition": {
"description": "Represents a product category and quantity constraint",
"properties": {
"categoryId": {
"description": "Unique identifier of the category to which the discount condition applies.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ContinuityRecurrenceSettings": {
"properties": {
"interval": {
"description": "Interval until next discount applies",
"format": "int32",
"type": [
"integer",
"null"
]
},
"startOrdinal": {
"description": "Continuity ordinal to start discounting",
"format": "int32",
"type": [
"integer",
"null"
]
},
"stopOrdinal": {
"description": "Continuity ordinal to stop discounting",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"DiscountCustomProperty": {
"description": "Represents a custom property for a discount.",
"properties": {
"code": {
"description": "Gets or sets the code of the discount custom property.",
"type": [
"string",
"null"
]
},
"name": {
"description": "Gets or sets the name of the discount custom property.",
"type": [
"string",
"null"
]
},
"value": {
"description": "Gets or sets the value of the discount custom property.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"PricingRuntimeCustomerSegment": {
"description": "Represents a customer segment",
"properties": {
"id": {
"description": "The Customer segment Id.\nThis is the system Id not the code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ProductDiscountCondition": {
"description": "Represents a product and quantity constraint",
"properties": {
"productCode": {
"description": "Product code of the product to discount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"RuntimeDiscountCondition": {
"description": "",
"properties": {
"categoriesToExcludeFromMinOrderTotal": {
"description": "List of categories to discount. When a discount applies to a category, all products in the category are discounted.",
"items": {
"$ref": "#/$defs/CategoryDiscountCondition"
},
"type": [
"array",
"null"
]
},
"continuityRecurrenceSettings": {
"$ref": "#/$defs/ContinuityRecurrenceSettings"
},
"couponCode": {
"description": "Code of the coupon associated with the discount (if a coupon code is required). The merchant can supply the code or the system can generate it.",
"type": [
"string",
"null"
]
},
"customerSegments": {
"description": "List of customer groups for which the discount applies",
"items": {
"$ref": "#/$defs/PricingRuntimeCustomerSegment"
},
"type": [
"array",
"null"
]
},
"excludedCategories": {
"description": "List of categories to discount. When a discount applies to a category, all products in the category are discounted.",
"items": {
"$ref": "#/$defs/CategoryDiscountCondition"
},
"type": [
"array",
"null"
]
},
"excludedProducts": {
"description": "List of products that are eligible for the discount.",
"items": {
"$ref": "#/$defs/ProductDiscountCondition"
},
"type": [
"array",
"null"
]
},
"exclusiveLocationCodes": {
"description": "List of locations where the item/order should be fulfilled for the discount to be valid.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"exclusiveSiteIds": {
"description": "The discount condition for site Ids, if present the discount will be applied only to these sites.\nIf not present discount will work for all sites in a catalog.",
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"includedCategories": {
"description": "List of categories that must be purchased in order for the discount to be valid.",
"items": {
"$ref": "#/$defs/CategoryDiscountCondition"
},
"type": [
"array",
"null"
]
},
"includedPaymentWorkflows": {
"description": "List of payment types that trigger this discount to be valid.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"includedProducts": {
"description": "List of products that are eligible for the discount.",
"items": {
"$ref": "#/$defs/ProductDiscountCondition"
},
"type": [
"array",
"null"
]
},
"maxRedemptionCount": {
"description": "Maximum number of times that the discount can be redeemed. Default is null (no limit to discount redemptions).",
"format": "int32",
"type": [
"integer",
"null"
]
},
"maximumOrderAmount": {
"description": "Only applies to order.\nMaximum order subtotal after discounts in order for the associated discount to be applied",
"format": "double",
"type": [
"number",
"null"
]
},
"minDistinctProductsRequired": {
"description": "The minimum number of distinct products on the order\nNot a quantity calculation.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"minTotalOrderQuantity": {
"description": "The order must contain at least this total quantity of items for the discount to apply.\nYou must buy a combined quantity of at least x amount.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"minimumCategorySubtotalBeforeDiscounts": {
"description": "Minimum amount that must be purchased in the combined categories defined in \nIncludedCategories. Amount is calculated before discounting.\nNot used if IncludedCategories is empty.",
"format": "double",
"type": [
"number",
"null"
]
},
"minimumLifetimeValueAmount": {
"description": "Minimum lifetime value amount required for this discount to apply",
"format": "double",
"type": [
"number",
"null"
]
},
"minimumOrderAmount": {
"description": "Only applies to order.\nMinimum order subtotal after discounts in order for the associated discount to be applied",
"format": "double",
"type": [
"number",
"null"
]
},
"minimumQuantityProductsRequiredInCategories": {
"description": "Minimum quantity of products in the categories specified in IncludedCategories that must be purchased to\nqualify for the associated discount.\nDefaults to 1 if null and IncludedCategories has values",
"format": "int32",
"type": [
"integer",
"null"
]
},
"minimumQuantityRequiredProducts": {
"description": "Minimum quantity of products in the specified IncludedProducts that must be purchased to\nqualify for the associated discount.\nDefaults to 1 if null and IncludedProducts has values.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"minimumRequiredQuantityPerRedemption": {
"description": "Defines a minimum quantity that is required for a target only discount",
"format": "int32",
"type": [
"integer",
"null"
]
},
"productsToExcludeFromMinOrderTotal": {
"description": "List of products that are eligible for the discount.",
"items": {
"$ref": "#/$defs/ProductDiscountCondition"
},
"type": [
"array",
"null"
]
},
"requiresAuthenticatedUser": {
"description": "Determines is this discount can be used by an anonymous user \nDefaults to false to allow discounts for anonymous users.",
"type": "boolean"
},
"requiresCoupon": {
"description": "If true, the shopper needs to enter a coupon code to redeem the discount.",
"type": "boolean"
},
"validFulfillmentMethods": {
"description": "The discount condition for fulfillment methods, if present the discount will be applied only to these fulfillment methods.\nThis must be a value defined in FulfillmentMethodConst below.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"validSubscriptionContinuityOrdinals": {
"description": "Ordinals at which a continuity order should receive the discount.",
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"validSubscriptionFrequencies": {
"description": "List of subscription frequencies to which the discount will apply.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"RuntimeDiscountTarget": {
"properties": {
"categories": {
"description": "List of categories to discount. When a discount applies to a category, all products in the category are discounted.",
"items": {
"$ref": "#/$defs/TargetedCategory"
},
"type": [
"array",
"null"
]
},
"doNotApplyToHandlingFees": {
"description": "Prevents the discount from being applied to handling fees",
"type": [
"boolean",
"null"
]
},
"excludeItemsWithExistingProductDiscounts": {
"description": "Prevents order scoped discounts from layering over items that already have a product discount with the \nsame type.",
"type": [
"boolean",
"null"
]
},
"excludeItemsWithExistingShippingDiscounts": {
"description": "Prevents order scoped discounts from layering over items that already have a shipping discount with the \nsame type.",
"type": [
"boolean",
"null"
]
},
"excludedCategories": {
"description": "List of categories to exclude from the discount. Useful to exclude specific child categories.",
"items": {
"$ref": "#/$defs/TargetedCategory"
},
"type": [
"array",
"null"
]
},
"excludedCategoriesOperator": {
"description": "Applies to Included categories\nDefaults to Any",
"type": [
"string",
"null"
]
},
"excludedProducts": {
"description": "List of products that are excluded from the discount.",
"items": {
"$ref": "#/$defs/TargetedProduct"
},
"type": [
"array",
"null"
]
},
"includeAllProducts": {
"description": "If yes, the discount applies to all products sold on the storefront.",
"type": [
"boolean",
"null"
]
},
"includedCategoriesOperator": {
"description": "Applies to Included categories\nWhen Any, the target product can belong to any specified category.\nWhen All, the target product must belong to all specified categories.\nDefaults to Any",
"type": [
"string",
"null"
]
},
"maximumQuantityPerRedemption": {
"description": "When a condition is specified, this property limits the number of items that can be targeted per discount redemption with an order.\nif multiple redemptions are allowed per order then multiples of this value would be allowed in multiples of the associated \ncondition.\nIf no condition is specified then this value is not used. \nIf null and condition exists, then defaults to 1.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"products": {
"description": "List of products that are eligible for the discount.",
"items": {
"$ref": "#/$defs/TargetedProduct"
},
"type": [
"array",
"null"
]
},
"shippingMethods": {
"description": "Shipping method that is eligible for shipping discounts. This is a shipping method defined in Shipping Settings.",
"items": {
"$ref": "#/$defs/TargetedShippingMethod"
},
"type": [
"array",
"null"
]
},
"shippingZones": {
"description": "Shipping Zones that are applicable for this discount",
"items": {
"$ref": "#/$defs/TargetedShippingZone"
},
"type": [
"array",
"null"
]
},
"type": {
"description": " Type of target to which the discount applies. Possible values: <pre>Product</pre> or <pre>Shipping</pre>. \nIf this is a <pre>Product</pre> type, you can specify which products or categories that the discount applies to.\n If this is a <pre>Shipping</pre> type then you must specify which shipping methods apply.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"TargetedCategory": {
"properties": {
"id": {
"description": "Unique identifier of the category to which the discount applies.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"TargetedProduct": {
"description": "Product to discount.",
"properties": {
"productCode": {
"description": "Product code of the product to discount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"TargetedShippingMethod": {
"description": "Shipping method that is eligible for free shipping. This is the shipping method that is defined with the Shipping\nSettings resource.",
"properties": {
"code": {
"description": "Unique identifier of the shipping method as it appears in the SiteShippingMethod property of the Shipping Settings\nresource.",
"type": [
"string",
"null"
]
},
"name": {
"description": "Name of the shipping method as it appears in SiteShippingMethodLocalizedContent of the Shipping Settings resource.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"TargetedShippingZone": {
"description": "Shipping method that is eligible for free shipping. This is the shipping method that is defined with the Shipping\nSettings resource.",
"properties": {
"zone": {
"description": "Indicates the shipping zone that this discount is valid for. If zone is provided the\nmethod selected must be valid for the zone and both populated in the order for the discount\nto be valid.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"ThresholdMessage": {
"properties": {
"discountId": {
"format": "int32",
"type": "integer"
},
"message": {
"type": [
"string",
"null"
]
},
"requiresCouponCode": {
"type": "boolean"
},
"showInCart": {
"type": "boolean"
},
"showOnCheckout": {
"type": "boolean"
},
"thresholdValue": {
"format": "double",
"type": "number"
}
},
"type": "object"
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/kibo-commerce-pricing-runtime-discount"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.