List payment methods - Unprice Documentation

const { result, error } = await unprice.paymentMethods.list({
  customerId: "cus_1234567890",
  provider: "stripe"
});

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

console.log(result);

[
  {
    "id": "pm_1234567890",
    "name": "John Doe",
    "last4": "4242",
    "expMonth": 12,
    "expYear": 2028,
    "brand": "visa"
  }
]

const { result, error } = await unprice.paymentMethods.list({
  customerId: "cus_1234567890",
  provider: "stripe"
});

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

console.log(result);

[
  {
    "id": "pm_1234567890",
    "name": "John Doe",
    "last4": "4242",
    "expMonth": 12,
    "expYear": 2028,
    "brand": "visa"
  }
]

const { result, error } = await unprice.paymentMethods.list({
  customerId: "cus_1234567890",
  provider: "stripe"
});

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

console.log(result);

[
  {
    "id": "pm_1234567890",
    "name": "John Doe",
    "last4": "4242",
    "expMonth": 12,
    "expYear": 2028,
    "brand": "visa"
  }
]

Request

string

required

The ID of the customer to get payment methods for

string

required

Use stripe for production or sandbox for testing. The contract also accepts square, but Unprice has no built-in Square adapter.

Response

string

required

The ID of the payment method

string

The name on the payment method

string

The last 4 digits of the payment method

number

The expiration month of the payment method

number

The expiration year of the payment method

string

The brand of the payment method (e.g., visa, mastercard)

​Request

​Response

Request

Response