API referenceInvoices
Pause reminders
Needs a token with the write:invoices scope. Authentication
Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.
POST
Stops automatic reminders for this invoice until resumed. Safe to repeat. Answers with the dunning status.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
id*stringThe invoice's id.
OK
application/json- response
data*curl -X POST 'https://app.helvetly.com/api/v1/invoices/string/dunning/pause'Example Response
{ "data": { "applies": true, "enabled": true, "client_enabled": true, "paused": true, "next": { "level": 0, "levels": 0, "title": "string", "due_on": "2019-08-24" }, "notices": [ { "level": 0, "levels": 0, "sent_at": "2019-08-24T14:15:22Z", "sent_on": "2019-08-24", "open_amount": "1234.50", "fee": "1234.50", "interest": "1234.50", "interest_rate": "string", "interest_from": "2019-08-24", "total": "1234.50", "email": "string", "sent_by": "string", "qr_bill": true, "title": "string" } ] }}