Skip to main content

List Payment Plans

GET/rest/payment_plans

The Payment Plans API allows merchants to manage and monitor payment installment plans for their invoices.

Retrieve a paginated list of payment plans with comprehensive filtering options. This endpoint allows you to monitor all payment installment plans across your channels.

Query Parameters​

pageInteger
Page number (default: 1)
per_pageInteger
Items per page (default: 50, max: 100)
statusString
Filter by status: created, active, completed, failed, canceled
plan_typeString
Filter by plan type: three_months, six_months, nine_months, twelve_months, fifteen_months, eighteen_months
channel_url_nameString
Filter by channel URL name
invoice_numberString
Filter by invoice number (partial match supported)
currencyString
Filter by currency code (e.g., EUR, USD)
created_afterString
Filter plans created after date (ISO 8601 format: YYYY-MM-DD)
created_beforeString
Filter plans created before date (ISO 8601 format: YYYY-MM-DD)
Example Request
GET /rest/payment_plans?page=1&status=active&channel_url_name=my-shop
Authorization: Basic <base64(api_key:api_password)>

Response​

payment_plansArray
Array of payment plan summary objects. See Payment plan summary object below.
statisticsObject
Overview statistics for all payment plans
paginationObject
Pagination metadata (page, items, count, pages, etc.)
errorString
Error details (null on success)
messageString
Success or error message
Example Response
{
"error": null,
"message": "Payment plans have been successfully retrieved.",
"payment_plans": [
  {
    "id": 123,
    "status": "active",
    "plan_type": "six_months",
    "currency": "EUR",
    "installments": 6,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "invoice": {
      "id": 456,
      "debt_claim_number": "INV-2024-001",
      "customer_name": "John Doe",
      "currency": "EUR",
      "original_amount": 600.0,
      "channel": {
        "id": 789,
        "name": "My Shop",
        "url_name": "my-shop"
      }
    },
    "financial_summary": {
      "total_amount": 630.0,
      "paid_amount": 210.0,
      "remaining_amount": 420.0,
      "progress_percentage": 33.33
    },
    "next_payment_date": "2024-03-15",
    "payments_completed": 2,
    "total_payments": 6,
    "transactions": [
      {
        "installment_number": 1,
        "status": "paid",
        "amount": 105.0,
        "included_fees": 5.0,
        "scheduled_date": "2024-01-15",
        "transaction_id": "TRX-ABC123",
        "initial_transaction_id": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-16T08:45:00Z"
      }
    ]
  }
],
"statistics": {
  "total": 150,
  "active": 45,
  "completed": 80,
  "failed": 10,
  "canceled": 15,
  "created": 0
},
"pagination": {
  "page": 1,
  "items": 10,
  "count": 45,
  "pages": 5,
  "from": 1,
  "to": 10,
  "prev": null,
  "next": 2
}
}

Payment plan summary object​

idInteger
Unique identifier for the payment plan
statusString
Current status: created, active, completed, failed, canceled
currencyString
Currency code (e.g., EUR, USD)
plan_typeString
Type of plan: three_months, six_months, nine_months, twelve_months, fifteen_months, eighteen_months
installmentsInteger
Total number of installments in the plan
created_atString
When the payment plan was created (ISO 8601)
updated_atString
When the payment plan was last updated (ISO 8601)
invoiceObject
Associated invoice details object
financial_summaryObject
Financial breakdown object. See Financial summary object below.
next_payment_dateString
Date of next scheduled payment (YYYY-MM-DD)
payments_completedInteger
Number of installments successfully paid
total_paymentsInteger
Total number of installments
transactionsArray
Array of transaction objects. See Transaction object below.
Payment Plan Summary Object
{
"id": 123,
"status": "active",
"plan_type": "six_months",
"currency": "EUR",
"installments": 6,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"invoice": {
  "id": 456,
  "debt_claim_number": "INV-2024-001",
  "customer_name": "John Doe",
  "currency": "EUR",
  "original_amount": 600.0,
  "channel": {
    "id": 789,
    "name": "My Shop",
    "url_name": "my-shop"
  }
},
"financial_summary": {
  "total_amount": 630.0,
  "paid_amount": 210.0,
  "remaining_amount": 420.0,
  "progress_percentage": 33.33
},
"next_payment_date": "2024-03-15",
"payments_completed": 2,
"total_payments": 6,
"transactions": []
}

Financial summary object​

total_amountFloat
Total amount including all fees
paid_amountFloat
Amount already paid
remaining_amountFloat
Amount still to be paid
progress_percentageFloat
Completion percentage (0-100)
Financial Summary Object
{
"total_amount": 630.0,
"paid_amount": 210.0,
"remaining_amount": 420.0,
"progress_percentage": 33.33
}

Transaction object​

installment_numberInteger
Installment number in the sequence (1, 2, 3, etc.)
statusString
Transaction status: scheduled, pending, paid, failed, canceled
amountFloat
Transaction amount including fees
included_feesFloat
Fees included in the amount
scheduled_dateString
Scheduled payment date (YYYY-MM-DD)
transaction_idString
Associated transaction ID (if payment processed)
initial_transaction_idString
Reference to initial transaction
created_atString
When transaction was created (ISO 8601)
updated_atString
When transaction was last updated (ISO 8601)
Transaction Object
{
"installment_number": 1,
"status": "paid",
"amount": 105.0,
"included_fees": 5.0,
"scheduled_date": "2024-01-15",
"transaction_id": "TRX-ABC123",
"initial_transaction_id": null,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-16T08:45:00Z"
}
Last updated on