GET /user/paymethods

Retrieve the authenticated client's stored payment methods.

Request

  • Base URL
    https://developers.whmcs.com/api/v2
  • Auth
    none declared

Query parameters

pageinteger
Example:1

Page number

page_sizeinteger
Example:10

Number of items per page. The maximum allowed value is 500. The default value is 50.

Response

The client's stored payment methods, if any exist, starting with the default payment method.

Example response

{
  "data": [
    {
      "id": 12,
      "type": "RemoteCreditCard",
      "kind": "card",
      "description": "Weekend Card",
      "gateway": "stripe_dynamic",
      "gateway_is_active": true,
      "is_default": true,
      "label": "Visa-4242",
      "card_type": "Visa",
      "card_last_four": "4242",
      "expiry_date": "06/30",
      "bank_name": "STRIPE TEST BANK"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.