FAfatzebra

List payment plans

Changed on
get/payment_plans

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/payment_plans
  • Auth
    HTTP basic

Query parameters

fromstring date-time
tostring date-time
offsetinteger
limitinteger

Maximum number of records to return. Must not be more than 50.

Response

200

successfulboolean
testboolean
recordsinteger
total_recordsinteger
pageinteger
total_pagesinteger

Example response

{
  "successful": true,
  "response": [
    {
      "id": "071-PP-8389G3DA",
      "customer": "071-C-JE34F66V",
      "amount": 100,
      "frequency": "Weekly",
      "anniversary": 5,
      "start_date": "2025-07-16",
      "total_count": 2,
      "payment_method": "Credit Card",
      "reference": "071-PP-8389G3DA",
      "status": "Active",
      "status_reason": "None",
      "created_at": "2018-07-11T16:23:39+10:00",
      "retry_interval": 3
    }
  ],
  "test": true,
  "records": 2,
  "total_records": 346,
  "page": 1,
  "total_pages": 173
}

Changes