AffiliateRail · Schema

Sale

AffiliatesSoftware-as-a-ServiceMarketingPaymentsAffiliateSoftwareCompany

Properties

Name Type Description
id string Prefixed id (`sale_…`)
object string
program_id string Prefixed id (`prg_…`)
customer_id string Prefixed id (`cus_…`)
partner_id string Prefixed id (`part_…`)
external_charge_id string
external_payment_intent_id stringnull
processor string
amount_minor integer Integer minor units (cents, pence). Never a float, never a string.
tax_minor integernull Integer minor units (cents, pence). Never a float, never a string.
currency string ISO-4217
billing_type string
interval stringnull
product_id stringnull
product_name stringnull
is_first_sale boolean
occurred_at string ISO-8601, UTC
refunded_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

affiliaterail-com-sale-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/affiliaterail-com/json-schema/affiliaterail-com-sale-schema.json",
  "title": "Sale",
  "x-generated": "2026-11-01",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/affiliaterail-com-openapi.json#/components/schemas/Sale",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(sample_)?sale_",
      "description": "Prefixed id (`sale_…`)"
    },
    "object": {
      "type": "string",
      "enum": [
        "sale"
      ]
    },
    "program_id": {
      "type": "string",
      "pattern": "^(sample_)?prg_",
      "description": "Prefixed id (`prg_…`)"
    },
    "customer_id": {
      "type": "string",
      "pattern": "^(sample_)?cus_",
      "description": "Prefixed id (`cus_…`)"
    },
    "partner_id": {
      "type": "string",
      "pattern": "^(sample_)?part_",
      "description": "Prefixed id (`part_…`)"
    },
    "external_charge_id": {
      "type": "string"
    },
    "external_payment_intent_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "processor": {
      "type": "string",
      "enum": [
        "stripe",
        "paddle",
        "chargebee",
        "manual",
        "api"
      ]
    },
    "amount_minor": {
      "type": "integer",
      "description": "Integer minor units (cents, pence). Never a float, never a string."
    },
    "tax_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"
    },
    "billing_type": {
      "type": "string",
      "enum": [
        "one_time",
        "subscription"
      ]
    },
    "interval": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "day",
        "week",
        "month",
        "year",
        null
      ]
    },
    "product_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "product_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "is_first_sale": {
      "type": "boolean"
    },
    "occurred_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "refunded_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",
    "customer_id",
    "partner_id",
    "external_charge_id",
    "external_payment_intent_id",
    "processor",
    "amount_minor",
    "tax_minor",
    "currency",
    "billing_type",
    "interval",
    "product_id",
    "product_name",
    "is_first_sale",
    "occurred_at",
    "refunded_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-sale"
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.

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