Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Subscription Payments

Get payment method

Returns a specific payment method associated with a subscription.

get/subscriptions/{subscriptionId}/paymentmethods/{id}

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

The payment type.

  • None - The payment type is missing or unknown.

  • CreditCard - Credit Card payment type.

  • DirectDeposit - Direct Deposit payment type. (not currently supported)

isDefaultboolean

Whether this is the default payment method for the customer.

lastPaymentStatestring

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)

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"
}