Enable and Assign Dunning Plan to a Billing Account

You can enable dunning and assign a dunning plan to a billing account using the following endpoint and sample payload:

POST https://example-gotransverse.com/billing/2/billing-accounts/{id}/dunning-state

Request

1
2
3
4
{
  "enabled": "true",
  "plan_code": "Standard Client #1"
}

Response

1
2
3
4
5
6
7
8
{
  "id": "440",
  "enabled": true,
  "plan_code": "Standard Client #1",
  "plan_name": "Standard Client",
  "tier_code": "default_no_dunning",
  "tier_name": "No Dunning"
}

Parameters

• id — The ID of the billing account.

• enabled* — Specifies whether the dunning is enabled for this billing account.

• plan_code* — The code of the dunning plan that you want to assign to the billing account.

• plan_name — The name of the dunning plan that you want to associate with the billing account.

• tier_code — The code of the tier that you want to associate with the billing account.

• tier_name — The name of the tier that you want to associate with the billing account.

Topic Updated: 3/2024.