Skip to main content

Get Payment Plan

GET/rest/payment_plans/:id

Retrieve detailed information about a specific payment plan, including all installment transactions.

Request​

idIntegerrequired
Payment plan ID in the URL path
Example Request
GET /rest/payment_plans/123
Authorization: Basic <base64(api_key:api_password)>

Response​

Returns the same payment plan object as the List Payment Plans endpoint, but for a single payment plan.

errorString
Error details (null on success)
messageString
Success or error message
payment_planObject
Payment plan details object. See Payment plan summary object for field definitions.
Example Response
{
"error": null,
"message": "Payment plan retrieved successfully.",
"payment_plan": {
  "id": 123,
  "status": "active",
  "currency": "EUR",
  "plan_type": "six_months",
  "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": "TRX-ABC123",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-16T08:45:00Z"
    },
    {
      "installment_number": 2,
      "status": "paid",
      "amount": 105.0,
      "included_fees": 5.0,
      "scheduled_date": "2024-02-15",
      "transaction_id": "TRX-DEF456",
      "initial_transaction_id": "TRX-ABC123",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-02-16T09:20:00Z"
    },
    {
      "installment_number": 3,
      "status": "scheduled",
      "amount": 105.0,
      "included_fees": 5.0,
      "scheduled_date": "2024-03-15",
      "transaction_id": null,
      "initial_transaction_id": "TRX-ABC123",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}
}
Last updated on