API explorer

Theme switcher

On Hold

The On Hold allows merchants to temporarily pause an invoice within the Billink platform, giving them more flexibility in managing billing and payment cycles. When an invoice is placed on hold, no dunning or collection action will take place for the duration of the hold period—up to 14 days.

All available errors for this endpoint you can find in errors section.

Body Parameters

billinkIDstring Required

The uid linked to the Billink account.

billinkUsernamestring Required

The username associated with the Billink account.

daysnumber

The number of days to hold the invoice.

invoiceNumberstring Required

The unique number assigned to the invoice.

workflowNumberstring Required

The unique number associated with the workflow.

Response

200
Object

Response Attributes

codestring

The status code returned in the response.

descriptionstring

Additional information or details provided in the response.

resultstring

The outcome or result of the operation.

101
Object

Response Attributes

errorobject

Error message or description in case of a failed request.

Show child attributes

resultstring

The outcome or result of the operation.

401
Object

Response Attributes

errorobject

Error message or description in case of a failed request.

Show child attributes

resultstring

The outcome or result of the operation.

701
Object

Response Attributes

errorobject

Error message or description in case of a failed request.

Show child attributes

resultstring

The outcome or result of the operation.

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?