Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id
string
required

Invoice ID

Body

application/json

Recipients overriding the customer's email

cc
string[]
Maximum array length: 50
idempotency_key
string
Required string length: 1 - 128
to
string[]
Maximum array length: 50

Response

OK

cc_addresses
string[]
created_at
string<date-time>
created_by
string
customer_id
string
delivered_at
string<date-time>
delivery_status
enum<string>
Available options:
queued,
sent,
delivery_delayed,
delivered,
bounced,
complained,
failed,
suppressed,
skipped
entity_id
string
entity_type
enum<string>
Available options:
feature,
customer,
plan,
subscription,
invoice,
payment,
credit_note,
refund,
wallet,
entitlement,
checkout_session,
payment_method,
price,
event,
commitment,
billing_term,
billing_instalment
environment_id
string
from_address
string
id
string
idempotency_key
string
metadata
object
provider
enum<string>
Available options:
resend,
local
provider_message_id
string
reply_to
string
sent_at
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
status_reason
string
subject
string
template_key
enum<string>
Available options:
invoice_finalized
tenant_id
string
to_addresses
string[]
trigger
enum<string>
Available options:
auto,
manual
updated_at
string<date-time>
updated_by
string