Skip to content
Bottle

Send payment reminders

POST
/invoices/reminders
curl --request POST \
  --url https://example.com/invoices/reminders \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "invoiceIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "subject": "example", "message": "example" }'

One email per unpaid invoice, to the customer’s billing contacts, with the invoice attached. Placeholders such as {number} and {amount} in the subject and message are filled in for each invoice. Paid or cancelled invoices, customers with no email address, and invoices reminded in the last 10 minutes are skipped. Sent even when automatic invoice emails are switched off.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
invoiceIds
required
Array<string>
>= 1 items <= 500 items
subject
required
string
>= 1 characters <= 200 characters
message
required
string
>= 1 characters <= 4000 characters

Responses

Section titled “Responses”

200

Section titled “200”

What was sent and what was skipped

Media typeapplication/json
object
sent
required
integer
skipped
required
Array<object>
object
invoiceId
required

UUID v7

string format: uuid
reason
required
string
Allowed values: not_found paid void no_email just_reminded

Example 

{
  "skipped": [
    {
      "invoiceId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "reason": "not_found"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}