> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Customer Payment Methods
> ### Intent
Reads the available customer payment methods as a pageable collection without changing them.
### When to call it
Call this when an interface, sync, or support workflow needs to inspect customer payment methods. Use the filters and paging controls shown below to limit the result.
### Access boundary
Authorize the request with a token that carries `customer_portal:read` or `customer_portal:write`.
### Successful result
A successful request returns `200`. The response schema below defines the body your integration receives.
export const RubaSocials = () => {
if (typeof document === "undefined") {
return null;
}
const inject = () => {
const footer = document.getElementById("footer");
if (!footer || document.getElementById("ruba-socials")) {
return false;
}
const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
const lineColor = isDark ? "#383838" : "#e8e8ed";
const iconColor = isDark ? "#8e8e93" : "#86868b";
const markColor = isDark ? "#ffffff" : "#08080c";
const hoverColor = "#0071e3";
const div = document.createElement("div");
div.id = "ruba-socials";
div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
const logo = `Ruba`;
const spacer = ``;
const ig = ``;
const li = ``;
const x = ``;
const github = ``;
div.innerHTML = logo + spacer + ig + li + x + github;
footer.appendChild(div);
return true;
};
if (!document.documentElement.dataset.rubaSocialsObserver) {
document.documentElement.dataset.rubaSocialsObserver = "true";
const observer = new MutationObserver(() => {
if (!document.getElementById("ruba-socials")) {
inject();
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
}
setTimeout(() => {
if (!inject()) {
const interval = setInterval(() => {
if (inject()) {
clearInterval(interval);
}
}, 500);
setTimeout(() => clearInterval(interval), 10000);
}
}, 300);
return null;
};
To set a new default payment method, send a request to the [`PATCH /v1/customer-portal/customers/me`](/api-reference/customer-portal/update-customer) endpoint and pass the preferred `default_payment_method_id`.
## OpenAPI
````yaml get /v1/customer-portal/customers/me/payment-methods
openapi: 3.1.0
info:
title: Ruba API
summary: Ruba HTTP and Webhooks API
description: '**Details:** Read the docs at https://docs.getruba.com/api-reference.'
version: 2026-04
servers:
- url: https://api.getruba.com
description: '**Details:** Production environment.'
x-speakeasy-server-id: production
- url: https://sandbox-api.getruba.com
description: '**Details:** Sandbox environment.'
x-speakeasy-server-id: sandbox
security: []
tags:
- name: public
description: >-
**Details:** Endpoints shown and documented in the Ruba API documentation
and available in our SDKs.
- name: private
description: >-
**Details:** Endpoints that should appear in the schema only in
development to generate our internal JS SDK.
paths:
/v1/customer-portal/customers/me/payment-methods:
get:
tags:
- customer_portal
- customers
- public
summary: List Customer Payment Methods
description: >-
### Intent
Reads the available customer payment methods as a pageable collection
without changing them.
### When to call it
Call this when an interface, sync, or support workflow needs to inspect
customer payment methods. Use the filters and paging controls shown
below to limit the result.
### Access boundary
Authorize the request with a token that carries `customer_portal:read`
or `customer_portal:write`.
### Successful result
A successful request returns `200`. The response schema below defines
the body your integration receives.
operationId: customer_portal:customers:list_payment_methods
parameters:
- name: page
in: query
required: false
schema:
type: integer
exclusiveMinimum: 0
description: Results page to return. The first page is used by default.
default: 1
title: Page
description: Results page to return. The first page is used by default.
- name: limit
in: query
required: false
schema:
type: integer
exclusiveMinimum: 0
description: Records returned per page. Defaults to 10 and accepts up to 100.
default: 10
title: Limit
description: Records returned per page. Defaults to 10 and accepts up to 100.
responses:
'200':
description: Request completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ListResource_CustomerPaymentMethod_'
'422':
description: Request validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- customer_session:
- customer_portal:read
- customer_portal:write
- member_session:
- customer_portal:read
- customer_portal:write
components:
schemas:
ListResource_CustomerPaymentMethod_:
properties:
items:
items:
$ref: '#/components/schemas/CustomerPaymentMethod'
title: CustomerPaymentMethod
type: array
title: Items
pagination:
$ref: '#/components/schemas/Pagination'
type: object
required:
- items
- pagination
title: ListResource[CustomerPaymentMethod]
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
CustomerPaymentMethod:
anyOf:
- $ref: '#/components/schemas/PaymentMethodCard'
- $ref: '#/components/schemas/PaymentMethodGeneric'
Pagination:
properties:
total_count:
type: integer
title: Total Count
max_page:
type: integer
title: Max Page
type: object
required:
- total_count
- max_page
title: Pagination
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
PaymentMethodCard:
properties:
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
processor:
$ref: '#/components/schemas/PaymentProcessor'
customer_id:
type: string
format: uuid4
title: Customer Id
type:
type: string
const: card
title: Type
method_metadata:
$ref: '#/components/schemas/PaymentMethodCardMetadata'
type: object
required:
- id
- created_at
- modified_at
- processor
- customer_id
- type
- method_metadata
title: PaymentMethodCard
PaymentMethodGeneric:
properties:
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
processor:
$ref: '#/components/schemas/PaymentProcessor'
customer_id:
type: string
format: uuid4
title: Customer Id
type:
type: string
title: Type
type: object
required:
- id
- created_at
- modified_at
- processor
- customer_id
- type
title: PaymentMethodGeneric
PaymentProcessor:
type: string
enum:
- stripe
title: PaymentProcessor
PaymentMethodCardMetadata:
properties:
brand:
type: string
title: Brand
last4:
type: string
title: Last4
exp_month:
type: integer
title: Exp Month
exp_year:
type: integer
title: Exp Year
wallet:
anyOf:
- type: string
- type: 'null'
title: Wallet
type: object
required:
- brand
- last4
- exp_month
- exp_year
title: PaymentMethodCardMetadata
securitySchemes:
customer_session:
type: http
description: >-
**Authentication:** Customer session tokens authenticate buyers within
your organization. Generate one through the [customer session
operation](/api-reference/customer-portal/sessions/create).
scheme: bearer
member_session:
type: http
description: >-
**Authentication:** Member session tokens authenticate team members
within a customer account. Generate one through the [member session
operation](/api-reference/member-portal/sessions/create).
scheme: bearer
````