Checkout Sessions
List Checkout Sessions
Checkout Sessions
List Checkout Sessions
Returns a collection of Checkout Sessions, based on the supplied filters. By default, results are returned 10 objects at a time.
GET
/
v2
/
checkout_sessions
Header
Query
curl --request GET \
--url https://api.whop.com/api/v2/checkout_sessions{
"data": [
{
"affiliate_code": "<string>",
"id": "<string>",
"metadata": {},
"plan_id": "<string>",
"purchase_url": "<string>",
"redirect_url": "<string>"
}
],
"pagination": {
"current_page": 123,
"total_count": 123,
"total_page": 123
}
}Headers
Authorization
string
Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************
Query Parameters
plan_id
string
The ID of the plan that the checkout session is associated with, which will look like plan_*************
page
integer
default: 1The page number to retrieve
per
integer
default: 10The number of resources to return per page. There is a limit of 50 results per page.
Response
200 - application/json
data
object[]
pagination
object
Pagination model
Was this page helpful?
curl --request GET \
--url https://api.whop.com/api/v2/checkout_sessions{
"data": [
{
"affiliate_code": "<string>",
"id": "<string>",
"metadata": {},
"plan_id": "<string>",
"purchase_url": "<string>",
"redirect_url": "<string>"
}
],
"pagination": {
"current_page": 123,
"total_count": 123,
"total_page": 123
}
}