Skip to main content

The type that defines the fields for the summary of a purchase order.

Types that use PurchaseOrderSummary

Not used by any types.

Call that uses PurchaseOrderSummary

POST
/checkout_session/{checkoutSessionId}/place_order

Fields

Field
Type
Description
purchaseOrderHref
string
The URI of the purchase order.
purchaseOrderId
string
A unique identifier of the purchase order. When a checkout session completes, a purchase order ID is generated but this does not indicate that the item has been paid for.

Note: If there is a problem with the payment information, the purchase order ID will be returned and the PurchaseOrderPaymentStatusEnum field will return FAILED.
purchaseOrderPaymentStatus
PurchaseOrderPaymentStatusEnum
An enumeration value that indicates the payment status for the purchase order.
warnings
array of ErrorDetailV3
An array of warning messages.