Skip to content

List your payment methods

The portal.payment_methods.list operation: GET /api/v1/portal/me/payment_methods in the REST API and the portal_payment_methods_list tool in the MCP server.

GET/api/v1/portal/me/payment_methods

Lists the cards (and other methods) the signed-in customer saved with the brand, newest first: brand, last four digits, expiry and country, and which one is the default that subscriptions charge. Removed methods aren't listed. Paginate with limit (default 20) and starting_after. Customer portal only (portal:read).

At a glance

  • REST: GET /api/v1/portal/me/payment_methods
  • MCP tool: portal_payment_methods_list
  • Operation ID: portal.payment_methods.list
  • Scope: Brand
  • Permission: portal:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Pagination: limit (at most 100) and starting_after
  • Authentication: A customer signed in to the customer portal (API keys can't call it)
  • Since: M9

Request

Query parameters

FieldTypeRequiredDescription
limitinteger (1 to 100)NoPage size, 1 to 100 (default 20).
starting_afterstringNoThe next_cursor of the previous page.

Response

200 OK with a JSON object, a page of the list (newest first):

FieldTypeDescription
object"list"
dataarray of object
data[].idpm_… ID
data[].object"portal_payment_method"
data[].typestring
data[].cardobject or null
data[].isDefaultboolean
data[].createdAtdate-time
has_moreboolean
next_cursorstring or null

Examples

Two saved cards

HTTP
GET /api/v1/portal/me/payment_methods
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "list",
  "data": [
    {
      "id": "pm_01m4tx5nj8emwbyf7y9vcf48b5",
      "object": "portal_payment_method",
      "type": "card",
      "card": {
        "brand": "visa",
        "last4": "4242",
        "expMonth": 12,
        "expYear": 2029,
        "country": "DE"
      },
      "isDefault": true,
      "createdAt": "2026-10-20T09:00:00.000Z"
    },
    {
      "id": "pm_01m4tx5nj8emwbyf7y9vcf48b6",
      "object": "portal_payment_method",
      "type": "card",
      "card": {
        "brand": "mastercard",
        "last4": "4444",
        "expMonth": 3,
        "expYear": 2028,
        "country": "AT"
      },
      "isDefault": false,
      "createdAt": "2026-10-20T09:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400A field or pagination value is malformed.Fix the fields listed in details.issues and send the request again.
livemode_not_allowed403The portal session is in the other mode than the request.Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin.
permission_denied403The caller isn't a customer signed in to this brand's portal (operators and API keys use the customer operations).Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, scope_required, resource_not_found, dry_run_not_supported, rate_limited, internal_error.