Skip to main content
GET
/
v1
/
swaps
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/swaps/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "4dff9406-0ec2-418e-99ae-d81f53a72d44",
  "object": "swap",
  "archived": false,
  "archived_at": null,
  "description": "Swap this price for another",
  "metadata": {},
  "price": "b0c0b559-10ee-4f02-be7d-f769b803ea17",
  "swap_price": "b666dcf0-c9ae-4575-820c-9c25c35dcff7",
  "discarded_at": null,
  "created_at": 1770234906,
  "updated_at": 1770234906
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

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.