Get Profile

GET

/api/:account_id/dunning/profiles/:profile_id

GET

/api/:account_id/dunning/profiles/:profile_id

$ curl https://app.paymentkit.com/api/account_id/dunning/profiles/profile_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "dunning-profile-9876",
3   "account_id": "account-1234",
4   "name": "Standard Dunning Profile",
5   "description": "Default dunning profile for overdue invoice management",
6   "is_system_default": false,
7   "target_cycle_type": "monthly",
8   "max_retries": 3,
9   "retry_interval_hours": 48,
10   "termination_action": "suspend_account",
11   "invoice_status_on_failure": "failed",
12   "enable_emails": true,
13   "email_map": [
14     {
15       "retry_step": 0,
16       "template": "dunning_email_initial"
17     },
18     {
19       "retry_step": 1,
20       "template": "dunning_email_first_reminder"
21     },
22     {
23       "retry_step": 2,
24       "template": "dunning_email_final_notice"
25     },
26     {
27       "retry_step": -1,
28       "template": "dunning_email_termination"
29     }
30   ],
31   "is_archived": false,
32   "created_at": "2024-01-15T09:30:00Z",
33   "updated_at": "2024-04-10T14:45:00Z"
34 }

Get a dunning profile by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

profile_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

account_idstring

namestring

descriptionstring or null

is_system_defaultboolean

target_cycle_typestring or null

max_retriesinteger

retry_interval_hoursinteger

termination_actionstring

invoice_status_on_failurestring

enable_emailsboolean

email_maplist of objects or null

is_archivedboolean

created_atdatetime

updated_atdatetime

Errors

422

Unprocessable Entity Error