Get Hedhog updates in your inbox
New releases, fresh recipes, and breaking changes — no spam.
commerce Submodule
checkout-orders-payments
Public checkout funnel plus administrative order and payment operations.
Source path: libraries/commerce/src/commerce-checkout/commerce-checkout.controller.ts, commerce-orders.controller.ts, commerce-payments.controller.ts
Module file: commerce.module.ts
Introduction
Checkout is the externally facing entrypoint of Commerce. It exposes public plan discovery, guest-auth bootstrap, checkout submission, and live order-status polling/SSE. That public flow then lands in the order and payment surfaces used by operators for lifecycle management.
The controller mix here is intentionally split: checkout endpoints are `@Public()` or `@NoRole()`, while orders and payments stay inside the authenticated admin surface.
HTTP Endpoints
23 endpoints
List public plans available for checkout.
Return checkout gateway configuration.
Authenticate or bootstrap a guest checkout session.
Process checkout for a guest or authenticated user.
Poll order status.
- Params
- orderId (int)
Stream live order status updates.
- Params
- orderId (int)
List current-user checkout orders.
Return the current user document data used during checkout.
Get current-user order details.
- Params
- orderId (int)
List orders.
Get one order.
- Params
- id (int)
Create an order.
Update an order.
- Params
- id (int)
Mark an order as paid.
- Params
- id (int)
Cancel an order.
- Params
- id (int)
Refund an order.
- Params
- id (int)
List order items.
- Params
- id (int)
List payments for an order.
- Params
- id (int)
List entitlements created by an order.
- Params
- id (int)
List payments.
Get one payment.
- Params
- id (int)
Refund a payment.
- Params
- id (int)
Inspect the raw gateway payload of a payment.
- Params
- id (int)