1
0
Files
PayPal-PHP-Server-SDK/doc/models/phone.md
Patrick Powers 6da8b9b5b8 1.1.0 Release (#44)
* Automated commit message

* add changelog

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
Co-authored-by: Patrick Powers <patickpowers@hey.com>
2025-05-27 13:31:17 -05:00

1.7 KiB

Phone

The phone number, in its canonical international E.164 numbering plan format.

Structure

Phone

Fields

Name Type Tags Description Getter Setter
countryCode string Required The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Constraints: Minimum Length: 1, Maximum Length: 3, Pattern: ^[0-9]{1,3}?$
getCountryCode(): string setCountryCode(string countryCode): void
nationalNumber string Required The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Constraints: Minimum Length: 1, Maximum Length: 14, Pattern: ^[0-9]{1,14}?$
getNationalNumber(): string setNationalNumber(string nationalNumber): void
extensionNumber ?string Optional The extension number.

Constraints: Minimum Length: 1, Maximum Length: 15, Pattern: ^[0-9]{1,15}?$
getExtensionNumber(): ?string setExtensionNumber(?string extensionNumber): void

Example (as JSON)

{
  "country_code": "country_code8",
  "national_number": "national_number2",
  "extension_number": "extension_number2"
}