API Reference
Log in
API Reference

Invoice

Event List

Event NameEvent TypeTrigger ConditionData Structure
Invoice Paidinvoice.paidWhen an invoice is paid successfully.Invoice
Invoice Payment Failedinvoice.payment_failedWhen an attempt to pay an invoice failsInvoice

Event Object

Attribute

Type

Description

Example

id

uint64

Unique identifier for the invoice

529582021580696491

subscription_id

uint64

ID of the associated subscription plan

529582012596497323

customer_id

string

Unique identifier for the customer on Subotiz

529582012424532946

sub_merchant_id

string

Merchant ID

123061

amount

string

Invoice amount

0

currency

string

Currency

USD

status

string

Invoice status: open- Initiated/Open success- Paid failed- Payment failed refunded- Fully refunded partially_refunded-Partially refunded

success

paid_at

string

Invoice payment time

2025-07-01T08:49:53Z

invoice_type

string

Invoice type: initial-Initial payment trail- Trial period renewal-Renewal refund-Refund

trial

created_at

string

Creation time

2025-07-01T08:49:50Z

updated_at

string

Last update time

2025-07-01T08:49:50Z

cycle_index

Int

Index of billing cycle. For trial, the index is 0.

1

cycle_start

string

Start time of the billing cycle

2025-07-01T08:49:50Z

cycle_end

string

End time of the billing cycle

2025-07-01T08:49:50Z

order_id

string

Your platform's external order ID

order_123456