Event List

Event Name	Event Type	Trigger Condition	Data Structure
Invoice Paid	invoice.paid	When an invoice is paid successfully.	Invoice
Invoice Payment Failed	invoice.payment_failed	When an attempt to pay an invoice fails	Invoice

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

Example

{
  "id": 572677256258790436,
  "type": "invoice.paid",
  "created": "2025-10-28T06:54:56Z",
  "data": {
    "subscription_id": 572677251968024511,
    "order_id": "order_1761634475936438746",
    "sub_merchant_id": "2816433",
    "cycle_start": "2025-10-28T06:54:00Z",
    "status": "success",
    "invoice_type": "initial",
    "cycle_index": 1,
    "amount": "30",
    "updated_at": "2025-10-28T06:54:56Z",
    "trade_id": "572677233903157186",
    "id": 572677251968040895,
    "cycle_end": "2025-10-28T07:25:00Z",
    "customer_id": "547766341013094363",
    "currency": "USD",
    "paid_at": "2025-10-28T06:54:55Z",
    "created_at": "2025-10-28T06:54:56Z"
  }
}

{
    "id": 572670998545971191,
    "type": "invoice.payment_failed",
    "created": "2025-10-28T06:30:04Z",
    "data": {
        "sub_merchant_id": "2816514",
        "subscription_id": 570837058398981116,
        "cycle_start": "2025-10-26T05:03:00Z",
        "status": "failed",
        "customer_id": "570836074111455077",
        "created_at": "2025-10-26T05:20:01Z",
        "currency": "USD",
        "paid_at": null,
        "invoice_type": "initial",
        "updated_at": "2025-10-28T06:30:04Z",
        "id": 571928511522097676,
        "cycle_index": 1,
        "cycle_end": "2025-11-26T05:03:00Z",
        "amount": "199",
        "order_id": "order_1761195526005115801",
        "trade_id": "571928589088117469"
    }
}