Events

Record a payment or refund event on a subscriber.

MethodPOST

/api/v2/events

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.events.create({
  eventType: "SUBSCRIBER_PAYMENT",
  subscriber: "[email protected]",
  data: { amount: 2000, currency: "usd" },
});
if (error) {
  throw error;
}
console.log(data.id, data.eventType);

Response Examples

{
  "id": "evt_abc123",
  "eventType": "SUBSCRIBER_PAYMENT"
}

Records a payment or refund on a subscriber. Permission: subscribers.

eventType is SUBSCRIBER_PAYMENT or SUBSCRIBER_REFUND. subscriber is an email or id. data.amount updates subscriber revenue.

Body Parameters

Name	Type	Description
`eventType`	string	Required. `SUBSCRIBER_PAYMENT` or `SUBSCRIBER_REFUND`.
`subscriber`	string	Required. Subscriber email or id.
`data`	object	Required. Event payload. Use `amount` (integer cents) and optional `currency` / extra keys.

Response Fields

Field	Type	Description
`id`	string	Created event id.
`eventType`	string	`SUBSCRIBER_PAYMENT` or `SUBSCRIBER_REFUND`.

Errors

Status	`name`	When
401	`missing_api_key`	Missing or invalid bearer token
403	`missing_permission`	Token lacks the `subscribers` permission
404	`not_found`	Unknown subscriber
400	`validation_error`	Unsupported `eventType` or invalid payload

PreviousUpdate Tag NextTokens

Body Parameters

Response Fields

Errors

Related