PayPal · Schema

Customer

The customer who approves and pays for the order. The customer is also known as the payer.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks
View JSON Schema on GitHub

JSON Schema

paypal-payer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/payer",
  "title": "Customer",
  "type": "object",
  "description": "The customer who approves and pays for the order. The customer is also known as the payer.",
  "format": "payer_v1",
  "allOf": [
    {
      "$ref": "#/components/schemas/payer_base"
    },
    {
      "properties": {
        "name": {
          "description": "The name of the payer. Supports only the `given_name` and `surname` properties.",
          "$ref": "#/components/schemas/name"
        },
        "phone": {
          "description": "The phone number of the customer. Available only when you enable the **Contact Telephone Number** option in the <a href=\"https://www.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-website-payments\">**Profile & Settings**</a> for the merchant's PayPal account. The `phone.phone_number` supports only `national_number`.",
          "$ref": "#/components/schemas/phone_with_type"
        },
        "birth_date": {
          "description": "The birth date of the payer in `YYYY-MM-DD` format.",
          "$ref": "#/components/schemas/date_no_time"
        },
        "tax_info": {
          "description": "The tax information of the payer. Required only for Brazilian payer's. Both `tax_id` and `tax_id_type` are required.",
          "$ref": "#/components/schemas/tax_info"
        },
        "address": {
          "description": "The address of the payer. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of the customer.",
          "$ref": "#/components/schemas/address_portable"
        }
      }
    }
  ]
}