FIfinmo
Payment Plan

List All Payment Plans

Retrieve a list of all Payment Plans. Use query parameters to filter the list.

This API comes with Pagination support, you can customize limit and page query parameters as per the requirements.

get/payment-plan

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Query parameters

frequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' | 'QUARTERLY'

Filter by frequency. Accepts single or multiple values

countrystring
Example:SG

ISO country code

payment_plan_idstring

Filter by payment plan id

payment_plan_namestring

Filter by payment plan name (partial match)

currencystring
Example:SGD

ISO 4217 currency code

is_auto_debitboolean

Whether the plan supports auto-debit

start_timeinteger
Example:1690694621

EPOCH timestamp

end_timeinteger
Example:1722317021

EPOCH timestamp

limitinteger
Example:10

Max number of payment plans per page. Default is 10 per page

pageinteger
Example:1

The page number to return. If unspecified, the first page is returned

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": [
    {
      "payment_plan_id": "payment_plan_c2a095a7b194451ebe9947e898f16291",
      "payment_plan_name": "Small Fresh Shoes",
      "currency": "SGD",
      "country": "SG",
      "frequency": "MONTHLY",
      "total_amount": 417136,
      "is_auto_debit": false,
      "initial_activation_delay": null,
      "initial_activation_delay_text": null,
      "number_of_cycles": 464,
      "amount_per_cycle": 899,
      "plan_schedule": null,
      "created_at": "2025-09-05T06:54:50.140Z",
      "updated_at": "2025-09-05T06:54:50.140Z",
      "is_active": true,
      "description": "Voluptates id aliquid libero recusandae dignissimos et consequatur est. In consectetur animi accusamus voluptatem quidem aut quod et. Dignissimos fugit deserunt dolorum illum iste. Quia esse praesentium voluptates sed et est et. Saepe veniam corporis nam deleniti aspernatur esse omnis ut possimus.",
      "is_fixed_amount": true
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.