VTEX · Schema

Option

Installment options information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
ruleId string Rule identification.
quantity integer Number of installments.
value number Value of each installment.
interestRate number Interest rate (percent 0.1 = 10%).
isExternalInstallmentService number Indicates the external installment system (if applicable).
interestTax number Interest tax (percent 0.1 = 10%).
View JSON Schema on GitHub

JSON Schema

vtex-option-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Option",
  "title": "Option",
  "required": [
    "ruleId",
    "quantity",
    "value",
    "interestRate",
    "isExternalInstallmentService",
    "interestTax"
  ],
  "type": "object",
  "description": "Installment options information.",
  "properties": {
    "ruleId": {
      "type": "string",
      "description": "Rule identification.",
      "nullable": true
    },
    "quantity": {
      "type": "integer",
      "description": "Number of installments."
    },
    "value": {
      "type": "number",
      "description": "Value of each installment."
    },
    "interestRate": {
      "type": "number",
      "description": "Interest rate (percent 0.1 = 10%)."
    },
    "isExternalInstallmentService": {
      "type": "number",
      "description": "Indicates the external installment system (if applicable).",
      "nullable": true
    },
    "interestTax": {
      "type": "number",
      "description": "Interest tax (percent 0.1 = 10%).",
      "nullable": true
    }
  }
}