Checkout Sessions
Get checkout session
Gets details about a current Checkout Session.
GET
/checkout/sessions/{checkout_session_id}
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/checkout/sessions/{checkout_session_id} \
--header 'Authorization: <authorization>'
{
"cart_items": [
{
"categories": [
"string"
],
"discount_amount": "0",
"external_identifier": "item-789123",
"image_url": "https://example.com/images/items/gopro.png",
"name": "GoPro HERO9 Camcorder",
"product_type": "physical",
"product_url": "https://example.com/items/gopro",
"quantity": "1",
"sku": "sku-789123",
"tax_amount": "0",
"unit_amount": "37999"
}
],
"expires_at": "2022-01-01T00:00:00+00:00",
"id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
"metadata": {
"key": "value"
},
"type": "checkout-session"
}
This endpoint requires the checkout-sessions.read
scope.
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
checkout_session_idrequired
string
The unique ID for a Checkout Session.
Response
200 - application/json
cart_items
object[] | null
An array of cart items that represents the line items of a transaction.
expires_at
string
The date and time when the Checkout Session will expire. By default this will be set to 1 hour from the date of creation.
id
string
The ID of the Checkout Session.
metadata
object | null
Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.
type
enum<string>
checkout-session
.
Available options:
checkout-session
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/checkout/sessions/{checkout_session_id} \
--header 'Authorization: <authorization>'
{
"cart_items": [
{
"categories": [
"string"
],
"discount_amount": "0",
"external_identifier": "item-789123",
"image_url": "https://example.com/images/items/gopro.png",
"name": "GoPro HERO9 Camcorder",
"product_type": "physical",
"product_url": "https://example.com/items/gopro",
"quantity": "1",
"sku": "sku-789123",
"tax_amount": "0",
"unit_amount": "37999"
}
],
"expires_at": "2022-01-01T00:00:00+00:00",
"id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
"metadata": {
"key": "value"
},
"type": "checkout-session"
}