ApiInvoices

Set the reminder schedule

Replace the schedule — AC 2. Reminders stop on payment or void without being cancelled here: that is a property of the invoice's state, not a list someone has to remember to clear.

PUT
/api/b/v1/invoices/{invoice_id}/reminders

Replace the schedule — AC 2.

Reminders stop on payment or void without being cancelled here: that is a property of the invoice's state, not a list someone has to remember to clear.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

invoice_id*Invoice Id
Formatuuid
admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

application/json

application/json

curl -X PUT "https://example.com/api/b/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/reminders" \  -H "Content-Type: application/json" \  -d '[    {      "trigger": "before_due"    }  ]'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "number": "string",  "customer_name": "string",  "customer_email": "string",  "currency": "string",  "subtotal_minor": 0,  "tax_minor": 0,  "total_minor": 0,  "paid_minor": 0,  "outstanding_minor": 0,  "state": "draft",  "due_date": "2019-08-24",  "sent_at": "2019-08-24T14:15:22Z",  "paid_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "payment_link_slug": "string",  "lines": []}