7digital · Schema

Purchase

Purchase schema from 7digital API

MusicStreamingLicensingCatalogueB2BRoyalty ReportingPublic APIs

Properties

Name	Type	Description
purchaseId	string
status	string
total	object	A price quoted in the requested territory's currency.
items	array
receiptUrl	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/7digital/refs/heads/main/json-schema/api-purchase-schema.json",
  "title": "Purchase",
  "description": "Purchase schema from 7digital API",
  "type": "object",
  "properties": {
    "purchaseId": {
      "type": "string",
      "example": "purchase-789012"
    },
    "status": {
      "type": "string",
      "enum": [
        "completed",
        "pending",
        "failed"
      ],
      "example": "completed"
    },
    "total": {
      "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"
        }
      }
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "itemId": {
            "type": "string",
            "example": "item-789012"
          },
          "releaseId": {
            "type": "string",
            "nullable": true,
            "example": "11700062"
          },
          "trackId": {
            "type": "string",
            "nullable": true,
            "example": "123456"
          },
          "price": {
            "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"
              }
            }
          }
        }
      }
    },
    "receiptUrl": {
      "type": "string",
      "format": "uri",
      "example": "https://www.7digital.com/receipts/purchase-789012"
    }
  }
}