Customer

AffiliatesSoftware-as-a-ServiceMarketingPaymentsAffiliateSoftwareCompany

Properties

Name	Type	Description
id	string	Prefixed id (`cus_…`)
object	string
program_id	string	Prefixed id (`prg_…`)
partner_id	string	Prefixed id (`part_…`)
referral_id	stringnull	Prefixed id (`ref_…`)
link_id	stringnull	Prefixed id (`lnk_…`)
coupon_id	stringnull	Prefixed id (`cpn_…`)
processor	stringnull
external_customer_id	stringnull
external_subscription_id	stringnull
email	stringnull
name	stringnull
identifier	stringnull
status	string
tracked_by	string
lead_at	stringnull	ISO-8601, UTC
converted_at	stringnull	ISO-8601, UTC
metadata	objectnull	Your own key/value data, stored as given
created_at	string	ISO-8601, UTC
updated_at	string	ISO-8601, UTC

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/affiliaterail-com/json-schema/affiliaterail-com-customer-schema.json",
  "title": "Customer",
  "x-generated": "2026-11-01",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/affiliaterail-com-openapi.json#/components/schemas/Customer",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(sample_)?cus_",
      "description": "Prefixed id (`cus_…`)"
    },
    "object": {
      "type": "string",
      "enum": [
        "customer"
      ]
    },
    "program_id": {
      "type": "string",
      "pattern": "^(sample_)?prg_",
      "description": "Prefixed id (`prg_…`)"
    },
    "partner_id": {
      "type": "string",
      "pattern": "^(sample_)?part_",
      "description": "Prefixed id (`part_…`)"
    },
    "referral_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?ref_",
      "description": "Prefixed id (`ref_…`)"
    },
    "link_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?lnk_",
      "description": "Prefixed id (`lnk_…`)"
    },
    "coupon_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?cpn_",
      "description": "Prefixed id (`cpn_…`)"
    },
    "processor": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "stripe",
        "paddle",
        "chargebee",
        "manual",
        "api",
        null
      ]
    },
    "external_customer_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "external_subscription_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "type": [
        "string",
        "null"
      ]
    },
    "identifier": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "lead",
        "trial",
        "active",
        "cancelled",
        "refunded",
        "suspended"
      ]
    },
    "tracked_by": {
      "type": "string",
      "enum": [
        "link",
        "coupon",
        "manual",
        "api"
      ]
    },
    "lead_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "converted_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "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",
    "referral_id",
    "link_id",
    "coupon_id",
    "processor",
    "external_customer_id",
    "external_subscription_id",
    "email",
    "name",
    "identifier",
    "status",
    "tracked_by",
    "lead_at",
    "converted_at",
    "metadata",
    "created_at",
    "updated_at"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/affiliaterail-com-customer"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.