AffiliateSummaryReadSchema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/getoneprofile-ai/json-schema/getoneprofile-ai-affiliate-summary-read-schema-schema.json",
  "title": "AffiliateSummaryReadSchema",
  "description": "Everything the affiliate dashboard's overview needs in one read.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getoneprofile-ai-affiliate-api-openapi.yml#/components/schemas/AffiliateSummaryReadSchema",
  "properties": {
    "code": {
      "description": "The minted default code.",
      "title": "Code",
      "type": "string"
    },
    "display_name": {
      "title": "Display Name",
      "type": "string"
    },
    "link": {
      "description": "The full URL to share, using the vanity code when claimed.",
      "title": "Link",
      "type": "string"
    },
    "profile": {
      "$ref": "#/$defs/AffiliateProfileReadSchema"
    },
    "program": {
      "$ref": "#/$defs/AffiliateProgramReadSchema"
    },
    "stats": {
      "$ref": "#/$defs/AffiliateStatsReadSchema"
    },
    "status": {
      "$ref": "#/$defs/AffiliateStatus"
    },
    "vanity_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "The claimed custom code, when one exists.",
      "title": "Vanity Code"
    }
  },
  "required": [
    "status",
    "display_name",
    "code",
    "vanity_code",
    "link",
    "stats",
    "program",
    "profile"
  ],
  "type": "object",
  "$defs": {
    "AffiliateProfileReadSchema": {
      "description": "The caller's own standing in the affiliate program.",
      "properties": {
        "contact_email": {
          "title": "Contact Email",
          "type": "string"
        },
        "created_at": {
          "format": "date-time",
          "title": "Created At",
          "type": "string"
        },
        "display_name": {
          "title": "Display Name",
          "type": "string"
        },
        "id": {
          "format": "uuid",
          "title": "Id",
          "type": "string"
        },
        "identity_verified_at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Identity Verified At"
        },
        "paypal_email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Paypal Email"
        },
        "paypal_email_confirmed_at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Paypal Email Confirmed At"
        },
        "status": {
          "$ref": "#/$defs/AffiliateStatus"
        }
      },
      "required": [
        "id",
        "status",
        "display_name",
        "contact_email",
        "identity_verified_at",
        "paypal_email",
        "paypal_email_confirmed_at",
        "created_at"
      ],
      "title": "AffiliateProfileReadSchema",
      "type": "object"
    },
    "AffiliateProgramReadSchema": {
      "description": "What the affiliate program pays right now: the public half of the offer.",
      "properties": {
        "conversion_deadline_days": {
          "description": "Days after signup within which a referral must start paying for the stamped terms to hold; later conversions earn the standard schedule.",
          "title": "Conversion Deadline Days",
          "type": "integer"
        },
        "duration_months": {
          "description": "How many months of that customer's payments the rate applies to.",
          "title": "Duration Months",
          "type": "integer"
        },
        "launch_offer_active": {
          "description": "Whether the launch offer currently applies.",
          "title": "Launch Offer Active",
          "type": "boolean"
        },
        "launch_offer_ends_on": {
          "description": "The last day of the launch offer, unless ended earlier.",
          "format": "date",
          "title": "Launch Offer Ends On",
          "type": "string"
        },
        "payout_minimum_cents": {
          "description": "Available balance, in USD cents, below which a monthly payout rolls over.",
          "title": "Payout Minimum Cents",
          "type": "integer"
        },
        "pending_days": {
          "description": "How long an earned commission stays pending before it is payable.",
          "title": "Pending Days",
          "type": "integer"
        },
        "rate_bps": {
          "description": "Commission rate a customer attributed today is stamped with, in basis points.",
          "title": "Rate Bps",
          "type": "integer"
        },
        "standard_duration_months": {
          "description": "The standard duration, in months, outside the launch offer.",
          "title": "Standard Duration Months",
          "type": "integer"
        },
        "standard_rate_bps": {
          "description": "The standard rate, in basis points, outside the launch offer.",
          "title": "Standard Rate Bps",
          "type": "integer"
        }
      },
      "required": [
        "rate_bps",
        "duration_months",
        "standard_rate_bps",
        "standard_duration_months",
        "launch_offer_active",
        "launch_offer_ends_on",
        "conversion_deadline_days",
        "pending_days",
        "payout_minimum_cents"
      ],
      "title": "AffiliateProgramReadSchema",
      "type": "object"
    },
    "AffiliateStatsReadSchema": {
      "description": "The affiliate dashboard's headline numbers.",
      "properties": {
        "available_cents": {
          "description": "Payable balance; negative when clawbacks exceed earnings.",
          "title": "Available Cents",
          "type": "integer"
        },
        "click_count": {
          "description": "Deduplicated, bot-filtered clicks on the affiliate's links.",
          "title": "Click Count",
          "type": "integer"
        },
        "lifetime_earned_cents": {
          "description": "All commission ever accrued.",
          "title": "Lifetime Earned Cents",
          "type": "integer"
        },
        "lifetime_paid_cents": {
          "description": "All payouts ever sent.",
          "title": "Lifetime Paid Cents",
          "type": "integer"
        },
        "paying_count": {
          "description": "Of those, how many are on a paid plan.",
          "title": "Paying Count",
          "type": "integer"
        },
        "pending_cents": {
          "description": "Commission still inside the pending window.",
          "title": "Pending Cents",
          "type": "integer"
        },
        "registered_count": {
          "description": "Workspaces that signed up through the links.",
          "title": "Registered Count",
          "type": "integer"
        }
      },
      "required": [
        "click_count",
        "registered_count",
        "paying_count",
        "pending_cents",
        "available_cents",
        "lifetime_earned_cents",
        "lifetime_paid_cents"
      ],
      "title": "AffiliateStatsReadSchema",
      "type": "object"
    },
    "AffiliateStatus": {
      "description": "Whether an affiliate may earn and be paid.",
      "enum": [
        "active",
        "suspended",
        "banned"
      ],
      "title": "AffiliateStatus",
      "type": "string"
    }
  }
}