Get payment plans
curl --request GET \
--url https://api.debbiecollect.com/v1/{tenantId}/payment-plans \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.debbiecollect.com/v1/{tenantId}/payment-plans"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.debbiecollect.com/v1/{tenantId}/payment-plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.debbiecollect.com/v1/{tenantId}/payment-plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.debbiecollect.com/v1/{tenantId}/payment-plans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.debbiecollect.com/v1/{tenantId}/payment-plans")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.debbiecollect.com/v1/{tenantId}/payment-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"meta": {
"currentPage": 0,
"pageSize": 100
},
"items": [
{
"paymentPlanId": "5e6f7a8b-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
"caseId": "3f1c2d4e-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
"status": "ACTIVE",
"activationTrigger": true,
"createdAt": "2025-01-01T20:00:00.000Z",
"createdBy": null,
"deletedAt": null,
"deletedBy": null,
"signed": true,
"documentId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"documentSignedAt": "2025-01-02T09:12:00.000Z",
"documentFileId": "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
"paymentMethodId": null,
"paymentMethodStatus": null,
"paymentMethodType": null,
"provider": null,
"config": null,
"plan": [
{
"paymentPlanEntryId": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"amount": 250000,
"status": "SETTLED",
"type": "NORMAL",
"reminder": "2025-02-01T00:00:00.000Z",
"date": "2025-02-08T00:00:00.000Z",
"deadline": "2025-02-15T00:00:00.000Z",
"cancel": "2025-02-22T00:00:00.000Z",
"interestAmount": null
}
]
}
]
}Payment plans
Get payment plans
Get a list of payment plans, paginated. Plans are returned oldest first, so a consumer paging through the whole set is not shifted by plans created while it iterates.
Without caseId the list spans the tenant and is not available to creditor scoped credentials. With caseId it returns the plans on that case.
Required scope: read:payment-plans
GET
/
v1
/
{tenantId}
/
payment-plans
Get payment plans
curl --request GET \
--url https://api.debbiecollect.com/v1/{tenantId}/payment-plans \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.debbiecollect.com/v1/{tenantId}/payment-plans"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.debbiecollect.com/v1/{tenantId}/payment-plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.debbiecollect.com/v1/{tenantId}/payment-plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.debbiecollect.com/v1/{tenantId}/payment-plans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.debbiecollect.com/v1/{tenantId}/payment-plans")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.debbiecollect.com/v1/{tenantId}/payment-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"meta": {
"currentPage": 0,
"pageSize": 100
},
"items": [
{
"paymentPlanId": "5e6f7a8b-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
"caseId": "3f1c2d4e-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
"status": "ACTIVE",
"activationTrigger": true,
"createdAt": "2025-01-01T20:00:00.000Z",
"createdBy": null,
"deletedAt": null,
"deletedBy": null,
"signed": true,
"documentId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"documentSignedAt": "2025-01-02T09:12:00.000Z",
"documentFileId": "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
"paymentMethodId": null,
"paymentMethodStatus": null,
"paymentMethodType": null,
"provider": null,
"config": null,
"plan": [
{
"paymentPlanEntryId": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"amount": 250000,
"status": "SETTLED",
"type": "NORMAL",
"reminder": "2025-02-01T00:00:00.000Z",
"date": "2025-02-08T00:00:00.000Z",
"deadline": "2025-02-15T00:00:00.000Z",
"cancel": "2025-02-22T00:00:00.000Z",
"interestAmount": null
}
]
}
]
}Authorizations
Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.
Path Parameters
Id of the tenant the payment plans belong to
Query Parameters
Page to get. Starting from 0.
Number of items per page.
Required range:
x <= 500Filter by the case the payment plans belong to.
Filter by the status of the payment plan.
Available options:
CREATED, ACTIVE, FINISHED, CANCELED, DELETED