Skip to main content
POST
/
v1
/
swaps
Create
curl --request POST \
  --url https://{defaultHost}/v1/swaps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "swap": {
    "description": "Swap and save 20%!",
    "price": "f47479d6-49ab-4e12-889c-5c5e3ef2d19f",
    "swap_price": "654c0d80-bc8f-4635-9e0c-8de6b46b4987"
  }
}
'
{
  "id": "51e90260-9c7b-45d3-909d-4e4efab52c48",
  "object": "swap",
  "archived": false,
  "archived_at": null,
  "description": "Swap and save 20%!",
  "metadata": {},
  "price": "f47479d6-49ab-4e12-889c-5c5e3ef2d19f",
  "swap_price": "654c0d80-bc8f-4635-9e0c-8de6b46b4987",
  "discarded_at": null,
  "created_at": 1772113062,
  "updated_at": 1772113062
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
swap
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
archived
boolean

Whether or not this swap is archived.

​
description
string | null

A description of this swap. This text will be visibile to customers in the checkout summary when offered the swap.

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

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