Skip to main content
GET
/
v1
/
invoices
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "85a13a7f-ba2d-44a5-b692-d1538a244de1",
  "object": "invoice",
  "automatic_collection": false,
  "due_date": null,
  "footer": null,
  "issue_date": null,
  "live_mode": true,
  "memo": null,
  "metadata": {},
  "notifications_enabled": true,
  "order_number": null,
  "status": "draft",
  "portal_url": "http://app.example.com/portal_redirect/invoices/85a13a7f-ba2d-44a5-b692-d1538a244de1",
  "notification_sent_at": null,
  "reminder_notification_sent_at": null,
  "checkout": "8e78859f-955b-4921-89e9-a3b69e3d1204",
  "created_at": 1767909708,
  "updated_at": 1767909708
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
refresh_status
boolean

If true, the server will check the associated payment processor to see if a status change has occured. (This should be used when retrieving a checkout or payment intent immediately after it has been paid through the processor. In this scenario, it's possible that you'll request the checkout before the server has received the webhook from the processor. Setting this pararmeter to true prevents this scenario.)

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
automatic_collection
boolean

Whether or not the invoice should be paid automatically using one of the customer's payment methods. The specific payment method will need to passed to the /open endpoint.

​
due_date
integer | null

The date on which payment for this invoice is due. Measured in seconds since the Unix epoch.

​
footer
string | null

Additional footer text to be displayed on the invoice.

​
issue_date
integer | null

The date on which the invoice was issued. Measured in seconds since the Unix epoch.

​
live_mode
boolean

Whether or not the invoice is in live mode.

​
memo
string | null

Additional memo text to be displayed on the invoice.

​
notifications_enabled
boolean

Whether or not notifications should be sent to customers when an invoice is opened and when it reaches its due date.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
notification_sent_at
integer | null

The time at which the invoice notification was sent. Measured in seconds since the Unix epoch.

​
order_number
string | null

The order number associated with this invoice.

​
portal_url
string | null

A URL that will redirect to this invoice's correct portal page (hosted or external).

​
reminder_notification_sent_at
integer | null

The time at which the reminder notification was sent. Measured in seconds since the Unix epoch.

​
status
string

The current status of this invoice, which can be one of draft, open, paid or void.

​
checkout

Expandable – The associated checkout ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.