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

# Get payment method

`GET /subscriptions/{subscriptionId}/paymentmethods/{id}`

## Request

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

Returns a specific payment method associated with a subscription.

## Path parameters

- `subscriptionId` string, required
- `id` string, uuid, required

## Response `200`

When request is successful. Returns a 'PaymentMethod' object.

- PaymentMethod
  - `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.

## Other responses

- `400`: When an unsupported request is made.
- `404`: When subscription or payment method with specified id does not exist.
- `500`: When an error occurs while retrieving payment method.

---

[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)