---
title: "Get all customer payment methods"
method: GET
path: "/subscriptions/paymentmethods"
tags: ["Subscription Payments"]
---

# Get all customer payment methods

`GET /subscriptions/paymentmethods`

Returns all payment methods attached to the current account's payment customer.

## Query parameters

- `Offset` integer
- `Limit` integer

## Response `200`

When request is successful. Returns a paged collection of 'PaymentMethod' objects.

- PaymentMethodPagedCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` PaymentMethod[], nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `id` string, nullable — Unique identifier of the payment method.
    - `paymentSystem` string, nullable — Payment system.
    - `type` string — The payment type. * None - The payment type is missing or unknown. * CreditCard - Credit Card payment type. * DirectDeposit - Direct Deposit payment type. (not currently supported)
    - `isDefault` boolean — Whether this is the default payment method for the customer.
    - `details` PaymentMethodDetails
      - `brand` string, nullable — The brand of the credit card.
      - `lastFourDigits` string, nullable — Last four digits of the credit card.
      - `expiry` string, nullable — Expiry date of the credit card in MM/YY format.
      - `expiryMonth` integer, nullable — Expiry month.
      - `expiryYear` integer, nullable — Expiry year.
      - `accountNumber` integer, nullable — The account number of the direct deposit account. Not yet supported.
      - `bsb` integer, nullable — The BSB of the direct deposit account. Not yet supported.
    - `lastPaymentState` string — The status of a payment. * None: The payment status is unknown. * Succeeded: The payment was successful. * Processing: The payment is being processed. * Canceled: The payment was canceled. * Failed: The payment requires a payment method to be provided, the provided payment method failed or other action is required (e.g. confirmation or other action by the customer)
    - `createdDate` string, date-time — When this payment method was added.
  - `offset` integer, nullable
  - `limit` integer, nullable
  - `size` integer
  - `first` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `previous` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `next` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `last` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable

## Other responses

- `400` — When the account is not associated to a payment customer.
- `404` — When the account does not exist.
- `500` — When an error occurs while retrieving payment methods.

---

[API](https://skmtc.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/revisions/197984da9b42/schema)