Skip to content

The Invoice entity at YouCan.

Attribute NameTypeDescription
idstringIdentifier (UUID)
amountfloatTotal invoice amount
paid_amountfloatAmount already paid
statusstringTranslated status label (e.g. "Paid", "Pending") — do not use for logic as it varies by locale
payment_gatewaystring, nullPayment gateway used (e.g. "Stripe"), null if not applicable
descriptionstringDynamically generated description based on invoice type (subscription, domain, credit, app charge, etc.)
created_atstringCreation date (ISO 8601, store timezone)
updated_atstringLast update date (ISO 8601, store timezone)
paid_atstring, nullPayment date (ISO 8601, store timezone), null if unpaid
deleted_atstring, nullDeletion date (ISO 8601), null if not deleted
links.pdfstringURL to download the invoice as a PDF