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>*

Body

application/json

Filter

customer_ids
string[]
delivery_statuses
enum<string>[]
Available options:
queued,
sent,
delivery_delayed,
delivered,
bounced,
complained,
failed,
suppressed,
skipped
end_time
string<date-time>
entity_ids
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
expand
string
limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
sort
string
start_time
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
triggers
enum<string>[]
Available options:
auto,
manual

Response

OK

items
object[]
pagination
object