On this page
No Headings
The details for the items to be purchased.
objectnamerequiredstring^[\S\s]*$The item name or title.
unit_amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The item price or rate per unit. If you specify unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.
currency_coderequiredstring^[\S\s]*$The 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.taxobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number.
currency_coderequiredstring^[\S\s]*$The 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.quantityrequiredstring^[1-9][0-9]{0,9}$The item quantity. Must be a whole number.
descriptionstring^[\S\s]*$The detailed item description.
skustring^[\S\s]*$The stock keeping unit (SKU) for the item.
urlstringuriThe URL to the item being purchased. Visible to buyer and used in buyer experiences.
categorystring"DIGITAL_GOODS", "PHYSICAL_GOODS", "DONATION"The item category type.
image_urlstringuriThe URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
upcobjectThe Universal Product Code of the item.
The Universal Product Code of the item.
typerequiredstring"UPC-A", "UPC-B", "UPC-C", "UPC-D", "UPC-E", "UPC-2", "UPC-5"The Universal Product Code type.
coderequiredstring^[0-9]{0,17}$The UPC product code of the item.
billing_planobjectMetadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.
billing_cyclesrequiredarrayAn array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.
itemsobjectThe billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle. The sequence of the billing cycle will be in the following order - free trial billing cycle(s), discounted trial billing cycle(s), regular billing cycle(s).
tenure_typerequiredstring"REGULAR", "TRIAL"The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.
pricing_schemeobjectThe pricing scheme details.
The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.
priceobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The price the customer will be charged based on the pricing model
currency_coderequiredstring^[\S\s]*$The 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.pricing_modelrequiredstring"FIXED", "VARIABLE", "AUTO_RELOAD"The pricing model for the billing cycle.
reload_threshold_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The threshold amount on which the reload charge would be triggered. This will be associated with the account-balance where if the account-balance goes below this amount then customer would incur reload charge.
currency_coderequiredstring^[\S\s]*$The 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.total_cyclesinteger1The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).
sequenceinteger1The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a sequence of 1 while a regular billing cycle has a sequence of 2, so that trial cycle runs before the regular cycle.
start_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The start date for the billing cycle, in YYYY-MM-DD. This field should be not be provided if the billing cycle starts at the time of checkout. When this field is not provided, the billing cycle amount will be included in any data validations confirming that the total provided by the merchant match the sum of individual items due at the time of checkout. Only one billing cycle (with sequence equal to 1) can have a no start date.
setup_feeobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The setup fee for the recurring plan. Ensure its part of the item amount.
currency_coderequiredstring^[\S\s]*$The 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.namestring^[A-Za-z0-9() +',.:-]+$Name of the recurring plan.