Kibo Commerce · Schema

SubscriptionRuntimeSubscription

CompanyCommerceE-CommerceHeadless CommerceOrder ManagementB2BConsumerInventoryFulfillment

Properties

Name Type Description
adjustment object
attributes arraynull
auditInfo object
changeMessages arraynull Change Messages
channelCode stringnull Unique identifier of the channel for this item.
couponCodes arraynull Coupon codes associated with this Subscription.
currencyCode stringnull ISO Currency Code.
customerAccountId integernull Unique identifier of the customer account.
customerInteractionType stringnull Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown
customerTaxId stringnull The customers tax ID. If Customer Account ID exists in the system, will set this.
data objectnull Custom data for a given vendor set within the commerce process.
discountedSubtotal number Discounted Subtotal
dutyAmount numbernull
dutyTotal number
email stringnull Email address for checkout
externalId stringnull
feeTotal number
frequency object
frequencyAuditInfo object
fulfillmentInfo object
handlingAdjustment object
handlingAmount numbernull
handlingDiscounts arraynull
handlingSubTotal number
handlingTax numbernull
handlingTaxTotal number
handlingTotal number
hasDraft booleannull Does this subscription have a draft version.
id stringnull Unique identifier.
invalidCoupons arraynull A list of invalid coupons that were attempted on the Subscription
ipAddress stringnull IP address of the user placing the order. (User or customer?)
isDraft booleannull Is this subscription a draft version
isImport boolean
isOrderReminderEmailSent boolean Has order reminder email sent.
isPartialDraft boolean Is this subscription draft is a partial draft.
isReactivationReminderEmailSent boolean Has reactivation reminder email sent.
isTaxExempt booleannull Unique identifier of the customer account.
itemLevelAdjustmentsTotal number The total value of all line item adjustments
itemLevelHandlingDiscountTotal number
itemLevelProductDiscountTotal number The total value of item-level product discounts.
itemLevelShippingDiscountTotal number
itemTaxTotal number Total tax on products.
itemTotal number The total product cost, accounting for discounts and tax.
items arraynull List of items in the Subscription.
lastContinuityOrderDateOnSubPaused stringnull
lastOrderNowDate stringnull Indicate when "order now" and "partial order now" performed last time.
lineItemSubtotalWithOrderAdjustments numbernull Line Item Subtotals with Order Adjustments
locationCode stringnull Identifies the location at which the order was placed if the order was placed externally.
nextOrderDate stringnull
nextOrderDateAuditInfo object
nextOrderDateOffsetCounter integernull counter to keep track of nextOrderDate limit.
notes arraynull Notes
number integer Subscription number.
orderDiscounts arraynull
orderLevelHandlingDiscountTotal number
orderLevelProductDiscountTotal number The total value of order-level (group-level) product discounts.
orderLevelShippingDiscountTotal number
ordinal integer
parentOrderId stringnull The parent order id from which the subscription was created.
pauseDate stringnull
payment object
paymentErrorCode stringnull
previousFrequency object
previousNextOrderDate stringnull
priceListCode stringnull Price-list code for the Subscription
processingErrorMessage stringnull LastErrorMessage from subscription ProcessingInfo.
reactivationDate string This property is being used for reactivation email templete
reasons arraynull
shippingAdjustment object
shippingAmount number
shippingDiscounts arraynull
shippingSubTotal number
shippingTax numbernull
shippingTaxTotal number
shippingTotal number
siteId integer Unique identifier of the Site.
skipCounter integernull counter to keep track of skip limit
sourceDevice stringnull Source device of the user placing the order. (User or customer?)
status stringnull
subTotal number Subtotal before any coupon codes, taxes, fees, etc.
taxData objectnull Storage for any additional/custom tax data.
tenantId integer Unique identifier of the Tenant.
total number Final total
trial object
userId stringnull
visitId stringnull Identifies the Visit ID that was current when the order was placed or when the cart was last updated.
webSessionId stringnull Identifies the web session used to place the order or last update the cart.
View JSON Schema on GitHub

JSON Schema

kibo-commerce-subscription-runtime-subscription-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-subscription-runtime-subscription-schema.json",
  "title": "SubscriptionRuntimeSubscription",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kibo-commerce-subscription-openapi.yml#/components/schemas/SubscriptionRuntimeSubscription",
  "properties": {
    "adjustment": {
      "$ref": "#/$defs/Adjustment"
    },
    "attributes": {
      "items": {
        "$ref": "#/$defs/SubscriptionAttribute"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "auditInfo": {
      "$ref": "#/$defs/CoreApiContractsAuditInfo"
    },
    "changeMessages": {
      "description": "Change Messages",
      "items": {
        "$ref": "#/$defs/ChangeMessage"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "channelCode": {
      "description": "Unique identifier of the channel for this item.",
      "type": [
        "string",
        "null"
      ]
    },
    "couponCodes": {
      "description": "Coupon codes associated with this Subscription.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "currencyCode": {
      "description": "ISO Currency Code.",
      "type": [
        "string",
        "null"
      ]
    },
    "customerAccountId": {
      "description": "Unique identifier of the customer account.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "customerInteractionType": {
      "description": "Determines the interaction type that a customer will use to create this object.\nValid values are: Website, Store, Call, Unknown",
      "type": [
        "string",
        "null"
      ]
    },
    "customerTaxId": {
      "description": "The customers tax ID. If Customer Account ID exists in the system, will set this.",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "description": "Custom data for a given vendor set within the commerce process.",
      "type": [
        "object",
        "null"
      ]
    },
    "discountedSubtotal": {
      "description": "Discounted Subtotal",
      "format": "double",
      "type": "number"
    },
    "dutyAmount": {
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "dutyTotal": {
      "format": "double",
      "type": "number"
    },
    "email": {
      "description": "Email address for checkout",
      "type": [
        "string",
        "null"
      ]
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "feeTotal": {
      "format": "double",
      "type": "number"
    },
    "frequency": {
      "$ref": "#/$defs/Frequency"
    },
    "frequencyAuditInfo": {
      "$ref": "#/$defs/CoreApiContractsAuditInfo"
    },
    "fulfillmentInfo": {
      "$ref": "#/$defs/FulfillmentInfo"
    },
    "handlingAdjustment": {
      "$ref": "#/$defs/Adjustment"
    },
    "handlingAmount": {
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "handlingDiscounts": {
      "items": {
        "$ref": "#/$defs/AppliedDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "handlingSubTotal": {
      "format": "double",
      "type": "number"
    },
    "handlingTax": {
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "handlingTaxTotal": {
      "format": "double",
      "type": "number"
    },
    "handlingTotal": {
      "format": "double",
      "type": "number"
    },
    "hasDraft": {
      "description": "Does this subscription have a draft version.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "id": {
      "description": "Unique identifier.",
      "type": [
        "string",
        "null"
      ]
    },
    "invalidCoupons": {
      "description": "A list of invalid coupons that were attempted on the Subscription",
      "items": {
        "$ref": "#/$defs/InvalidCoupon"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "ipAddress": {
      "description": "IP address of the user placing the order. (User or customer?)",
      "type": [
        "string",
        "null"
      ]
    },
    "isDraft": {
      "description": "Is this subscription a draft version",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isImport": {
      "type": "boolean"
    },
    "isOrderReminderEmailSent": {
      "description": "Has order reminder email sent.",
      "type": "boolean"
    },
    "isPartialDraft": {
      "description": "Is this subscription draft is a partial draft.",
      "type": "boolean"
    },
    "isReactivationReminderEmailSent": {
      "description": "Has reactivation reminder email sent.",
      "type": "boolean"
    },
    "isTaxExempt": {
      "description": "Unique identifier of the customer account.",
      "readOnly": true,
      "type": [
        "boolean",
        "null"
      ]
    },
    "itemLevelAdjustmentsTotal": {
      "description": "The total value of all line item adjustments",
      "format": "double",
      "type": "number"
    },
    "itemLevelHandlingDiscountTotal": {
      "format": "double",
      "type": "number"
    },
    "itemLevelProductDiscountTotal": {
      "description": "The total value of item-level product discounts.",
      "format": "double",
      "type": "number"
    },
    "itemLevelShippingDiscountTotal": {
      "format": "double",
      "type": "number"
    },
    "itemTaxTotal": {
      "description": "Total tax on products.",
      "format": "double",
      "type": "number"
    },
    "itemTotal": {
      "description": "The total product cost, accounting for discounts and tax.",
      "format": "double",
      "type": "number"
    },
    "items": {
      "description": "List of items in the Subscription.",
      "items": {
        "$ref": "#/$defs/SubscriptionItem"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "lastContinuityOrderDateOnSubPaused": {
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "lastOrderNowDate": {
      "description": "Indicate when \"order now\" and \"partial order now\" performed last time.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "lineItemSubtotalWithOrderAdjustments": {
      "description": "Line Item Subtotals with Order Adjustments",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "locationCode": {
      "description": "Identifies the location at which the order was placed if the order was placed externally.",
      "type": [
        "string",
        "null"
      ]
    },
    "nextOrderDate": {
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "nextOrderDateAuditInfo": {
      "$ref": "#/$defs/CoreApiContractsAuditInfo"
    },
    "nextOrderDateOffsetCounter": {
      "description": "counter to keep track of nextOrderDate limit.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "notes": {
      "description": "Notes",
      "items": {
        "$ref": "#/$defs/OrderNote"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "number": {
      "description": "Subscription number.",
      "format": "int32",
      "type": "integer"
    },
    "orderDiscounts": {
      "items": {
        "$ref": "#/$defs/AppliedDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "orderLevelHandlingDiscountTotal": {
      "format": "double",
      "type": "number"
    },
    "orderLevelProductDiscountTotal": {
      "description": "The total value of order-level (group-level) product discounts.",
      "format": "double",
      "type": "number"
    },
    "orderLevelShippingDiscountTotal": {
      "format": "double",
      "type": "number"
    },
    "ordinal": {
      "format": "int32",
      "type": "integer"
    },
    "parentOrderId": {
      "description": "The parent order id from which the subscription was created.",
      "type": [
        "string",
        "null"
      ]
    },
    "pauseDate": {
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "payment": {
      "$ref": "#/$defs/Payment"
    },
    "paymentErrorCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "previousFrequency": {
      "$ref": "#/$defs/Frequency"
    },
    "previousNextOrderDate": {
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "priceListCode": {
      "description": "Price-list code for the Subscription",
      "type": [
        "string",
        "null"
      ]
    },
    "processingErrorMessage": {
      "description": "LastErrorMessage from subscription ProcessingInfo.",
      "type": [
        "string",
        "null"
      ]
    },
    "reactivationDate": {
      "description": "This property is being used for reactivation email templete",
      "format": "date-time",
      "type": "string"
    },
    "reasons": {
      "items": {
        "$ref": "#/$defs/SubscriptionReason"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "shippingAdjustment": {
      "$ref": "#/$defs/Adjustment"
    },
    "shippingAmount": {
      "format": "double",
      "type": "number"
    },
    "shippingDiscounts": {
      "items": {
        "$ref": "#/$defs/ShippingDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "shippingSubTotal": {
      "format": "double",
      "type": "number"
    },
    "shippingTax": {
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "shippingTaxTotal": {
      "format": "double",
      "type": "number"
    },
    "shippingTotal": {
      "format": "double",
      "type": "number"
    },
    "siteId": {
      "description": "Unique identifier of the Site.",
      "format": "int32",
      "type": "integer"
    },
    "skipCounter": {
      "description": "counter to keep track of skip limit",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "sourceDevice": {
      "description": "Source device of the user placing the order. (User or customer?)",
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": [
        "string",
        "null"
      ]
    },
    "subTotal": {
      "description": "Subtotal before any coupon codes, taxes, fees, etc.",
      "format": "double",
      "type": "number"
    },
    "taxData": {
      "description": "Storage for any additional/custom tax data.",
      "type": [
        "object",
        "null"
      ]
    },
    "tenantId": {
      "description": "Unique identifier of the Tenant.",
      "format": "int32",
      "type": "integer"
    },
    "total": {
      "description": "Final total",
      "format": "double",
      "type": "number"
    },
    "trial": {
      "$ref": "#/$defs/Trial"
    },
    "userId": {
      "type": [
        "string",
        "null"
      ]
    },
    "visitId": {
      "description": "Identifies the Visit ID that was current when the order was placed or when the cart was last updated.",
      "type": [
        "string",
        "null"
      ]
    },
    "webSessionId": {
      "description": "Identifies the web session used to place the order or last update the cart.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "type": "object",
  "$defs": {
    "Address": {
      "properties": {
        "address1": {
          "type": [
            "string",
            "null"
          ]
        },
        "address2": {
          "type": [
            "string",
            "null"
          ]
        },
        "address3": {
          "type": [
            "string",
            "null"
          ]
        },
        "address4": {
          "type": [
            "string",
            "null"
          ]
        },
        "addressType": {
          "type": [
            "string",
            "null"
          ]
        },
        "cityOrTown": {
          "type": [
            "string",
            "null"
          ]
        },
        "countryCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "isValidated": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "postalOrZipCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "stateOrProvince": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "Adjustment": {
      "properties": {
        "amount": {
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "internalComment": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "AppliedDiscount": {
      "description": "Discount applied to the order, which is a negative number to be subtracted from the original price to get the final price. \nIf multiple discounts for the order exist, this is the value most advantageous to the shopper.",
      "properties": {
        "couponCode": {
          "description": "Code of the coupon associated with the discount if a coupon code is required to get the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "data": {
          "description": "Stores any custom data sent from external discounts.",
          "type": [
            "object",
            "null"
          ]
        },
        "discount": {
          "$ref": "#/$defs/Discount"
        },
        "excluded": {
          "description": "Determines whether or not this discount is set up to be ignored by the pricing runtime.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "groupId": {
          "description": "Group identifier for the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "impact": {
          "description": "Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "AppliedLineItemProductDiscount": {
      "properties": {
        "appliesToSalePrice": {
          "description": "Determines if the discount applies to the sale price of the order",
          "type": [
            "boolean",
            "null"
          ]
        },
        "discountQuantity": {
          "description": "The number of the line item that can be used for this particular discount.",
          "format": "int32",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "AppliedLineItemShippingDiscount": {
      "properties": {
        "discount": {
          "$ref": "#/$defs/AppliedDiscount"
        },
        "discountQuantity": {
          "description": "The number of the line item that can be used for this particular discount.",
          "format": "int32",
          "type": "integer"
        },
        "impactPerUnit": {
          "description": "The impact of this discount pur discount quantity.",
          "format": "double",
          "type": "number"
        },
        "methodCode": {
          "description": "Unique identifier of the shipping method discount.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "BillingInfo": {
      "description": "Customer's payment details such as payment type (credit card, check by mail, or PayPal)\nand cardholder information if payment is by credit card.",
      "properties": {
        "auditInfo": {
          "$ref": "#/$defs/CoreApiContractsAuditInfo"
        },
        "billingContact": {
          "$ref": "#/$defs/Contact"
        },
        "card": {
          "$ref": "#/$defs/PaymentCard"
        },
        "check": {
          "$ref": "#/$defs/CheckPayment"
        },
        "customCreditType": {
          "description": "Name of custom stored credit type",
          "type": [
            "string",
            "null"
          ]
        },
        "data": {
          "description": "Custom data from payment providers",
          "type": [
            "object",
            "null"
          ]
        },
        "externalToken": {
          "$ref": "#/$defs/ExternalPaymentToken"
        },
        "externalTransactionId": {
          "description": "Transaction Id from third party payment source like Visa Checkout, Amazon",
          "type": [
            "string",
            "null"
          ]
        },
        "isRecurring": {
          "description": "Indicates whether the payment is used in recurring transactions. ex- subscription payments",
          "type": "boolean"
        },
        "isSameBillingShippingAddress": {
          "description": "Indicates that billing and shipping address are the same",
          "type": "boolean"
        },
        "paymentType": {
          "description": "Type of payment, such as credit card, check by mail, or PayPal.\nsee Mozu.CommerceRuntime.Contracts.Payments.PaymentTypeConst for valid values",
          "type": [
            "string",
            "null"
          ]
        },
        "paymentWorkflow": {
          "type": [
            "string",
            "null"
          ]
        },
        "purchaseOrder": {
          "$ref": "#/$defs/PurchaseOrderPayment"
        },
        "recurringTransactionId": {
          "description": "Recurring Payment Id returned by Payment Gateway\nnetworkTransactionId for vantiv\npreviousTransactionId for cybersource etc",
          "type": [
            "string",
            "null"
          ]
        },
        "storeCreditCode": {
          "description": "The store credit to use for this purchase",
          "type": [
            "string",
            "null"
          ]
        },
        "storeCreditType": {
          "description": "The type of store credit used for this purchase",
          "type": [
            "string",
            "null"
          ]
        },
        "token": {
          "$ref": "#/$defs/PaymentToken"
        }
      },
      "type": "object"
    },
    "BundledProduct": {
      "description": "Describes products that are bundled inside of a main bundle product.",
      "properties": {
        "allocationExpiration": {
          "description": "Allocation ID associated with this product on this order.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "allocationId": {
          "description": "Allocation ID associated with this product on this order.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "creditValue": {
          "description": "Credit value.  Only populated if the bundled product is a gift card or digital credit",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "deltaPrice": {
          "description": "Only populated for extras",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "description": {
          "description": "Short description of the product in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "fulfillmentStatus": {
          "description": "Fulfillment status of the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "goodsType": {
          "description": "Goods Type",
          "type": [
            "string",
            "null"
          ]
        },
        "imageUrl": {
          "description": "ImageUrl of product",
          "type": [
            "string",
            "null"
          ]
        },
        "isPackagedStandAlone": {
          "description": "Indicates that this product ships by itself.",
          "type": "boolean"
        },
        "measurements": {
          "$ref": "#/$defs/PackageMeasurements"
        },
        "name": {
          "description": "Name of the product, this is the current value of the product's name in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "optionAttributeFQN": {
          "description": "Fully Qualified Name of the selected option's attribute",
          "type": [
            "string",
            "null"
          ]
        },
        "optionValue": {
          "description": "Value of the selected option",
          "nullable": true
        },
        "productCode": {
          "description": "Merchant-created code that uniquely identifies the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "productReservationId": {
          "description": "Reservation ID associated with this product in the bundle.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "quantity": {
          "description": "Quantity of the product included in the bundle.",
          "format": "int32",
          "type": "integer"
        },
        "stock": {
          "$ref": "#/$defs/ProductStock"
        }
      },
      "type": "object"
    },
    "CapturableShipmentSummary": {
      "properties": {
        "amountApplied": {
          "description": "The amount applied by the payment action",
          "format": "double",
          "type": "number"
        },
        "shipmentNumber": {
          "description": "The identifying number of the shipment affected by the payment action",
          "format": "int32",
          "type": "integer"
        },
        "shipmentTotal": {
          "description": "The shipment's total when the payment action occurred",
          "format": "double",
          "type": "number"
        }
      },
      "type": "object"
    },
    "Category": {
      "description": "Categories to which the product belongs. Discounts can apply to categories where any product in the category is discounted.",
      "properties": {
        "id": {
          "description": "Unique identifier of the category. System-supplied and read-only.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "parent": {
          "$ref": "#/$defs/Category"
        }
      },
      "type": "object"
    },
    "ChangeMessage": {
      "description": "A message displayed by the system based on the last  action, for example, when a product price has changed. System-supplied and read-only.",
      "properties": {
        "amount": {
          "deprecated": true,
          "description": "Monetary amount that pertains to the change if applicable",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "appId": {
          "description": "App Id that identifies the user that performed the related change",
          "type": [
            "string",
            "null"
          ]
        },
        "appKey": {
          "description": "App Key",
          "type": [
            "string",
            "null"
          ]
        },
        "appName": {
          "description": "App Name",
          "type": [
            "string",
            "null"
          ]
        },
        "attributes": {
          "additionalProperties": {
            "nullable": true
          },
          "description": "Additional Data. This property will be a Dictionary of objects.",
          "type": [
            "object",
            "null"
          ]
        },
        "correlationId": {
          "description": "Correlation Id",
          "type": [
            "string",
            "null"
          ]
        },
        "createDate": {
          "description": "When the message was created. System-supplied. Read-only.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "Unique identifier of the  message. System-supplied. Read-only.",
          "type": [
            "string",
            "null"
          ]
        },
        "identifier": {
          "description": "Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only.",
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "description": "Human readable message. System-supplied. Read-only.",
          "type": [
            "string",
            "null"
          ]
        },
        "metadata": {
          "description": "Data. This property will be a JSON array that will contain 0-N items, when there is 1 item it will still be an array containing only one item. System-supplied. Read-only.",
          "nullable": true
        },
        "newValue": {
          "deprecated": true,
          "description": "Current price of the item. System-supplied. Read-only.",
          "type": [
            "string",
            "null"
          ]
        },
        "oldValue": {
          "deprecated": true,
          "description": "Original price of the item. System-supplied. Read-only.",
          "type": [
            "string",
            "null"
          ]
        },
        "subject": {
          "description": "Text on the subject line of the message, for example, the product name. System-supplied. Read-only.",
          "type": [
            "string",
            "null"
          ]
        },
        "subjectType": {
          "description": "Subject of the message, for example, \"Product.\" System-supplied. Read-only.",
          "type": [
            "string",
            "null"
          ]
        },
        "success": {
          "description": "Indicates if the message is related to a success or failure.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "userFirstName": {
          "description": "User First Name",
          "type": [
            "string",
            "null"
          ]
        },
        "userId": {
          "description": "User Id that identifies the user that performed the related change",
          "type": [
            "string",
            "null"
          ]
        },
        "userLastName": {
          "description": "User Last Name",
          "type": [
            "string",
            "null"
          ]
        },
        "userScopeType": {
          "description": "User Type (e.g. Shopper, Admin, etc.)",
          "type": [
            "string",
            "null"
          ]
        },
        "verb": {
          "description": "Action applicable to the message. This can be \"Increased,\" when the product price has increased, \"Decreased,\" when the \nproduct price has decreased, and \"Invalidated,\" when the product is no longer available. System-supplied. Read-only.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CheckPayment": {
      "properties": {
        "checkNumber": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CommerceUnitPrice": {
      "description": "Pricing details for the product listed on a cart item, including the original price, discount amount, and final price.",
      "properties": {
        "extendedAmount": {
          "description": "Extended amount, this is in order of precedence: OverrideAmount, SaleAmount, ListAmount",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "listAmount": {
          "description": "Product list amount.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "overrideAmount": {
          "description": "Amount as manually overridden by the Merchant",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "saleAmount": {
          "description": "Sale amount indicated on the product.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "Contact": {
      "properties": {
        "address": {
          "$ref": "#/$defs/Address"
        },
        "companyOrOrganization": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        },
        "firstName": {
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "lastNameOrSurname": {
          "type": [
            "string",
            "null"
          ]
        },
        "middleNameOrInitial": {
          "type": [
            "string",
            "null"
          ]
        },
        "phoneNumbers": {
          "$ref": "#/$defs/Phone"
        }
      },
      "type": "object"
    },
    "CoreApiContractsAuditInfo": {
      "properties": {
        "createBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "createDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "updateBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "updateDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "Discount": {
      "description": "Discounts that apply to the order, if any. For example, when the \nsubtotal of the order exceeds a certain amount, or for free shipping.",
      "properties": {
        "expirationDate": {
          "description": "Date when the discount expires. Default is null (no expiration date).",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "hasMultipleTargetProducts": {
          "description": "Indicates that the discount targets more than a product.  Used\nprimarily for BoGa discounts with multiple targets.",
          "type": "boolean"
        },
        "id": {
          "description": "Unique identifier of the discount.",
          "format": "int32",
          "type": "integer"
        },
        "itemIds": {
          "description": "List of discounts for each order item.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "name": {
          "description": "Name of the discount in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "ExternalPaymentToken": {
      "description": "Structured payment token for external (non-Mozu) payment processors.\n\nDistinct from legacy PaymentToken (Apple Pay / PayPal).\n\nUsed in COM-10873 externally tokenized payments feature.\n\nValidation rules:\n- All three fields (PaymentServiceTokenId, Type, Provider) are required\n- Type must match BillingInfo.PaymentType (case-insensitive)\n- Feature gate (externalTokenizationEnabled) must be true",
      "properties": {
        "paymentServiceTokenId": {
          "description": "Actual token value from the external payment provider.",
          "type": [
            "string",
            "null"
          ]
        },
    

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://artifacts.apis.io/kibo-commerce/json-schema/kibo-commerce-subscription-runtime-subscription-schema.json

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/kibo-commerce-subscription-runtime-subscription"
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.