70 lines
1.6 KiB
Markdown
70 lines
1.6 KiB
Markdown
---
|
|
name: plans-routes
|
|
description: Handle 5 OpenAPI operation(s) under /v1/plans for the plans route group.
|
|
---
|
|
|
|
# plans API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /v1/plans for the plans 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_plans
|
|
|
|
- Operation ID: `get_plans`
|
|
- Route: `GET /v1/plans`
|
|
- Mode: READ
|
|
- Summary: List all plans
|
|
- Parameters:
|
|
- `active` in `query`
|
|
- `created` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `product` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_plans
|
|
|
|
- Operation ID: `post_plans`
|
|
- Route: `POST /v1/plans`
|
|
- Mode: WRITE
|
|
- Summary: Create a plan
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_plans_plan
|
|
|
|
- Operation ID: `delete_plans_plan`
|
|
- Route: `DELETE /v1/plans/{plan}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a plan
|
|
- Parameters:
|
|
- `plan` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_plans_plan
|
|
|
|
- Operation ID: `get_plans_plan`
|
|
- Route: `GET /v1/plans/{plan}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a plan
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `plan` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_plans_plan
|
|
|
|
- Operation ID: `post_plans_plan`
|
|
- Route: `POST /v1/plans/{plan}`
|
|
- Mode: WRITE
|
|
- Summary: Update a plan
|
|
- Parameters:
|
|
- `plan` in `path` required
|
|
- Body: JSON request body accepted.
|