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

# Get all customer payment methods

`GET /subscriptions/paymentmethods`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/subscriptions/paymentmethods`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

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: Type of payment method (currently only CREDIT_CARD is 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: Last transaction state.
    - `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.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)