7digital · Schema

Voucher

Voucher schema from 7digital API

MusicStreamingLicensingCatalogueB2BRoyalty ReportingPublic APIs

Properties

Name Type Description
code string
value object A price quoted in the requested territory's currency.
type string
expiresAt string
redeemed boolean
View JSON Schema on GitHub

JSON Schema

api-voucher-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/7digital/refs/heads/main/json-schema/api-voucher-schema.json",
  "title": "Voucher",
  "description": "Voucher schema from 7digital API",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "SUMMER25"
    },
    "value": {
      "type": "object",
      "description": "A price quoted in the requested territory's currency.",
      "properties": {
        "formattedPrice": {
          "type": "string",
          "example": "\u00a39.99"
        },
        "amount": {
          "type": "number",
          "description": "Numeric price value.",
          "example": 9.99
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 currency code.",
          "example": "GBP"
        }
      }
    },
    "type": {
      "type": "string",
      "enum": [
        "percentage",
        "fixed"
      ],
      "example": "percentage"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "example": "2026-12-31T23:59:59Z"
    },
    "redeemed": {
      "type": "boolean",
      "example": false
    }
  }
}