{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/affiliaterail-com/json-schema/affiliaterail-com-commission-schema.json",
  "title": "Commission",
  "x-generated": "2026-11-01",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/affiliaterail-com-openapi.json#/components/schemas/Commission",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(sample_)?com_",
      "description": "Prefixed id (`com_…`)"
    },
    "object": {
      "type": "string",
      "enum": [
        "commission"
      ]
    },
    "program_id": {
      "type": "string",
      "pattern": "^(sample_)?prg_",
      "description": "Prefixed id (`prg_…`)"
    },
    "partner_id": {
      "type": "string",
      "pattern": "^(sample_)?part_",
      "description": "Prefixed id (`part_…`)"
    },
    "sale_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?sale_",
      "description": "Prefixed id (`sale_…`)"
    },
    "customer_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?cus_",
      "description": "Prefixed id (`cus_…`)"
    },
    "rule_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?flw_",
      "description": "Which commission rule produced it"
    },
    "rule_branch_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?flb_",
      "description": "And which branch"
    },
    "kind": {
      "type": "string",
      "enum": [
        "referral",
        "reward",
        "clawback"
      ]
    },
    "amount_minor": {
      "type": "integer",
      "description": "Integer minor units (cents, pence). Never a float, never a string."
    },
    "revenue_minor": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Integer minor units (cents, pence). Never a float, never a string."
    },
    "currency": {
      "type": "string",
      "minLength": 3,
      "maxLength": 3,
      "description": "ISO-4217"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "approved",
        "due",
        "paid",
        "rejected",
        "voided"
      ]
    },
    "mature_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "approved_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "voided_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "void_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "payout_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?pyt_",
      "description": "Prefixed id (`pyt_…`)"
    },
    "metadata": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {},
      "description": "Your own key/value data, stored as given"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO-8601, UTC"
    }
  },
  "required": [
    "id",
    "object",
    "program_id",
    "partner_id",
    "sale_id",
    "customer_id",
    "rule_id",
    "rule_branch_id",
    "kind",
    "amount_minor",
    "revenue_minor",
    "currency",
    "status",
    "mature_at",
    "approved_at",
    "voided_at",
    "void_reason",
    "payout_id",
    "metadata",
    "created_at",
    "updated_at"
  ]
}