[deprecated] ShippingOption

NOTE: This field is now deprecated. Please use FulfillmentOption instead.

Use an object based on ShippingOption to represent each shipping option that appears in the payment sheet when the customer interacts with Meta Pay.

When PaymentShippingType is PICKUP, use ShippingOption to pass in pickup location.

ShippingOption provides data for PaymentDetails.

Properties

PropertyTypeDescriptionRequired

amount

PaymentCurrencyAmount

The cost of the shipping option. amount is required even when the cost is zero.

Yes

id

string

The unique identifier for the shipping option.

Yes

label

string

Information about the shipping option that appears to the customer.

Yes

secondaryLabel

string

Additional information about the shipping option that appears to the customer.

No

selected

boolean

When true this option should appear selected in the user interface unless the customer changes it.

No