89 lines
2.5 KiB
Markdown
89 lines
2.5 KiB
Markdown
---
|
|
name: checkout-routes
|
|
description: Handle 6 OpenAPI operation(s) under /v1/checkout/sessions for the checkout route group.
|
|
---
|
|
|
|
# checkout API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /v1/checkout/sessions for the checkout route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_checkout_sessions
|
|
|
|
- Operation ID: `get_checkout_sessions`
|
|
- Route: `GET /v1/checkout/sessions`
|
|
- Mode: READ
|
|
- Summary: List all Checkout Sessions
|
|
- Parameters:
|
|
- `created` in `query`
|
|
- `customer` in `query`
|
|
- `customer_account` in `query`
|
|
- `customer_details` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `payment_intent` in `query`
|
|
- `payment_link` in `query`
|
|
- `starting_after` in `query`
|
|
- `status` in `query`
|
|
- `subscription` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_checkout_sessions
|
|
|
|
- Operation ID: `post_checkout_sessions`
|
|
- Route: `POST /v1/checkout/sessions`
|
|
- Mode: WRITE
|
|
- Summary: Create a Checkout Session
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_checkout_sessions_session
|
|
|
|
- Operation ID: `get_checkout_sessions_session`
|
|
- Route: `GET /v1/checkout/sessions/{session}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Checkout Session
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `session` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_checkout_sessions_session
|
|
|
|
- Operation ID: `post_checkout_sessions_session`
|
|
- Route: `POST /v1/checkout/sessions/{session}`
|
|
- Mode: WRITE
|
|
- Summary: Update a Checkout Session
|
|
- Parameters:
|
|
- `session` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_checkout_sessions_session_expire
|
|
|
|
- Operation ID: `post_checkout_sessions_session_expire`
|
|
- Route: `POST /v1/checkout/sessions/{session}/expire`
|
|
- Mode: WRITE
|
|
- Summary: Expire a Checkout Session
|
|
- Parameters:
|
|
- `session` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_checkout_sessions_session_line_items
|
|
|
|
- Operation ID: `get_checkout_sessions_session_line_items`
|
|
- Route: `GET /v1/checkout/sessions/{session}/line_items`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Checkout Session's line items
|
|
- Parameters:
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `session` in `path` required
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|