Tapfiliate · Schema

Customer

A customer referred by an affiliate in the Tapfiliate platform.

Affiliate MarketingAffiliate TrackingCommission ManagementConversion TrackingPartner ProgramsReferral ProgramsInfluencer Marketing

Properties

Name Type Description
id string Tapfiliate's internal customer ID
customer_id string Your external customer identifier
status string Customer billing status
created_at string
click objectnull The click that attributed this customer
meta_data object Arbitrary key-value metadata
View JSON Schema on GitHub

JSON Schema

tapfiliate-customer.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.tapfiliate.com/schemas/customer.json",
  "title": "Customer",
  "description": "A customer referred by an affiliate in the Tapfiliate platform.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Tapfiliate's internal customer ID",
      "example": "cu_eXampl3"
    },
    "customer_id": {
      "type": "string",
      "description": "Your external customer identifier"
    },
    "status": {
      "type": "string",
      "enum": ["trial", "paid", "cancelled"],
      "description": "Customer billing status"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "click": {
      "type": ["object", "null"],
      "description": "The click that attributed this customer",
      "properties": {
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "referrer": {
          "type": "string",
          "format": "uri"
        },
        "landing_page": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "meta_data": {
      "type": "object",
      "additionalProperties": true,
      "description": "Arbitrary key-value metadata"
    }
  }
}