---
name: payment-methods-routes
description: Handle 6 OpenAPI operation(s) under /v1/payment_methods for the payment methods route group.
---

# payment methods API Routes

Handle 6 OpenAPI operation(s) under /v1/payment_methods for the payment methods 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_payment_methods

- Operation ID: `get_payment_methods`
- Route: `GET /v1/payment_methods`
- Mode: READ
- Summary: List PaymentMethods
- Parameters:
  - `allow_redisplay` in `query`
  - `customer` in `query`
  - `customer_account` in `query`
  - `ending_before` in `query`
  - `expand` in `query`
  - `limit` in `query`
  - `starting_after` in `query`
  - `type` in `query`
- Body: JSON request body accepted.

### post_payment_methods

- Operation ID: `post_payment_methods`
- Route: `POST /v1/payment_methods`
- Mode: WRITE
- Summary: Shares a PaymentMethod
- Body: JSON request body accepted.

### get_payment_methods_payment_method

- Operation ID: `get_payment_methods_payment_method`
- Route: `GET /v1/payment_methods/{payment_method}`
- Mode: READ
- Summary: Retrieve a PaymentMethod
- Parameters:
  - `expand` in `query`
  - `payment_method` in `path` required
- Body: JSON request body accepted.

### post_payment_methods_payment_method

- Operation ID: `post_payment_methods_payment_method`
- Route: `POST /v1/payment_methods/{payment_method}`
- Mode: WRITE
- Summary: Update a PaymentMethod
- Parameters:
  - `payment_method` in `path` required
- Body: JSON request body accepted.

### post_payment_methods_payment_method_attach

- Operation ID: `post_payment_methods_payment_method_attach`
- Route: `POST /v1/payment_methods/{payment_method}/attach`
- Mode: WRITE
- Summary: Attach a PaymentMethod to a Customer
- Parameters:
  - `payment_method` in `path` required
- Body: JSON request body accepted.

### post_payment_methods_payment_method_detach

- Operation ID: `post_payment_methods_payment_method_detach`
- Route: `POST /v1/payment_methods/{payment_method}/detach`
- Mode: WRITE
- Summary: Detach a PaymentMethod from a Customer
- Parameters:
  - `payment_method` in `path` required
- Body: JSON request body accepted.
