77 lines
1.8 KiB
Markdown
77 lines
1.8 KiB
Markdown
---
|
|
name: prices-routes
|
|
description: Handle 5 OpenAPI operation(s) under /v1/prices for the prices route group.
|
|
---
|
|
|
|
# prices API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /v1/prices for the prices 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_prices
|
|
|
|
- Operation ID: `get_prices`
|
|
- Route: `GET /v1/prices`
|
|
- Mode: READ
|
|
- Summary: List all prices
|
|
- Parameters:
|
|
- `active` in `query`
|
|
- `created` in `query`
|
|
- `currency` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `lookup_keys` in `query`
|
|
- `product` in `query`
|
|
- `recurring` in `query`
|
|
- `starting_after` in `query`
|
|
- `type` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_prices
|
|
|
|
- Operation ID: `post_prices`
|
|
- Route: `POST /v1/prices`
|
|
- Mode: WRITE
|
|
- Summary: Create a price
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_prices_search
|
|
|
|
- Operation ID: `get_prices_search`
|
|
- Route: `GET /v1/prices/search`
|
|
- Mode: READ
|
|
- Summary: Search prices
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `page` in `query`
|
|
- `query` in `query` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_prices_price
|
|
|
|
- Operation ID: `get_prices_price`
|
|
- Route: `GET /v1/prices/{price}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a price
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `price` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_prices_price
|
|
|
|
- Operation ID: `post_prices_price`
|
|
- Route: `POST /v1/prices/{price}`
|
|
- Mode: WRITE
|
|
- Summary: Update a price
|
|
- Parameters:
|
|
- `price` in `path` required
|
|
- Body: JSON request body accepted.
|