SMsmokeball
Subscription Payments

Get payment method

Returns a specific payment method associated with a subscription.

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

Path parameters

subscriptionIdstring required

The unique identifier of the subscription

idstring uuid required

The unique identifier of the payment method

Response

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

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the payment method.

paymentSystemstring nullable

Payment system.

typestring

Type of payment method (currently only CREDIT_CARD is supported).

isDefaultboolean

Whether this is the default payment method for the customer.

lastPaymentStatestring

Last transaction state.

createdDatestring date-time

When this payment method was added.

Example response

{
  "id": "784b3497-bf1f-47d2-93e6-1d38b96b8d3f",
  "paymentSystem": "STRIPE",
  "type": "CreditCard",
  "isDefault": true,
  "details": {
    "lastFourDigits": "1234",
    "expiry": "10/28",
    "expiryMonth": 10,
    "expiryYear": 2028,
    "accountNumber": 123456789
  },
  "lastPaymentState": "Succeeded",
  "createdDate": "2022-04-23T14:00:00Z"
}

Changes

No recorded changes to this operation across all 15 revisions of this API.