| Field | Type | Required | Description | Example |
|---|---|---|---|---|
amount |
int | ✔️ | The amount of the sale. Should be passed in cents. | |
paymentProcessor |
Operations\PaymentProcessor | ✔️ | The payment processor via which the sale was made. | |
externalId |
?string | ➖ | This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. | |
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 |
currency |
?string | ➖ | The currency of the sale. Accepts ISO 4217 currency codes. | |
customerId |
?string | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. |
|
invoiceId |
?string | ➖ | The invoice ID of the sale. | |
metadata |
array<string, mixed> | ➖ | Additional metadata to be stored with the sale event. |