SbPublicApiVoucherResponse

snowbee.SbPublicApiVoucherResponse

object · non-null

externalReferencestringnon-nullrequired: External reference for the voucher
Example"abc123-promo-uuid"
titlestringnullableoptional: Display name for the voucher
Example"Summer Sale 20%"
typestringnullableoptional: Example"PERCENTAGE"
valuestringnullableoptional: Format: BigDecimal
Example"20.00"

View raw schema

{
  "type": "object",
  "properties": {
    "externalReference": {
      "type": "string",
      "description": "External reference for the voucher",
      "example": "abc123-promo-uuid",
      "title": "String"
    },
    "title": {
      "type": [
        "null",
        "string"
      ],
      "description": "Display name for the voucher",
      "example": "Summer Sale 20%",
      "title": "String"
    },
    "type": {
      "type": [
        "null",
        "string"
      ],
      "example": "PERCENTAGE",
      "title": "String"
    },
    "value": {
      "type": [
        "null",
        "string"
      ],
      "format": "BigDecimal",
      "example": "20.00",
      "title": "BigDecimalAsString"
    }
  },
  "required": [
    "externalReference"
  ],
  "title": "SbPublicApiVoucherResponse"
}