API Reference
API Reference

Object

Invoice entity field reference.


FieldTypeDesc
invoice_idstringInvoice ID
merchant_idstringMerchant ID
trade_idstringTrade ID
subscription_idstringSubscription ID
price_idstringPricing plan ID
customer_idstringSubotiz platform customer_id
order_idstringThird-party order number
original_invoice_idstringOriginal invoice ID, used for refund invoices to reference the original invoice
refund_order_idstringAssociated refund order ID
amountstringPayment amount, truncated to two decimal places
currencystringCurrency
biz_statusstringInvoice status:
  • open: Initialized
  • pending: Processing
  • success: Payment succeeded
  • failed: Payment failed
  • refunded: Fully refunded
  • partially_refunded: Partially refunded
invoice_typestringInvoice type:
  • initial: Initial payment
  • trial: Trial period
  • renewal: Subscription renewal
  • refund: Refund
paid_atstringPayment success time
cycle_indexintCurrent cycle index of the subscription
created_atstringCreation time
metadatamap[string]stringA set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format.
DiscountsDiscountsDiscounts applied to the invoice, including all discount information for this invoice
price_version_idstringPricing plan version ID

Discounts

FieldTypeDesc
current_periodCurrentPeriodDiscount[]The current period's discount details

CurrentPeriodDiscount

FieldTypeDesc
discount_idstringThe unique identifier for the discount
discount_amountstringThe amount discounted
discount_codestringThe discount code used