Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Customers

Retrieve a customer's payment method

Retrieves a single payment method by ID for the specified customer.

get/v1/customers/{id}/payment_methods/{pm_id}

Path parameters

idstring required
Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA
pm_idstring required
Example:fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Query parameters

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Number of objects to skip before returning results.

include_orgboolean nullable

Resolve payment methods for a customer owned by a sibling partner in the same organization (PII opt-in). Defaults to false; a sibling-owned customer returns 404 unless this is true and the caller shares an organization with the owner. A sibling-owned payment method's metadata is returned as null.

Resolve payment methods for a customer owned by a sibling partner in the same organization (PII opt-in). Defaults to false; a sibling-owned customer returns 404 unless this is true and the caller shares an organization with the owner. A sibling-owned payment method's metadata is returned as null.

Response

An envelope wrapping a single payment method object.

Example response

{
  "payment_method": {
    "payment_method_id": "fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "billing_details": {
      "email": "john.doe@example.com",
      "name": "Example",
      "phone": "+14155550142"
    },
    "customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "card": {
      "country": "example_value",
      "exp_month": 12,
      "exp_year": 2027,
      "last4": "example_value"
    },
    "created_at": "2026-06-15T14:30:00Z",
    "test_mode": false,
    "off_session": false
  }
}