Retrieves a list of checkouts with optional pagination an...

GET/v1/checkouts

Retrieves a list of checkouts with optional pagination and filtering. Use this endpoint to display checkout lists in admin dashboards or customer order history. Supports filtering by customer, organization, state, and sorting. Results are automatically filtered based on the authenticated user's permissions and organization access.

Parameters

Request parameters for this endpoint

Name	Location	Type	Required	Description
offset	query	integer	Optional	Number of items to skip for pagination
limit	query	integer	Optional	Maximum number of items to return per page
customerId	query	string	Optional	Filter checkouts by customer/user ID
id	query	string	Optional	Filter by checkout public ID
organizationId	query	integer	Optional	Filter by single organization ID
organizationIds	query	array	Optional	Filter by multiple organization IDs
state	query	string	Optional	Filter by checkout state
sortBy	query	string	Optional	Field to sort by
sortOrder	query	string	Optional	Sort order: 'asc' or 'desc'

Response Data

Fields returned in the response

Name	Type	Required	Description
arbitraryFees		Optional	Arbitrary fees applied to this checkout
cancelUrl	string	Optional	URL to redirect to when checkout is cancelled
checkoutFlowState	string	Optional	Current state in the checkout flow state machine
checkoutSessionId	string	Required	Stripe checkout session ID for payment processing
createdAt	string (date-time)	Required	Timestamp when the checkout was created
depositInvoiceId	string	Optional	Stripe invoice ID for the deposit payment
depositTimestamp	string	Optional	Timestamp when the deposit was paid
externalOrderId	string	Optional	External order ID from integrated systems
failureUrl	string	Optional	URL to redirect to when checkout fails
id	CheckoutPubId	Required	Public-facing unique identifier for the checkout
insuranceStatus		Required	Status of insurance approval (pending, approved, denied)
lastPaymentError	string	Optional	Last payment error message (if payment failed)
lastPaymentErrorAt	string	Optional	Timestamp of last payment error
lastPaymentErrorCode	string	Optional	Last payment error code (if payment failed)
leaseDocumentId	string	Optional	ID of the lease document in PandaDoc
leaseEndDate	string	Optional	End date of the lease term
leaseStartDate	string	Optional	Start date of the lease term
leaseTermId	LeaseTermId	Optional	-
offtakePartnerId	OftakePartnerId	Required	Offtake partner handling this checkout
paymentFailureCount	integer (int32)	Required	Count of payment failures
pickupLocationId	integer	Optional	ID of the pickup location (if using pickup instead of shipping)
recurringPaymentStatus		Required	Status of recurring payments (pending, active, cancelled)
shippingAddress		Optional	-
state		Required	Current state of the checkout (unpaid, pendingDeposit, waitlisted, deposited, fulfilled)
stripeSubscriptionId	string	Optional	Stripe subscription ID for recurring payments
successUrl	string	Optional	URL to redirect to on successful checkout completion
updatedAt	string (date-time)	Required	Timestamp when the checkout was last updated
checkoutUrl	string	Required	URL to access the checkout page
customerId	UserPubId	Required	Public ID of the customer (resolved from internal customer_id)

GET/v1/checkouts

Request

curl https://api.thesweetspot.com/v1/checkouts \
  -H "Content-Type: application/json" \
  -G -d "offset=0&limit=10&customerId=123&id=id_123&organizationId=123&organizationIds=[123]&state=unpaid&sortBy=created_at&sortOrder=created_at"

Response

[
  {
    "checkoutUrl": null,
    "customerId": null
  }
]