PApaddlehq
Payment methods

List payment methods for a customer

Changed on

Returns a paginated list of payment methods that a customer has saved. Use the query parameters to page through results.

Customers can choose to save payment methods when purchasing one-time items and subscriptions by checking a box when completing checkout. You can present customers with their saved payment methods when they make a purchase in the future.

Returns an empty list where customers have not saved any payment methods, or have deleted all previously saved payment methods.

get/customers/{customer_id}/payment-methods

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

customer_idstring required

Unique Paddle ID for this customer entity, prefixed with ctm_.

Example:ctm_01grnn4zta5a1mf02jjze7y2ys

Paddle ID of the customer entity to work with.

Query parameters

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

address_idstring[]

Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

supports_checkoutboolean

Return entities that support being presented at checkout (true) or not (false).

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": "paymtd_01hkm9xwqpbbpr1ksmvg3sx3v1",
      "customer_id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
      "address_id": "add_01gm302t81w94gyjpjpqypkzkf",
      "card": {
        "last4": "4242",
        "expiry_month": 12,
        "expiry_year": 2028
      },
      "paypal": {
        "email": "john.doe@example.com"
      },
      "south_korea_local_card": {
        "last4": "4242"
      },
      "saved_at": "2024-10-12T07:20:50.52Z",
      "updated_at": "2024-10-13T07:20:50.52Z"
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

Changes

  • v14f35a8c6ea4dRevision changes
    • info

      response property data/items/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/ deprecated

    • info

      response property data/items/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/type deprecated

    • info

      response property data/items/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/type/allOf[subschema #1: Korean market underlying payment method type]/ deprecated

  • v1e1ac347eb3c5Revision changes
    • breaking

      added the pattern ^ctm_[a-z\d]{26}$ to the path request parameter customer_id

    • info

      added the new optional header request parameter Skip-Count