93 lines
2.5 KiB
Markdown
93 lines
2.5 KiB
Markdown
---
|
|
name: setup-intents-routes
|
|
description: Handle 7 OpenAPI operation(s) under /v1/setup_intents for the setup intents route group.
|
|
---
|
|
|
|
# setup intents API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /v1/setup_intents for the setup intents 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_setup_intents
|
|
|
|
- Operation ID: `get_setup_intents`
|
|
- Route: `GET /v1/setup_intents`
|
|
- Mode: READ
|
|
- Summary: List all SetupIntents
|
|
- Parameters:
|
|
- `attach_to_self` in `query`
|
|
- `created` in `query`
|
|
- `customer` in `query`
|
|
- `customer_account` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `payment_method` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_setup_intents
|
|
|
|
- Operation ID: `post_setup_intents`
|
|
- Route: `POST /v1/setup_intents`
|
|
- Mode: WRITE
|
|
- Summary: Create a SetupIntent
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_setup_intents_intent
|
|
|
|
- Operation ID: `get_setup_intents_intent`
|
|
- Route: `GET /v1/setup_intents/{intent}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a SetupIntent
|
|
- Parameters:
|
|
- `client_secret` in `query`
|
|
- `expand` in `query`
|
|
- `intent` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_setup_intents_intent
|
|
|
|
- Operation ID: `post_setup_intents_intent`
|
|
- Route: `POST /v1/setup_intents/{intent}`
|
|
- Mode: WRITE
|
|
- Summary: Update a SetupIntent
|
|
- Parameters:
|
|
- `intent` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_setup_intents_intent_cancel
|
|
|
|
- Operation ID: `post_setup_intents_intent_cancel`
|
|
- Route: `POST /v1/setup_intents/{intent}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: Cancel a SetupIntent
|
|
- Parameters:
|
|
- `intent` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_setup_intents_intent_confirm
|
|
|
|
- Operation ID: `post_setup_intents_intent_confirm`
|
|
- Route: `POST /v1/setup_intents/{intent}/confirm`
|
|
- Mode: WRITE
|
|
- Summary: Confirm a SetupIntent
|
|
- Parameters:
|
|
- `intent` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_setup_intents_intent_verify_microdeposits
|
|
|
|
- Operation ID: `post_setup_intents_intent_verify_microdeposits`
|
|
- Route: `POST /v1/setup_intents/{intent}/verify_microdeposits`
|
|
- Mode: WRITE
|
|
- Summary: Verify microdeposits on a SetupIntent
|
|
- Parameters:
|
|
- `intent` in `path` required
|
|
- Body: JSON request body accepted.
|