GEgetlago
payment_methods

List all customer payment methods

Changed on

This endpoint retrieves all payment methods of a customer.

get/customers/{external_customer_id}/payment_methods

Request

Path parameters

external_customer_idstring required
Example:5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba

The customer external unique identifier (provided by your own application)

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

Response

List of customer's payment methods

Example response

{
  "payment_methods": [
    {
      "lago_id": "4cf085a7-c196-4f07-a543-97c50ec6e8b2",
      "is_default": true,
      "payment_provider_code": "stripe_prod",
      "payment_provider_name": "Stripe",
      "payment_provider_type": "stripe",
      "provider_method_id": "pm_1N8ZQX2eZvKYlo2CkL9Y8XYZ",
      "created_at": "2025-01-21T00:10:29Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

Changes

  • fce1879654d8Revision changes
    • breaking

      the response property // became nullable for the status

    • warning

      added the new undefined enum value to the // response property for the response status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

  • 24e860ade740Revision changes
    • info

      endpoint added