Skip to content
FRAGMENT
API Reference

Invoices

Create
invoices.create(InvoiceCreateParams**kwargs) -> InvoiceCreateResponse
POST/invoices
List
invoices.list() -> InvoiceListResponse
GET/invoices
List History
invoices.list_history(strid) -> InvoiceListHistoryResponse
GET/invoices/{id}/history
Retrieve
invoices.retrieve(strid) -> InvoiceRetrieveResponse
GET/invoices/{id}
Search
invoices.search(InvoiceSearchParams**kwargs) -> InvoiceSearchResponse
POST/invoices/search
Update
invoices.update(strid, InvoiceUpdateParams**kwargs) -> InvoiceUpdateResponse
PATCH/invoices/{id}
ModelsExpand Collapse
class Invoice: …

Invoice object

id: str

Unique identifier for the invoice

created: datetime

ISO 8601 timestamp when the invoice was created

formatdate-time
Deprecatedstatus: Literal["active"]

Deprecated: The status of the invoice

tags: List[Tag]

Metadata tags for this invoice

key: str

Tag key

value: str

Tag value

version: float

The current version of the invoice. Pass this value when updating to ensure thread safety.

workspace_id: str

Workspace ID this invoice belongs to

line_items: Optional[List[LineItem]]

List of line items associated with this invoice

id: str

Unique identifier for the line item

Deprecatedamount: str

Deprecated: use price.amount instead. Total amount in smallest currency unit (represented as string for bigint)

currency_code: Literal["ADA", "BTC", "DAI", 176 more]

Currency code (ISO 4217 or crypto)

Accepts one of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
description: str

Description of the line item

price: LineItemPrice

Price breakdown containing amount, unit price, and quantity

amount: str

Total amount in smallest currency unit (represented as string for bigint)

quantity: int

Quantity of units for this line item

unit_price: str

Unit price in smallest currency unit (represented as string for bigint)

product_id: str

ID of the product/catalog item

tags: List[LineItemTag]

Metadata tags for this line item

key: str

Tag key

value: str

Tag value

type: Literal["payin", "payout"]

The type of the line item

Accepts one of the following:
"payin"
"payout"
user_id: str

External ID of the user associated with this line item

modified: Optional[datetime]

ISO 8601 timestamp when the invoice was last modified

formatdate-time