| Field | Type | Required | Description | Example |
|---|---|---|---|---|
amount |
int | ✔️ | The amount of the sale. Should be passed in cents. | |
payment_processor |
operations.PaymentProcessor | ✔️ | The payment processor via which the sale was made. | |
external_id |
Optional[str] | ➖ | This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. | |
customer_id |
OptionalNullable[str] | ➖ | : 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. |
|
event_name |
Optional[str] | ➖ | The name of the sale event. It can be used to track different types of event for example 'Purchase', 'Upgrade', 'Payment', etc. | Purchase |
invoice_id |
OptionalNullable[str] | ➖ | The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID. | |
currency |
Optional[str] | ➖ | The currency of the sale. Accepts ISO 4217 currency codes. | |
metadata |
Dict[str, Any] | ➖ | Additional metadata to be stored with the sale event. | |
lead_event_name |
OptionalNullable[str] | ➖ | The name of the lead event that occurred before the sale (case-sensitive). This is used to associate the sale event with a particular lead event (instead of the latest lead event, which is the default behavior). | Cloned template 1481267 |