7digital · JSON Structure

Api Voucher Structure

Voucher schema from 7digital API

Type: object Properties: 5
MusicStreamingLicensingCatalogueB2BRoyalty ReportingPublic APIs

Voucher is a JSON Structure definition published by 7digital, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type code value expiresAt redeemed

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/7digital/refs/heads/main/json-structure/api-voucher-structure.json",
  "name": "Voucher",
  "description": "Voucher schema from 7digital API",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "percentage",
        "fixed"
      ],
      "example": "percentage"
    },
    "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": "double",
          "description": "Numeric price value.",
          "example": 9.99
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 currency code.",
          "example": "GBP"
        }
      }
    },
    "expiresAt": {
      "type": "datetime",
      "example": "2026-12-31T23:59:59Z"
    },
    "redeemed": {
      "type": "boolean",
      "example": false
    }
  }
}