Paystack · Schema

Paystack Customer

A Paystack customer profile that can be referenced from transactions, subscriptions, and dedicated virtual accounts.

PaymentsAfricaFintechRecurring BillingMarketplacesPayoutsMobile MoneyStripe

Properties

Name Type Description
id integer Unique numeric customer identifier.
customer_code string Paystack-issued customer code (prefixed with CUS_).
email string Customer email address (required).
first_name stringnull
last_name stringnull
phone stringnull
international_format_phone stringnull
metadata objectnull Arbitrary merchant-defined key-value pairs.
risk_action string Risk classification for this customer.
created_at string
updated_at string
View JSON Schema on GitHub

JSON Schema

paystack-customer-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/paystack/main/json-schema/paystack-customer-schema.json",
  "title": "Paystack Customer",
  "description": "A Paystack customer profile that can be referenced from transactions, subscriptions, and dedicated virtual accounts.",
  "type": "object",
  "required": ["customer_code", "email"],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique numeric customer identifier."
    },
    "customer_code": {
      "type": "string",
      "pattern": "^CUS_[a-zA-Z0-9]+$",
      "description": "Paystack-issued customer code (prefixed with CUS_)."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Customer email address (required)."
    },
    "first_name": { "type": ["string", "null"] },
    "last_name": { "type": ["string", "null"] },
    "phone": { "type": ["string", "null"] },
    "international_format_phone": { "type": ["string", "null"] },
    "metadata": {
      "type": ["object", "null"],
      "description": "Arbitrary merchant-defined key-value pairs."
    },
    "risk_action": {
      "type": "string",
      "enum": ["default", "allow", "deny"],
      "description": "Risk classification for this customer."
    },
    "created_at": { "type": "string", "format": "date-time" },
    "updated_at": { "type": "string", "format": "date-time" }
  }
}