Skip to main content
PATCH
/
v1
/
bumps
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/bumps/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bump": {
    "name": "Matching Socks"
  }
}
'
{
  "id": "40aec02e-5edd-44cb-9821-5bffbc0f3fee",
  "object": "bump",
  "amount_off": null,
  "archived": false,
  "archived_at": null,
  "auto_apply": false,
  "filter_match_type": null,
  "filter_price_ids": [],
  "filter_product_ids": [],
  "metadata": {},
  "name": "Matching Socks",
  "percent_off": null,
  "priority": 5,
  "price": "3a3e6bc7-38b9-4fb6-a9a5-37c001354ed0",
  "discarded_at": null,
  "created_at": 1767909675,
  "updated_at": 1767909675
}

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
​
bump
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
amount_off
integer | null

Amount (in the currency of the price) that will be taken off line items associated with this bump.

​
archived
boolean

Whether or not this bump is archived.

​
auto_apply
boolean

Whether or not this bump should be automatically applied to applicable checkouts. If false, this bump must be manually added to a line_item.

​
filter_match_type
string | null

The matching strategy to use when filtering bumps – can be null or one of all, any, none. If null, the bump will not be filtered and will be applicable to all line items.

​
filter_price_ids
array

The prices to filter this bump by.

​
filter_product_ids
array

The products to filter this bump by.

​
name
string | null

A name for this bump that will be visible to customers.

​
percent_off
number | null

Percent that will be taken off line items associated with this bump.

​
priority
integer

The priority of this bump in relation to other bumps. Must be in the range of 1 - 5 with 5 being the highest priority and 1 being the lowest.

​
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.

​
archived_at
integer | null

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

​
price

Expandable – The associated price ID.

​
discarded_at
integer | null

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

​
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.