PApaypal
Customers

Create a new customer

post/customers

Request

Request body

namestring required

Full name of the customer

external_idstring required

External identifier for the customer. Must contain only alphanumeric characters, underscores, and hyphens.

emailstring required

The internationalized email address.

billing_entity_codestring

Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.

phonestring phone

Primary phone number of the customer, including country code if available.

payment_method_tokenstring

Token representing the customer's saved payment method in PayPal Vault.

tax_codesstring[]

List of unique codes used to identify taxes to be applied.

Example request

{
  "name": "John Doe",
  "external_id": "ext_cust_12345",
  "email": "abc@test.com",
  "billing_entity_code": "acme_inc",
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "phone": "+1-234-567-8900",
  "payment_method_token": "pm_visa_4242",
  "tax_codes": [
    "standard_vat"
  ],
  "metadata": [
    {
      "key": "Purchase Order",
      "value": "123456789",
      "display_in_invoice": true
    }
  ]
}

Response

Customer created successfully.

namestring required

Full name of the customer

external_idstring required

External identifier for the customer. Must contain only alphanumeric characters, underscores, and hyphens.

emailstring required

The internationalized email address.

billing_entity_codestring

Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.

phonestring phone

Primary phone number of the customer, including country code if available.

payment_method_tokenstring

Token representing the customer's saved payment method in PayPal Vault.

payment_method_type'CARD' | 'PAYPAL' | 'ACH_DEBIT' | 'APPLE_PAY'

Type of payment method used (e.g., CARD, ACH_DEBIT)

idstring

Example response

{
  "name": "John Doe",
  "external_id": "ext_cust_12345",
  "email": "abc@test.com",
  "billing_entity_code": "acme_inc",
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "phone": "+1-234-567-8900",
  "payment_method_token": "pm_visa_4242",
  "payment_method_type": "CARD",
  "taxes": [
    {
      "name": "TVA",
      "rate": "20.00",
      "description": "French standard VAT",
      "code": "standard_vat",
      "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2025-06-01T00:00:00Z"
    }
  ],
  "metadata": [
    {
      "key": "Purchase Order",
      "value": "123456789",
      "display_in_invoice": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.