Retrieve a checkout session
Read one of your own open checkout sessions by the `public_id` returned when it was opened: its line items, customer, seller details and expiry. A session is served only while it is open — once paid or past `expires_at` it answers 404, as does an unknown `public_id` or one belonging to another account.
Authorization
ApiKey API key issued to the partner, sent with the Bearer prefix — for example: Authorization: Bearer su_key_9f2c4d1ab3….
Keys minted on the live instance are prefixed su_key_ and keys minted on sandbox su_test_key_. The two instances keep separate key tables and separate hosts, so a sandbox key sent to the live host — or the reverse — answers Invalid API key. rather than falling back to the other environment.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/checkout-sessions/string/"{ "public_id": "string", "line_items": {}, "customer_id": "string", "seller_details": { "id": "string", "phone": "string", "business_logo": "http://example.com", "business_name": "string" }, "return_url": "http://example.com", "expires_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "is_expired": "string"}Open a checkout session POST
Open a checkout session for one or more (up to 10) of your own billing periods. `customer_id` is optional and, if sent with a value, must be a customer already recorded on your account; omit it, or send it null or blank, to have the buyer enter their full name, email, phone and address at checkout. Each item's price is snapshotted at creation, so a plan edited afterwards cannot change what the buyer already saw. If two items resolve to the same product (e.g. via different `pbp_id`s), only the last one is kept. `return_url` is required and is where the buyer lands after paying. Send the returned `checkout_url` to the buyer to collect payment. This is the one rate-limited endpoint on the partner API — 20 sessions a minute per account by default, answered with 429 once exceeded.
List customers GET
Paginated customers of your account, newest first. Page through with `page` and `page_size` (20 per page by default, 100 at most); `next` is null on the last page.