Skip to main content
PATCH
/
v1
/
bundle_items
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/bundle_items/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bundle_item": {
    "quantity": 2
  }
}
'
{
  "id": "abae1276-ec16-4f09-ac33-0a72c49e106e",
  "object": "bundle_item",
  "basis_amount": null,
  "quantity": 2,
  "current_version": true,
  "metadata": {},
  "position": 0,
  "bundle_product": "f283a53a-0a5d-4145-acd5-0c088e6b0ed0",
  "component_product": "c9a25276-bdcf-49f2-a225-86eea89cdf95",
  "created_at": 1780925361,
  "updated_at": 1780925361
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
bundle_item
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
basis_amount
integer | null

Optional relative weighting input (in cents) for this component. Nil uses default weighting by quantity.

​
quantity
integer

The quantity of this component in the bundle.

​
position
integer | null

The position of this item within the bundle.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
bundle_product

Expandable – The associated bundle product ID.

​
component_product

Expandable – The associated component product ID.

​
current_version
boolean

Whether the returned version is the current one on the bundle item.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.