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 Item object
Online APIModels

Item object

Was this page helpful?
Previous

Money object

Next
Built with

Attributes

AttributeTypeDescription
namestring requiredProduct name. Limited to 255 characters.
skustringProduct SKU. Limited to 128 characters.
quantityinteger requiredThe quantity of the item, stored as a signed 32-bit integer.
priceMoney  requiredThe unit price of the individual item. Must be a positive value.

Example Item object

UK
1{
2 "name": "T-Shirt",
3 "sku": "12341234",
4 "quantity": 1,
5 "price": {
6 "amount": "10.00",
7 "currency": "GBP"
8 }
9}