Lists checkouts with optional filtering by customer, orga...

GET/v1/checkouts

Lists checkouts with optional filtering by customer, organization, and state.

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
userId	query	string	Optional	Filter checkouts by user public ID (usr_xxx format)
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
lifecycle	query	string	Optional	Filter by lifecycle state (single state)
lifecycles	query	string	Optional	Filter by multiple lifecycle states (comma-separated, e.g. "orderConfirmed,leaseActive")
waitlistReason	query	string	Optional	Filter by waitlist reason (inventory or location)
sortBy	query	string	Optional	Field to sort by
sortOrder	query	string	Optional	Sort order: 'asc' or 'desc'
externalOrderId	query	string	Optional	Filter by external order ID

Response Data

Fields returned in the response

Always Present

Name	Type	Description
createdAt	string (date-time)	-
id	CheckoutPubId	Public-facing unique identifier for the checkout
insuranceStatus		Status of insurance approval (pending, approved, denied)
lifecycle		Current lifecycle state of the checkout
offtakePartnerId	OftakePartnerId	-
recurringPaymentStatus		Status of recurring payments (pending, active, cancelled)
updatedAt	string (date-time)	-
checkoutUrl	string	URL to access the checkout page
customerId	UserPubId	Public ID of the customer (resolved from internal customer_id)
progress		Unified progress information for the checkout flow Includes milestones with timestamps for post-confirmation checkouts

Optional

Name	Type	Description
billingAddress		-
billingAddressLocked	boolean	Whether the billing address is locked (set by organization, cannot be changed by customer)
cancelUrl	string	URL to redirect to when checkout is cancelled
deliveredAt	string	When the items were delivered
depositInvoiceId	string	Stripe invoice ID for the deposit payment
depositPreauthExpiresAt	string	Timestamp when the pre-authorization expires (typically 7 days from authorization)
depositTimestamp	string	Timestamp when the deposit was paid
externalOrderId	string	External order ID from integrated systems
failureUrl	string	URL to redirect to when checkout fails
lastPaymentError	string	Last payment error message (if payment failed)
lastPaymentErrorAt	string	Timestamp of last payment error
lastPaymentErrorCode	string	Last payment error code (if payment failed)
leaseDocumentId	string	ID of the lease document in PandaDoc
leaseEndDate	string	-
leaseStartDate	string	-
leaseTermId	LeaseTermId	-
paymentFailureCount	integer	Count of payment failures
pickupLocationId	integer	ID of the pickup location (if using pickup instead of shipping)
previousLifecycle		-
purchaseItems		Purchase items applied to this checkout
recurringPaymentMethod		-
recurringPaymentMethodId	string	Stripe PaymentMethod ID for recurring payments (may differ from deposit payment method)
returnCancelledAt	string	When a pending return was cancelled
returnCompletedAt	string	When the return was completed
returnInitiatedAt	string	When the return was initiated
returnNotes	string	Additional notes about the return
returnReason	string	Reason for the return
shippedAt	string	When the items were shipped
shippingAddress		-
shippingAddressLocked	boolean	Whether the shipping address is locked (set by organization, cannot be changed by customer)
signedBy	string	Who signed for the delivery
stripeDepositPaymentIntentId	string	Stripe PaymentIntent ID for the deposit pre-authorization
stripeSubscriptionId	string	Stripe subscription ID for recurring payments
successUrl	string	URL to redirect to on successful checkout completion
trackingCarrier		-
trackingNumber	string	Tracking number for shipped items
trackingStatus		-
waitlistLocationAddress		-
waitlistLocationReasonCode		-
waitlistReason		-
locationMessage	string	Location waitlist message (machine-readable) when waitlisted by location
organizationId	OrganizationPubId	-

GET/v1/checkouts

Request

curl https://api.thesweetspot.com/v1/checkouts \
  -H "Content-Type: application/json" \
  -G -d "offset=0&limit=10&userId=id_123&id=id_123&organizationId=123&organizationIds=[123]&lifecycle=created&lifecycles=string&waitlistReason=inventory&sortBy=created_at&sortOrder=created_at&externalOrderId=id_123"

Response

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