On this page
No Headings
Payment resource details.
objectintegration_moderequiredstring"LINK"^[A-Z0-9_]+$Determines how the payment resource is presented to customers. Currently, only LINK is supported, which generates a PayPal-hosted payment page with a shareable URL. This value is immutable after creation.
typerequiredstring"BUY_NOW"^[A-Z0-9_]+$The type of payment resource. Once a payment resource is created, this field cannot be changed.
reusablestring"MULTIPLE"^[A-Z0-9_]+$"MULTIPLE"Indicates if the payment resource can be used multiple times or only once.
return_urlstringuri^.*$URL to which the customer is redirected after completing the transaction.
line_itemsarrayList of individual item in payment resource.
itemsobjectList of individual item in payment resource.
namestring^.*$The product or service name displayed to customers during checkout.
product_idstring^.*$Your internal identifier for this product.
descriptionstring^.*$Detailed information about the product or service shown to customers during checkout. Use this to provide additional context, specifications, or terms.
unit_amountobjectThe price per unit of this item, including the numeric value and currency code.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxesarrayTaxes applied to this item. Tax is displayed separately to customers during checkout.
itemsobjectTaxes applied to this item. Tax is displayed separately to customers during checkout.
namestring^.*$Internal label for this tax (e.g., "Sales Tax", "VAT"). Not visible to customer.
typerequiredstring"PERCENTAGE", "PREFERENCE"^[A-Z0-9_]+$The method used to calculate this tax.
valuerequiredstring^.*$The tax amount or reference. For PERCENTAGE, enter the numeric percentage value (e.g., "10" for 10%). For PREFERENCE, must be set to "PROFILE". Maximum 20 characters.
shippingarrayShipping fee for this item. Shipping fee is displayed separately to customers during checkout.
itemsobjectShipping fee for this item. Shipping fee is displayed separately to customers during checkout.
typerequiredstring"FLAT", "PERCENTAGE", "PREFERENCE"^[A-Z0-9_]+$The method used to calculate shipping costs.
valuerequiredstring^.*$The shipping value or reference. For FLAT, enter the fixed cost (e.g., "5" for $5.00). For PREFERENCE, must be set to "PROFILE".
collect_shipping_addressbooleanPrompts customers for a shipping address during checkout for this item. Set to true for physical goods that require delivery, false for digital goods.
customer_notesarrayLabel for a custom field to collect additional information from customers about this item (e.g., "Engraving text" or "Special instructions"). Can be set as mandatory.
itemsobjectLabel for a custom field to collect additional information from customers about this item (e.g., "Engraving text" or "Special instructions"). Can be set as mandatory.
requiredbooleanWhether this custom field is required for checkout. Set to true to make the field mandatory.
labelstring^.*$The label displayed to customers for this custom input field (e.g., "Enter engraving text" or "Delivery instructions").
variantsobjectProduct variants such as size, color, or material presented to customers during checkout. Each variant (e.g., "Size") can have up to 10 options (e.g., "S", "M", "L", "XL"). Supports up to 5 variants total. One variant can be designated as primary to enable different prices per option.
dimensionsrequiredarrayList of variant dimensions available for this product. Each dimension can have multiple options.
itemsobjectVariant dimension structure with multiple options. Each variant can have multiple options, and only one variant can be marked as primary.
namerequiredstring^.*$The name of the variant dimension (e.g., "Size", "Color").
primaryrequiredbooleanOnly one dimension has primary set to true. Only options in the primary dimension can have unit_amount.
optionsrequiredarrayList of option available.
itemsobjectOption available for the item.
labelrequiredstring^.*$The display label for this option (e.g., "Large").
unit_amountobjectUnit Price of this option, including value and currency code.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.adjustable_quantityobjectAllows customers to change the quantity of this item during checkout.
maximumrequiredintegerThe maximum quantity customers can select. Must be between 1 and 100. Setting this value enables the quantity picker at checkout.