PUT
/
dunning
/
overdue-rules
/
{id}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

OverdueRule identifier

Body

​
daysOverdue
integer
required

Days after the invoice or last reminder / dunning is overdue.

Required range: x > 0
​
documentTemplate
object
required

The document template that is used to generate the reminder / dunning. This is required for a dunning and optional for a reminder.

​
dueInDays
integer
default:
7
required

Number of days until this reminder / dunning should be paid.

Required range: x > 0
​
emailTemplate
object
required

The email template that is used to send the reminder / dunning.

​
type
any
required

Type of the overdue rule.

Possible values:

  • reminder: Send a reminder to the customer.
  • dunning: Send a dunning to the customer.
​
amountInCents
integer | null

Amount in cents that is charged in the currency of the base invoice, for the dunning. This is required for type "dunning".

Required range: x > 0
​
attachOriginalInvoice
boolean
default:
true

Attach the original invoice additionally to the reminder / dunning.

​
isEnabled
boolean
default:
true

Enable or disable the overdue rule.

​
sendLetter
boolean

Send a letter by mail to the customer.

Response

200 - application/json
​
daysOverdue
integer
required

Days after the invoice or last reminder / dunning is overdue.

Required range: x > 0
​
documentTemplate
object
required

The document template that is used to generate the reminder / dunning. This is required for a dunning and optional for a reminder.

​
dueInDays
integer
default:
7
required

Number of days until this reminder / dunning should be paid.

Required range: x > 0
​
emailTemplate
object
required

The email template that is used to send the reminder / dunning.

​
level
integer
default:
1
required

Level of the overdue rule. The level is used to sort the overdue rules. The overdue rule with the lowest level is used first.

Required range: 0 < x < 6
​
type
any
required

Type of the overdue rule.

Possible values:

  • reminder: Send a reminder to the customer.
  • dunning: Send a dunning to the customer.
​
amountInCents
integer | null

Amount in cents that is charged in the currency of the base invoice, for the dunning. This is required for type "dunning".

Required range: x > 0
​
attachOriginalInvoice
boolean
default:
true

Attach the original invoice additionally to the reminder / dunning.

​
createdAt
string

Date and time when the overdue rule was created.

​
id
string
​
isEnabled
boolean
default:
true

Enable or disable the overdue rule.

​
sendLetter
boolean

Send a letter by mail to the customer.

​
updatedAt
string

Date and time when the overdue rule was last updated.

Was this page helpful?

Get overdue rulesGet all subscriptions