Invoices
Get Invoices
Retrieves the invoices.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Optionalpage
integerperPage
integerMust be at least 1. Must not be greater than 100.
orderColumn
string"id" | "price_usd" | "paid_usd" | "created_at" | "completed_at"
orderDirection
string"asc" | "desc"
id
stringstatuses
array<string>email
stringgateways
array<string>created_at_start
stringMust be a valid date.
created_at_end
stringMust be a valid date. Must be a date after created_at_start.
completed_at_start
stringMust be a valid date.
completed_at_end
stringMust be a valid date. Must be a date after completed_at_start.
product_name
stringvariant_name
stringcoupon_code
stringip
stringdiscord_id
stringdiscord_username
stringdeliverable
stringcustom_field
stringarchived
stringmanual
stringstripe_pi_id
stringpaypal_order_id
stringcashapp_note
stringpaypalff_note
stringvenmo_note
stringcustomer_id
stringPath Parameters
shopId
RequiredintegerGet Invoice
Retrieves a specific invoice.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerinvoiceId
RequiredstringArchive Invoice
Marks an invoice as archived.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerinvoiceId
RequiredstringUnarchive Invoice
Marks an invoice as unarchived.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerinvoiceId
RequiredstringCancel Invoice
Marks an invoice as cancelled.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerinvoiceId
RequiredstringRefund Invoice
Marks an invoice as refunded.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerinvoiceId
RequiredstringUpdate Invoice Dashboard Note
Updates the invoice dashboard note.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerinvoiceId
RequiredstringAuthorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerinvoiceId
RequiredstringProcess Invoice
Processes an invoice.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerinvoiceId
RequiredstringReplace Delivered
Replaces the delivered items of an invoice.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Requiredinvoice_item_id
Requiredintegerreplacements
RequiredobjectPath Parameters
shopId
RequiredintegerinvoiceId
Requiredstring