The purchase unit details. Used to capture required information for the payment contract.
reference_idstringOptionalNote: If there are multiple purchase units, reference_id is required for each purchase unit.amountobject<amount_with_breakdown>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredbreakdownobject<amount_breakdown>Optionalitem_totalobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredshippingobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredhandlingobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtax_totalobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredinsuranceobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredshipping_discountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequireddiscountobject<discount_with_breakdown>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredpayeeobject<payee>Optionalemail_addressstring<email>OptionalNote: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
merchant_idstring<account_id>Optionalpayment_instructionobject<payment_instruction>Optionalplatform_feesobject<platform_fee>[]Optionalamountobject<money>Requiredcurrency_codestring<currency_code>RequiredvaluestringRequiredpayeeobject<payee_base>Optionalemail_addressstring<email>OptionalNote: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
merchant_idstring<account_id>Optionaldisbursement_modeenum<disbursement_mode>Optionalpayee_pricing_tier_idstringOptionalidstringOptionalv2/checkout/orders/id/save.soft_descriptorstringOptional22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters.itemsobject<item>[]Optionalunit_amountobject<money>Requiredcurrency_codestring<currency_code>RequiredvaluestringRequiredtaxobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredcategoryenumOptionalupcobject<universal_product_code>Optionalbilling_planobject<order_billing_plan>Optionalbilling_cyclesobject<billing_cycle>[]Requiredtenure_typeenumRequiredpricing_schemeobject<pricing_scheme>Optionalpriceobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredpricing_modelenumRequiredreload_threshold_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtotal_cyclesintegerOptional1 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).start_datestring<date_no_time>Optionalsetup_feeobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredshippingobject<shipping_with_tracking_details>Optionalnameobject<name>Optionalemail_addressstring<email_address>OptionalNote: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
phone_numberobject<phone_with_national_required_and_country_code>Optionalcountry_codestring<country_calling_code>Optionalnational_numberstringRequiredtypeenumOptionaloptionsobject<shipping_option>[]OptionallabelstringRequiredtypeenum<shipping_type>Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredselectedbooleanRequiredaddressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_detailsobject<Address Details>Optionalstatusenum<tracker_status>Optionalitemsobject<tracker_item>[]Optionallinksobject<link_description-2>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptionalschemaobject<link_schema-2>OptionaltargetSchemaobject<link_schema-2>Optionalcreate_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
update_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
supplementary_dataobject<supplementary_data>Optionalcardobject<card_supplementary_data>Optionallevel_2object<level_2_card_processing_data>Optionalinvoice_idstringOptionaltax_totalobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredlevel_3object<level_3_card_processing_data>Optionalshipping_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredduty_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequireddiscount_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredshipping_addressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_detailsobject<Address Details>Optionalline_itemsobject<line_item>[]Optionalupcobject<universal_product_code>Optionalbilling_planobject<order_billing_plan>Optionalbilling_cyclesobject<billing_cycle>[]Requiredtenure_typeenumRequiredpricing_schemeobject<pricing_scheme>Optionalpriceobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredpricing_modelenumRequiredreload_threshold_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtotal_cyclesintegerOptional1 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).start_datestring<date_no_time>Optionalsetup_feeobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredunit_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtaxobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredcommodity_codestringOptionaldiscount_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtotal_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredunit_of_measurestringOptionalriskobject<risk_supplementary_data>Optionalcustomerobject<participant_metadata>Optionalip_addressstring<ip_address>Optionalpaymentsobject<payment_collection>Optionalcapturesobject<capture>[]OptionalstatusenumOptionalstatus.details.status_detailsobject<capture_status_details>OptionalreasonenumOptionalamountobject<amount_with_breakdown>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredbreakdownobject<amount_breakdown>Optionalitem_totalobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredshippingobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredhandlingobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtax_totalobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredinsuranceobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredshipping_discountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequireddiscountobject<discount_with_breakdown>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequirednetwork_transaction_referenceobject<network_transaction>OptionalidstringOptionaldatestringOptionalnetworkenum<card_brand>Optionalseller_protectionobject<seller_protection>OptionalstatusenumOptionalfinal_capturebooleanOptionalseller_receivable_breakdownobject<seller_receivable_breakdown>Optionalgross_amountobject<money>Requiredcurrency_codestring<currency_code>RequiredvaluestringRequiredpaypal_feeobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredpaypal_fee_in_receivable_currencyobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequirednet_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredreceivable_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredexchange_rateobject<exchange_rate>Optionalsource_currencystring<currency_code>Optionaltarget_currencystring<currency_code>Optionalplatform_feesobject<platform_fee>[]Optionalamountobject<money>Requiredcurrency_codestring<currency_code>RequiredvaluestringRequiredpayeeobject<payee_base>Optionalemail_addressstring<email>OptionalNote: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
merchant_idstring<account_id>Optionaldisbursement_modeenum<disbursement_mode>Optionallinksobject<link_description-2>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptionalschemaobject<link_schema-2>OptionaltargetSchemaobject<link_schema-2>Optionalprocessor_responseobject<processor_response>Optionalavs_codeenumOptionalcvv_codeenumOptionalresponse_codeenumOptionalpayment_advice_codeenumOptionalcreate_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
update_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
refundsobject<refund>[]Optionalstatus_detailsobject<refund_status_details>Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredgross_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredpaypal_feeobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredpaypal_fee_in_receivable_currencyobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequirednet_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequirednet_amount_in_receivable_currencyobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredplatform_feesobject<platform_fee>[]Optionalamountobject<money>Requiredcurrency_codestring<currency_code>RequiredvaluestringRequiredpayeeobject<payee_base>Optionalemail_addressstring<email>OptionalNote: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
merchant_idstring<account_id>Optionalservice_feesobject<service_fee>[]Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredservice_fee_typeenum<service_fee_type>Optionalnet_amount_breakdownobject<net_amount_breakdown_item>[]Optionalpayable_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredconverted_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredexchange_rateobject<exchange_rate>Optionalsource_currencystring<currency_code>Optionaltarget_currencystring<currency_code>Optionaltotal_refunded_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredpayerobject<payee_base>Optionalemail_addressstring<email>OptionalNote: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
merchant_idstring<account_id>Optionalbuyer_contextobject<buyer_context>Optionaltransaction_create_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
transaction_update_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
linksobject<link_description-2>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptionalschemaobject<link_schema-2>OptionaltargetSchemaobject<link_schema-2>Optionalcreate_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
update_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.