Delinquency processes

A delinquency process is an automatic process that starts when an account invoice is past due. The steps of a delinquency process are designed to resolve the issue. For example, they could consist of sending requests for payment to the payer and then, if the account remains delinquent, sending a message to the Policy Administration System to cancel the policy. For more information on delinquency processes, see the Application Guide.

Querying for delinquency processes

Use the following endpoint to query for an account’s delinquency processes:

  • GET /billing/v1/accounts/{accountId}/delinquency-processes
  • GET /billing/v1/accounts/{accountId}/delinquency-processes/{delinquencyProcessId}

For example, the following request queries for all the delinquency processes for account bc:101.

Command

GET /billing/v1/accounts/bc:101/delinquency-processes

Response

{
    "count": 1,
    "data": [
        {
            "attributes": {
                "amount": {
                    "amount": "120.00",
                    "currency": "usd"
                },
                "delinquencyPlan": {
                    "displayName": "Standard Delinquency Plan",
                    "id": "bc:SAUeUVg7msVnhCpPT467g",
                    "type": "DelinquencyPlan",
                    "uri": "/admin/v1/delinquency-plans/bc:SAUeUVg7msVnhCpPT467g"
                },
                "id": "bc:SZCpWHICbr_ufUnCuxuk4",
                "inceptionDate": "2024-05-23",
                "phase": {
                    "code": "Delinquency",
                    "name": "Delinquency"
                },
                "reason": {
                    "code": "PastDue",
                    "name": "Past Due"
                },
                "startDate": "2024-05-23T04:55:22.635Z",
                "status": {
                    "code": "Open",
                    "name": "Open"
                }
            },
		...

Additional filter options

Some GET endpoints that return collections have filter options that may not appear in the API definition for one reason or another. This documentation refers to them as additional filter options.

The GET /billing/v1/accounts/{accountId}/delinquency-processes endpoint has the following additional filter options:

  • policyPeriodId