For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Online API
    • API Environments
    • Direct Payment Flow
    • REST
    • HTTPS
    • Request Headers
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
      • Contact object
      • Consumer object
      • Discount object
      • Item object
      • Money object
      • Order Details object
      • Payment object
      • Refund object
      • Shipping Courier object
    • API Simulator
    • JavaScript afterpay.js
    • Errors
LogoLogo
On this page
  • Attributes
  • Example Consumer object
Online APIModels

Consumer object

Was this page helpful?
Previous

Discount object

Next
Built with

Attributes

AttributeTypeDescription
phoneNumberstringThe consumer’s phone number. Limited to 32 characters.
givenNamesstring requiredThe consumer’s first name and any middle names. Limited to 128 characters.
surnamestring requiredThe consumer’s last name. Limited to 128 characters.
emailstring requiredThe consumer’s email address. Limited to 128 characters.

Example Consumer object

UK
1{
2  "phoneNumber": "07000000000",
3  "givenNames": "Joe",
4  "surname": "Consumer",
5  "email": "test@example.com"
6}