67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
---
|
|
name: billing-portal-routes
|
|
description: Handle 5 OpenAPI operation(s) under /v1/billing_portal for the billing portal route group.
|
|
---
|
|
|
|
# billing portal API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /v1/billing_portal for the billing portal 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_billing_portal_configurations
|
|
|
|
- Operation ID: `get_billing_portal_configurations`
|
|
- Route: `GET /v1/billing_portal/configurations`
|
|
- Mode: READ
|
|
- Summary: List portal configurations
|
|
- Parameters:
|
|
- `active` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `is_default` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_billing_portal_configurations
|
|
|
|
- Operation ID: `post_billing_portal_configurations`
|
|
- Route: `POST /v1/billing_portal/configurations`
|
|
- Mode: WRITE
|
|
- Summary: Create a portal configuration
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_billing_portal_configurations_configuration
|
|
|
|
- Operation ID: `get_billing_portal_configurations_configuration`
|
|
- Route: `GET /v1/billing_portal/configurations/{configuration}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a portal configuration
|
|
- Parameters:
|
|
- `configuration` in `path` required
|
|
- `expand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_billing_portal_configurations_configuration
|
|
|
|
- Operation ID: `post_billing_portal_configurations_configuration`
|
|
- Route: `POST /v1/billing_portal/configurations/{configuration}`
|
|
- Mode: WRITE
|
|
- Summary: Update a portal configuration
|
|
- Parameters:
|
|
- `configuration` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_billing_portal_sessions
|
|
|
|
- Operation ID: `post_billing_portal_sessions`
|
|
- Route: `POST /v1/billing_portal/sessions`
|
|
- Mode: WRITE
|
|
- Summary: Create a portal session
|
|
- Body: JSON request body accepted.
|