Item

November 13, 2025 ยท View on GitHub

The details for the items to be purchased.

Structure

Item

Fields

NameTypeTagsDescriptionGetterSetter
NameStringRequiredThe item name or title.

Constraints: Minimum Length: 1, Maximum Length: 127
String getName()setName(String name)
UnitAmountMoneyRequiredThe currency and amount for a financial transaction, such as a balance or payment due.Money getUnitAmount()setUnitAmount(Money unitAmount)
TaxMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getTax()setTax(Money tax)
QuantityStringRequiredThe item quantity. Must be a whole number.

Constraints: Maximum Length: 10, Pattern: ^[1-9][0-9]{0,9}$
String getQuantity()setQuantity(String quantity)
DescriptionStringOptionalThe detailed item description.

Constraints: Maximum Length: 2048
String getDescription()setDescription(String description)
SkuStringOptionalThe stock keeping unit (SKU) for the item.

Constraints: Maximum Length: 127
String getSku()setSku(String sku)
UrlStringOptionalThe URL to the item being purchased. Visible to buyer and used in buyer experiences.

Constraints: Minimum Length: 1, Maximum Length: 2048
String getUrl()setUrl(String url)
CategoryItemCategoryOptionalThe item category type.

Constraints: Minimum Length: 1, Maximum Length: 20
ItemCategory getCategory()setCategory(ItemCategory category)
ImageUrlStringOptionalThe URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.

Constraints: Minimum Length: 1, Maximum Length: 2048, Pattern: ^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpeg|JPG|GIF|PNG|JPEG)(\?.*)?$
String getImageUrl()setImageUrl(String imageUrl)
UpcUniversalProductCodeOptionalThe Universal Product Code of the item.UniversalProductCode getUpc()setUpc(UniversalProductCode upc)
BillingPlanOrderBillingPlanOptionalMetadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.OrderBillingPlan getBillingPlan()setBillingPlan(OrderBillingPlan billingPlan)

Example (as JSON)

{
  "name": "name2",
  "unit_amount": {
    "currency_code": "currency_code2",
    "value": "value8"
  },
  "tax": {
    "currency_code": "currency_code0",
    "value": "value6"
  },
  "quantity": "quantity8",
  "description": "description2",
  "sku": "sku8",
  "url": "url6",
  "category": "DIGITAL_GOODS"
}