--- agentTools: projectIndex: https://apidocs.tryspeed.com/llms.txt --- # Retrieve a checkout session Retrieve a checkout session and all associated data. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Production", "version": "1.0" }, "servers": [ { "url": "https://api.tryspeed.com" } ], "components": { "securitySchemes": { "sec0": { "type": "http", "scheme": "basic" } } }, "security": [ { "sec0": [] } ], "paths": { "/checkout-sessions/{id}": { "get": { "summary": "Retrieve a checkout session", "description": "Retrieve a checkout session and all associated data.", "operationId": "checkout-session-retrieve", "parameters": [ { "name": "id", "in": "path", "description": "Please specify the id of the checkout session.", "schema": { "type": "string" }, "required": true }, { "name": "speed-version", "in": "header", "description": "In this parameter, you can specify the version you want. As of now, there are two versions (2022-04-15 and 2022-10-15). Version 2022-10-15 supports on-chain, lightning, Ethereum, Solana and Tron payment methods. Whereas the 2022-04-15 version only supports lightning payments.", "schema": { "type": "string", "enum": [ "2022-04-15", "2022-10-15" ], "default": "2022-10-15" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"cs_live_xxxxxxxxxx\",\n \"object\": \"checkout_session\",\n \"livemode\": false,\n \"status\": \"paid\",\n \"default_url\": \"https://checkout.tryspeed.com/pay/cs_live_xxxxxxxxxx\",\n \"currency\": \"SATS\",\n \"amount\": 100.0000000000000000,\n \"ttl\": 300,\n \"type\": \"fixed\",\n \"statement_descriptor\": \"cancel url test\",\n \"amount_paid\": 100.0000000000000000,\n \"target_amount_paid\": 100.0000000000000000,\n \"exchange_rate\": 1.0000000000000000,\n \"expires_at\": 1697607347779,\n \"payments\": [\n {\n \"id\": \"pi_xxxxxxxxxxxxxxx\",\n \"object\": \"payment\",\n \"amount_paid\": 100.0000000000000000,\n \"exchange_rate\": 1.0000000000000000,\n \"target_amount_paid\": 100,\n \"target_currency\": \"SATS\",\n \"created\": 1697607047942,\n \"modified\": 1697607324357\n }\n ],\n \"api_version\": \"2022-10-15\",\n \"metadata\": {},\n \"amount_paid_tolerance\": 5.00,\n \"customer_collections_status\": {\n \"is_phone_enabled\": true,\n \"is_email_enabled\": true,\n \"is_billing_address_enabled\": true,\n \"is_shipping_address_enabled\": false\n },\n \"customer_collections\": {\n \"email\": \"john@tryspeed.com\",\n \"phone\": \"+1 848946115\",\n \"billing_address\": {\n \"name\": \"Harsh Varelani\",\n \"line1\": \"jhfbsbfbh\",\n \"city\": \"Admd\",\n \"state\": \"gujarat\",\n \"postal_code\": \"380001\",\n \"country\": \"India\"\n }\n },\n \"transfers\": [\n {\n \"destination_account\": \"acct_l3ilfv16072plbCx\",\n \"percentage\": 50.0,\n \"description\": \"tr-1\"\n },\n {\n \"destination_account\": \"acct_l620o8glCOKS35cS\",\n \"percentage\": 50.0,\n \"description\": \"tr-1\"\n }\n ],\n \"custom_fields\": [\n {\n \"id\": \"cscf_xxxxxxxxxxxxxx\",\n \"type\": \"dropdown\",\n \"label\": \"state\",\n \"value\": \"Texas\",\n \"options\": [\n \"California\",\n \"Texas\",\n \"Florida\"\n ],\n \"is_optional\": false\n },\n {\n \"id\": \"cscf_xxxxxxxxxxxxxx\",\n \"type\": \"number\",\n \"label\": \"zip code\",\n \"value\": \"11111\",\n \"is_optional\": false\n },\n {\n \"id\": \"cscf_xxxxxxxxxxxxxx\",\n \"type\": \"text\",\n \"label\": \"Will you by our product again?\",\n \"is_optional\": true\n }\n ],\n \"created\": 1697606132081,\n \"modified\": 1697607324394\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "cs_live_xxxxxxxxxx" }, "object": { "type": "string", "example": "checkout_session" }, "livemode": { "type": "boolean", "example": false, "default": true }, "status": { "type": "string", "example": "paid" }, "default_url": { "type": "string", "example": "https://checkout.tryspeed.com/pay/cs_live_xxxxxxxxxx" }, "currency": { "type": "string", "example": "SATS" }, "amount": { "type": "integer", "example": 100, "default": 0 }, "ttl": { "type": "integer", "example": 300, "default": 0 }, "type": { "type": "string", "example": "fixed" }, "statement_descriptor": { "type": "string", "example": "cancel url test" }, "amount_paid": { "type": "integer", "example": 100, "default": 0 }, "target_amount_paid": { "type": "integer", "example": 100, "default": 0 }, "exchange_rate": { "type": "integer", "example": 1, "default": 0 }, "expires_at": { "type": "integer", "example": 1697607347779, "default": 0 }, "payments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "pi_xxxxxxxxxxxxxxx" }, "object": { "type": "string", "example": "payment" }, "amount_paid": { "type": "integer", "example": 100, "default": 0 }, "exchange_rate": { "type": "integer", "example": 1, "default": 0 }, "target_amount_paid": { "type": "integer", "example": 100, "default": 0 }, "target_currency": { "type": "string", "example": "SATS" }, "created": { "type": "integer", "example": 1697607047942, "default": 0 }, "modified": { "type": "integer", "example": 1697607324357, "default": 0 } } } }, "api_version": { "type": "string", "example": "2022-10-15" }, "metadata": { "type": "object", "properties": {} }, "amount_paid_tolerance": { "type": "integer", "example": 5, "default": 0 }, "customer_collections_status": { "type": "object", "properties": { "is_phone_enabled": { "type": "boolean", "example": true, "default": true }, "is_email_enabled": { "type": "boolean", "example": true, "default": true }, "is_billing_address_enabled": { "type": "boolean", "example": true, "default": true }, "is_shipping_address_enabled": { "type": "boolean", "example": false, "default": true } } }, "customer_collections": { "type": "object", "properties": { "email": { "type": "string", "example": "john@tryspeed.com" }, "phone": { "type": "string", "example": "+1 848946115" }, "billing_address": { "type": "object", "properties": { "name": { "type": "string", "example": "Harsh Varelani" }, "line1": { "type": "string", "example": "jhfbsbfbh" }, "city": { "type": "string", "example": "Admd" }, "state": { "type": "string", "example": "gujarat" }, "postal_code": { "type": "string", "example": "380001" }, "country": { "type": "string", "example": "India" } } } } }, "transfers": { "type": "array", "items": { "type": "object", "properties": { "destination_account": { "type": "string", "example": "acct_l3ilfv16072plbCx" }, "percentage": { "type": "integer", "example": 50, "default": 0 }, "description": { "type": "string", "example": "tr-1" } } } }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "cscf_xxxxxxxxxxxxxx" }, "type": { "type": "string", "example": "dropdown" }, "label": { "type": "string", "example": "state" }, "value": { "type": "string", "example": "Texas" }, "options": { "type": "array", "items": { "type": "string", "example": "California" } }, "is_optional": { "type": "boolean", "example": false, "default": true } } } }, "created": { "type": "integer", "example": 1697606132081, "default": 0 }, "modified": { "type": "integer", "example": 1697607324394, "default": 0 } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "62566254992a5a04f794e4de:652f6947e36f060024bacdbe" } ```