---
title: "Get payment methods"
method: GET
path: "/subscriptions/{subscriptionId}/paymentmethods"
tags: ["Subscription Payments"]
---

# Get payment methods

`GET /subscriptions/{subscriptionId}/paymentmethods`

Returns the payment methods actively set on the specified subscription.

## Path parameters

- `subscriptionId` string, required

## 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 an unsupported request is made.
- `404` — When subscription with specified id 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/ffc7fffa0d5c/schema)