v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Subscription Payments

Get payment methods

Returns the payment methods actively set on the specified subscription.

get/subscriptions/{subscriptionId}/paymentmethods

Path parameters

subscriptionIdstring required

The unique identifier of the subscription

Query parameters

Offsetinteger

Limitinteger

Response

When request is successful. Returns a paged collection of 'PaymentMethod' objects.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable

offsetinteger nullable

limitinteger nullable

sizeinteger

Example response

{
  "value": [
    {
      "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"
    }
  ]
}