​

Search Checkout Sessions

​

Endpoint

• Endpoint: GET /v1/checkout/search
• Description: Search for checkout sessions using query parameters.
• Query Parameters:
  • status (string, optional): Filter by checkout session status (e.g., “completed”, “pending”).
  • start_date (string, optional): The start date for the search range (ISO 8601 format).
  • end_date (string, optional): The end date for the search range (ISO 8601 format).
  • customer_id (string, optional): Filter by customer ID.
• Response:
  Copy

  {
    "data": [
      {
        "id": "cs_test_123",
        "amount": 1000,
        "currency": "usd",
        "status": "completed",
        "created_at": "2024-01-01T12:00:00Z",
        "customer_id": "cus_456"
      },
      {
        "id": "cs_test_124",
        "amount": 2000,
        "currency": "usd",
        "status": "pending",
        "created_at": "2024-01-02T15:30:00Z",
        "customer_id": "cus_789"
      }
    ],
    "total_count": 2
  }
  

​

Parameters

• status (string, optional): Filter by checkout session status (e.g., “completed”, “pending”).
• start_date (string, optional): The start date for the search range (ISO 8601 format).
• end_date (string, optional): The end date for the search range (ISO 8601 format).
• customer_id (string, optional): Filter by customer ID.

​

Example Request

curl -X GET "https://api.example.com/v1/checkout/search?status=completed&start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Example Response

{
  "data": [
    {
      "id": "cs_test_123",
      "amount": 1000,
      "currency": "usd",
      "status": "completed",
      "created_at": "2024-01-01T12:00:00Z",
      "customer_id": "cus_456"
    },
    {
      "id": "cs_test_124",
      "amount": 2000,
      "currency": "usd",
      "status": "pending",
      "created_at": "2024-01-02T15:30:00Z",
      "customer_id": "cus_789"
    }
  ],
  "total_count": 2
}

​

Notes

• You can combine multiple query parameters to refine your search results.
• The response includes a list of checkout sessions that match the search criteria along with the total count.

​

Errors

• 400 Bad Request: Invalid query parameters.
• 401 Unauthorized: Invalid or missing API key.

​

See Also

• Create a Checkout Session
• Retrieve a Checkout Session
• Refund a Checkout Session