Partner

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/affiliaterail-com/json-schema/affiliaterail-com-partner-schema.json",
  "title": "Partner",
  "x-generated": "2026-11-01",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/affiliaterail-com-openapi.json#/components/schemas/Partner",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(sample_)?part_",
      "description": "Prefixed id (`part_…`)"
    },
    "object": {
      "type": "string",
      "enum": [
        "partner"
      ]
    },
    "program_id": {
      "type": "string",
      "pattern": "^(sample_)?prg_",
      "description": "Prefixed id (`prg_…`)"
    },
    "group_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?grp_",
      "description": "Prefixed id (`grp_…`)"
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "display_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "company_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "website_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "country_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "handle": {
      "type": "string",
      "description": "The `?ref=` value"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "active",
        "declined",
        "suspended"
      ]
    },
    "decline_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "suspension_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "currency": {
      "type": "string",
      "minLength": 3,
      "maxLength": 3,
      "description": "The program's currency; every amount on this partner is in it"
    },
    "min_payout_minor": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Per-partner threshold override; null means the program's"
    },
    "terms_accepted_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "terms_version": {
      "type": [
        "string",
        "null"
      ]
    },
    "completed_onboarding": {
      "type": "boolean"
    },
    "email_first_referral": {
      "type": "boolean"
    },
    "email_new_referral": {
      "type": "boolean"
    },
    "email_payout_paid": {
      "type": "boolean"
    },
    "metadata": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {},
      "description": "Your own key/value data, stored as given"
    },
    "stats": {
      "$ref": "#/$defs/PartnerStats"
    },
    "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",
    "group_id",
    "email",
    "first_name",
    "last_name",
    "display_name",
    "company_name",
    "website_url",
    "country_code",
    "language_code",
    "handle",
    "status",
    "decline_reason",
    "suspension_reason",
    "currency",
    "min_payout_minor",
    "terms_accepted_at",
    "terms_version",
    "completed_onboarding",
    "email_first_referral",
    "email_new_referral",
    "email_payout_paid",
    "metadata",
    "created_at",
    "updated_at"
  ],
  "$defs": {
    "PartnerStats": {
      "type": "object",
      "properties": {
        "clicks": {
          "type": "integer"
        },
        "referrals": {
          "type": "integer"
        },
        "customers": {
          "type": "integer"
        },
        "commissions_minor": {
          "type": "integer",
          "description": "Integer minor units (cents, pence). Never a float, never a string."
        },
        "paid_minor": {
          "type": "integer",
          "description": "Integer minor units (cents, pence). Never a float, never a string."
        },
        "currency": {
          "type": "string",
          "minLength": 3,
          "maxLength": 3,
          "description": "ISO-4217"
        }
      },
      "required": [
        "clicks",
        "referrals",
        "customers",
        "commissions_minor",
        "paid_minor",
        "currency"
      ]
    }
  }
}