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": "1a351761-c114-4169-b529-1ca260673df0",
    "swap_price": "36ffd9dd-8fc2-44e2-a47a-fa92b8b298a0"
  }
}
'
{
  "id": "10af703d-ab40-40b8-9e9c-dc51a7540c04",
  "object": "swap",
  "archived": false,
  "archived_at": null,
  "description": "Swap and save 20%!",
  "metadata": {},
  "price": "1a351761-c114-4169-b529-1ca260673df0",
  "swap_price": "36ffd9dd-8fc2-44e2-a47a-fa92b8b298a0",
  "discarded_at": null,
  "created_at": 1773903608,
  "updated_at": 1773903608
}

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.