Docs/User API/Payment methods/List

List payment methods

Preview

GET/user/v1/paymentMethods

List payment methods for an account.

query parameters

organizationId
string
Show results for specified organization.
If this is not provided the user's individual subscription(s) will be returned.
pageSize
int32
The maximum number of payment methods to return. The API may return fewer than this value.
If unspecified, at most 20 payment methods will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken
string
A page token, received from a previous list payment methods call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to list payment methods must match the call that provided the page token.

Returns

paymentMethods
PaymentMethod[]
The list of payment methods.
id
string
The system-assigned identifier of the payment method.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT)
Possible values:
CREDITDEBITPREPAID
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
nextPageToken
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
previousPageToken
string
A token, which can be sent as pageToken to retrieve the previous page. If this field is absent, there are no preceding pages. If this field is an empty string then the previous page is the first result.

paymentMethods
PaymentMethod[]
The list of payment methods.
id
string
The system-assigned identifier of the payment method.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT)
Possible values:
CREDITDEBITPREPAID
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
nextPageToken
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
previousPageToken
string
A token, which can be sent as pageToken to retrieve the previous page. If this field is absent, there are no preceding pages. If this field is an empty string then the previous page is the first result.

curl https://api.userhub.com/user/v1/paymentMethods?organizationId=org_28seyVGVL1got6 \
  -H "UserHub-Api-Key: $USERHUB_USER_KEY" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

const res = await userApi.paymentMethods.list({
  organizationId: "org_28seyVGVL1got6",
});

res, err := userApi.PaymentMethods().List(
    context.Background(),
    &userapi.PaymentMethodListInput{
        OrganizationId: "org_28seyVGVL1got6",
    },
)

$res = $userApi->paymentMethods->list(
    organizationId: 'org_28seyVGVL1got6',
);

res = user_api.payment_methods.list(
    organization_id="org_28seyVGVL1got6",
)

Response bodyJSON

{
  "paymentMethods": [
    {
      "id": "pm_2kWzaZMKDM1x81",
      "type": "CARD",
      "displayName": "Visa **** 4242",
      "fullName": "Jane Doe",
      "address": {
        "lines": [
          "42 West St"
        ],
        "city": "Brooklyn",
        "state": "NY",
        "postalCode": "11222",
        "country": "US"
      },
      "default": true,
      "card": {
        "brand": "VISA",
        "expYear": 2030,
        "expMonth": 7,
        "last4": "4242",
        "fundingType": "CREDIT"
      },
      "createTime": "2025-05-15T13:00:00Z",
      "updateTime": "2025-05-15T13:00:00Z"
    }
  ]
}

PreviousThe payment method object

NextCreate a payment method

List payment methods

.css-10iahqc{text-transform:capitalize;}query parameters

Returns

query parameters