Skip to main content
GET
Returns one order created within the last 60 days (see Data retention). Poll sparingly; prefer webhooks. An unknown order ID, or an order older than 60 days, returns 404 not_found.

Path parameters

string
required
The order ID returned by POST /orders, e.g. BP-7K3M9QXA.

The order object

string
Order ID, e.g. BP-7K3M9QXA.
string
Always "order".
string
Buyer’s email (normalised to lowercase).
string | null
Your reference, or null if you did not send one.
string
See Order statuses.
string | null
Only when status is error: a short, human-readable explanation of why the order failed (for example that the recipient’s mailbox is full). null for every other status. The wording may be refined over time, so do not parse it: branch on status.
string
ISO 8601 UTC.
string | null
When the status became final; null while not final.
string | null
Subscription end date (YYYY-MM-DD) once known.
number
Price charged for this order, in currency.
string
USD or IDR.
boolean
Whether the charge was refunded.
number
Only in the 201 response of POST /orders: your balance after the charge.

Order statuses

There are only these four statuses. Every failure is reported as error, and note tells you why, so an order never fails without an explanation:
Possible notes for error orders: the recipient’s mailbox is full or does not exist; the email domain cannot receive email; the recipient’s mail server rejected the email; the recipient reported the email as spam; the email could not be delivered within 72 hours; or a generic delivery failure.