Skip to main content
POST
/
v1
/
upsells
Create
curl --request POST \
  --url https://{defaultHost}/v1/upsells \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "upsell": {
    "fee_description": "Awesome Upsell",
    "step": "declined",
    "amount_off": 500,
    "price": "7e041dbc-2195-4969-a91b-8cce404bf5f8",
    "upsell_funnel": "fe4485f9-e022-4378-bcc4-251a3f0e1e72"
  }
}
'
{
  "id": "1d599ff3-0f71-4e21-8f25-984c39d542bd",
  "object": "upsell",
  "amount_off": 500,
  "duplicate_purchase_behavior": "allow",
  "fee_description": "Awesome Upsell",
  "metadata": {},
  "percent_off": null,
  "replacement_behavior": "none",
  "step": "declined",
  "price": "7e041dbc-2195-4969-a91b-8cce404bf5f8",
  "upsell_funnel": "fe4485f9-e022-4378-bcc4-251a3f0e1e72",
  "discarded_at": null,
  "created_at": 1767909786,
  "updated_at": 1767909786
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
upsell
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 upsell.

​
duplicate_purchase_behavior
string

How to handle duplicate purchases of the product – can be one of allow, block_within_checkout, or block.

​
fee_description
string

The description for this upsell which will be visible to customers.

​
percent_off
number | null

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

​
replacement_behavior
string

Whether or not to replace line items in the associated checkout. Replacement occurs when a line item is upsold. Possible values include:

  • none (default): No line items will be replaced.
  • all: All line items will be replaced.
​
step
string

Where this upsell falls in position within the upsell funnel – can be one of initial, accepted, or declined.

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

​
price

Expandable – The associated price ID.

​
upsell_funnel

Expandable – The associated upsell funnel 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.