| Field | Type | Required | Description | Example |
|---|---|---|---|---|
customerId |
string | ✔️ | This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. | |
amount |
number | ✔️ | The amount of the sale. Should be passed in cents. | |
paymentProcessor |
operations.PaymentProcessor | ✔️ | The payment processor via which the sale was made. | |
eventName |
string | ➖ | The name of the sale event. It can be used to track different types of event for example 'Purchase', 'Upgrade', 'Payment', etc. | Purchase |
invoiceId |
string | ➖ | The invoice ID of the sale. | |
currency |
string | ➖ | The currency of the sale. Accepts ISO 4217 currency codes. | |
metadata |
Record<string, any> | ➖ | Additional metadata to be stored with the sale event. |