On this page
No Headings
namerequiredstringFull name of the customer
external_idrequiredstring^[a-zA-Z0-9_-]*$External identifier for the customer. Must contain only alphanumeric characters, underscores, and hyphens.
emailrequiredstring^.+@[^"\-].+$The internationalized email address.
billing_entity_codestring^[a-zA-Z0-9_-]*$Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.
addressobjectAddress of the customer or party.
line1stringFirst line of the address.
line2stringSecond line of the address (optional). This can include apartment, suite, or unit numbers.
citystringCity of the customer or party.
statestringState or region of the customer or party.
postal_codestringPostal or ZIP code of the customer or party. Typically required for countries with a postal code or an equivalent.
countrystring^[A-Z]{2}$Country of the customer or party. Use ISO 3166-1 alpha-2 country codes.
phonestringphonePrimary phone number of the customer, including country code if available.
payment_method_tokenobjectToken representing the customer's saved payment method in PayPal Vault.
payment_method_typestring"CARD", "PAYPAL", "ACH_DEBIT", "APPLE_PAY"Type of payment method used (e.g., CARD, ACH_DEBIT)
taxesarrayList of tax entities configured for the customer.
itemsobjectRepresents a customizable tax rate that can be applied to invoices and fees
namerequiredstringName of the tax
ratestring^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.
descriptionstringDetailed description of the tax for internal reference
codestring^[a-zA-Z0-9_-]*$Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.
idstringuuidUnique identifier of the tax
created_atobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
metadataarrayitemsobjectSet of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format
keyrequiredstringThe metadata object key
valuerequiredstringThe metadata object value
display_in_invoicerequiredbooleanDetermines whether the item or information should be displayed in the invoice. If set to true, the item or information will be included and visible in the generated invoice. If set to false, the item or information will be excluded and not displayed in the invoice.
idstring