Create Profile

POST

/api/:account_id/dunning/profiles/

POST

/api/:account_id/dunning/profiles/

$ curl -X POST https://app.paymentkit.com/api/account_id/dunning/profiles/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Standard Dunning Profile"
> }'

1 {
2   "id": "dunning-123e4567-e89b-12d3-a456-426614174000",
3   "account_id": "account-987f6543-e21b-45d6-b789-123456789abc",
4   "name": "Standard Dunning Profile",
5   "description": "This profile retries payment collection up to 5 times with 24 hours interval.",
6   "is_system_default": false,
7   "target_cycle_type": "monthly",
8   "max_retries": 5,
9   "retry_interval_hours": 24,
10   "termination_action": "cancel",
11   "invoice_status_on_failure": "mark_uncollectible",
12   "enable_emails": true,
13   "email_map": [
14     {
15       "retry_step": 1,
16       "template": "dunning_retry_1"
17     },
18     {
19       "retry_step": 3,
20       "template": "dunning_retry_3"
21     },
22     {
23       "retry_step": -1,
24       "template": "dunning_final_notice"
25     }
26   ],
27   "is_archived": false,
28   "created_at": "2024-01-15T09:30:00Z",
29   "updated_at": "2024-01-15T09:30:00Z"
30 }

Create a custom dunning profile.

Custom profiles can be freely configured. System default profiles cannot be created via API - they are automatically created per account.

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

namestringRequired1-100 characters

descriptionstring or nullOptional<=500 characters

max_retriesintegerOptional1-15Defaults to 8

retry_interval_hoursintegerOptional1-168Defaults to 96

termination_actionenumOptional

Action to take on subscription when dunning exhausts all retries.

invoice_status_on_failureenumOptional

Invoice status when dunning fails to collect payment.

enable_emailsbooleanOptionalDefaults to true

email_maplist of objects or nullOptional

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