Skip to main content

A type that defines which add-on services are selected for an item. This type is used by updateAddonServicesStatus to add an add-on service to an order line item.

Type that uses AddonServiceInput

UpdateAddonServicesRequest

Call that uses AddonServiceInput

POST
/checkout_session/{checkoutSessionId}/update_add_on_services_status

Fields

Field
Type
Description
selected
boolean
This field is used to add or remove an add-on service for an order line item. Set the field value to true to add a service or false to remove it.
serviceId
string
The unique identifier of the add-on service.

This value appears in the response field lineitems.addonServices.serviceId of the getCheckoutSession method.