Paystack · JSON Structure

Paystack Customer Structure

JSON Structure for a Paystack customer profile.

Type: object Properties: 11 Required: 2
PaymentsAfricaFintechRecurring BillingMarketplacesPayoutsMobile MoneyStripe

PaystackCustomer is a JSON Structure definition published by Paystack, describing 11 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

id customer_code email first_name last_name phone international_format_phone metadata risk_action created_at updated_at

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/paystack/main/json-structure/paystack-customer-structure.json",
  "name": "PaystackCustomer",
  "type": "object",
  "description": "JSON Structure for a Paystack customer profile.",
  "properties": {
    "id": { "type": "int64" },
    "customer_code": { "type": "string", "description": "Paystack code prefixed with CUS_." },
    "email": { "type": "string", "format": "email" },
    "first_name": { "type": "string" },
    "last_name": { "type": "string" },
    "phone": { "type": "string" },
    "international_format_phone": { "type": "string" },
    "metadata": { "type": "any" },
    "risk_action": { "type": "string", "description": "default, allow, or deny." },
    "created_at": { "type": "string", "format": "date-time" },
    "updated_at": { "type": "string", "format": "date-time" }
  },
  "required": ["customer_code", "email"]
}