POST
/
invoices
/
{id}
/
comment
curl -X POST \
 /invoices/{id}/comment \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "comment": ""
}'
{
  "id": "<string>",
  "dateTime": "2023-11-07T05:31:56Z",
  "type": "commented",
  "user": {
    "user": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "jsmith@example.com"
    },
    "deactivated": true,
    "avatar": "<string>",
    "fullName": "<string>",
    "initial": "<string>",
    "gravatarUrl": "<string>"
  },
  "metadata": {},
  "pinned": true
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

Invoice identifier

Body

The new Invoice resource
​
comment
string
required
Required string length: 1 - 5000

Response

201
application/json
Invoice resource created
​
id
string
​
dateTime
string
​
type
enum<string>
Available options:
commented,
customer.created,
customer.email.added,
customer.email.default_changed,
customer.address.added,
subscription.removed,
custom_fields.updated,
customer.address.default_changed,
customer.updated,
stripe.customer.attached,
customer.archived,
customer.unarchived,
customer.group.assigned,
customer.contact_person.assigned,
customer.contact_person.removed,
customer.partner.assigned,
customer.partner.removed,
customer.vat_id.validated,
customer.vat_id.invalidated,
subscription.trial.extended,
subscription.trial.revoked,
subscription.payment_method.updated,
subscription.billing_group.updated,
subscription.activated,
subscription.cancelled,
subscription.terminated,
subscription.updated,
subscription.invoice_address.updated,
subscription.paused,
subscription.resumed,
subscription.cancellation.revoked,
subscription.item.added,
subscription.offer.created,
product.created,
product.updated,
product.archived,
product.unarchived,
subscription.created,
api_key.created,
payment_gateway.configured,
tenant.completed,
checkout_link.created,
price.created,
user.invitation.sent,
tenant.updated,
tenant.created,
tenant.account.added,
user.invitation.accepted,
user.invitation.revoked,
webhook.created,
get_started.finished,
customer.removed,
invoice.removed,
invoice.created,
invoice.finalized,
invoice.credited,
invoice.imported,
invoice.payment.initiated,
invoice.sent,
invoice.paid,
invoice.payment_method.updated,
invoice.canceled,
invoice.closed,
invoice.refunded,
invoice.unpaid,
invoice.requires_approval,
invoice.dunning.applied,
payment.retry,
payment.payment_method.updated,
payment.failed,
invoice.dunning.disabled,
invoice.dunning.enabled,
invoice.updated,
import.completed
​
user
object | null

Nulled users are system activities

​
metadata
object
​
pinned
boolean