Skip to main content
GET
/
v1
/
upsells
List
curl --request GET \
  --url https://{defaultHost}/v1/upsells \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/upsells"
  },
  "data": [
    {
      "id": "beaecb37-2075-4e5a-9e37-7bb2fbaab34f",
      "object": "upsell",
      "amount_off": 500,
      "duplicate_purchase_behavior": "allow",
      "fee_description": "Upsell Offer",
      "metadata": {},
      "percent_off": null,
      "replacement_behavior": "none",
      "step": "initial",
      "price": "bab2b5a5-a8cb-4b77-a011-92031d3bdc42",
      "upsell_funnel": "13e198fb-7143-4aeb-9798-5ac6f6fdeefb",
      "discarded_at": null,
      "created_at": 1780925672,
      "updated_at": 1780925672
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
product_ids[]
string[]

Only return objects that belong to the given products.

​
upsell_funnel_ids[]
string[]

Only return objects that belong to the given upsell funnels.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.