WIwithflex
Customers

Retrieve a customer's payment method

Changed on

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

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

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/customers/{id}/payment_methods/{pm_id}
  • Auth
    HTTP bearer

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
offsetinteger nullable

Number of objects to skip before returning results.

Example:3
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.

Response

An envelope wrapping a single payment method object.

Example response

{
  "payment_method": {
    "payment_method_id": "fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "billing_details": {
      "address": {
        "city": "San Francisco",
        "country": "US",
        "line1": "123 Main St",
        "line2": "Suite 100",
        "postal_code": "94107",
        "state": "CA"
      },
      "email": "john.doe@example.com",
      "name": "Example",
      "phone": "+14155550142"
    },
    "customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "card": {
      "brand": "american_express",
      "country": "example_value",
      "exp_month": 12,
      "exp_year": 2027,
      "funding": "credit",
      "last4": "example_value"
    },
    "created_at": "2026-06-15T14:30:00Z",
    "test_mode": false,
    "off_session": false
  }
}

Changes

  • eec642897a22Revision changes
    • breaking

      the ////// response's property format changed from email to no format for status

    • warning

      for the query request parameter limit, the max was set to 2147483647.00

    • warning

      for the query request parameter offset, the max was set to 2147483647.00

    • warning

      for the query request parameter limit, the min was set to -2147483648.00

    • warning

      for the query request parameter offset, the min was set to -2147483648.00