Item Request

The details for the items to be purchased.

Structure

ItemRequest

Fields

Name	Type	Tags	Description	Getter	Setter
Name	String	Required	The item name or title. Constraints: Minimum Length: 1, Maximum Length: 127	String getName()	setName(String name)
UnitAmount	Money	Required	The currency and amount for a financial transaction, such as a balance or payment due.	Money getUnitAmount()	setUnitAmount(Money unitAmount)
Tax	Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	Money getTax()	setTax(Money tax)
Quantity	String	Required	The item quantity. Must be a whole number. Constraints: Maximum Length: 10, Pattern: ^[1-9][0-9]{0,9}$	String getQuantity()	setQuantity(String quantity)
Description	String	Optional	This field supports up to 4000 characters, but any content beyond 2048 characters (including spaces) will be truncated. The 2048 character limit is reflected in the response representation of this field. Constraints: Maximum Length: 4000	String getDescription()	setDescription(String description)
Sku	String	Optional	The stock keeping unit (SKU) for the item. Constraints: Maximum Length: 127	String getSku()	setSku(String sku)
Url	String	Optional	The 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)
Category	ItemCategory	Optional	The item category type. Constraints: Minimum Length: 1, Maximum Length: 20	ItemCategory getCategory()	setCategory(ItemCategory category)
ImageUrl	String	Optional	The 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)
Upc	UniversalProductCode	Optional	The Universal Product Code of the item.	UniversalProductCode getUpc()	setUpc(UniversalProductCode upc)
BillingPlan	OrderBillingPlan	Optional	Metadata 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": "name0",
  "unit_amount": {
    "currency_code": "currency_code2",
    "value": "value8"
  },
  "tax": {
    "currency_code": "currency_code0",
    "value": "value6"
  },
  "quantity": "quantity6",
  "description": "description0",
  "sku": "sku6",
  "url": "url4",
  "category": "DIGITAL_GOODS"
}