FirstPromoter icon

FirstPromoter

Interact with the official FirstPromoter APIs

Tracking → Track Refund

AI-generated

Summary

Track a refund event within the FirstPromoter system by providing details about the refund transaction.

Inputs

  • Email — Email of the user lead/referral (optional, but either Email or UID must be provided).
  • UID — UID (User ID) of the lead/referral (optional, but either Email or UID must be provided).
  • Amount (required) — The refund amount in cents; for zero-decimal currencies like JPY, amount should be whole values.
  • Event ID — Transaction or sale event ID to prevent duplicates.
  • Currency — Currency code if different from FirstPromoter's default.
  • Quantity — Number of subscriptions/items being refunded; optional if quantity is 1.
  • Sale Event ID — The event ID of the original sale for which this refund is processed; should match the sale event_id for accurate tracking.

Output shape

a single JSON object in an array containing the API response for the tracked refund event

Requires either Email or UID to identify the user lead/referral; the operation sends a POST request to FirstPromoter's /track/refund endpoint; Amount is required and must be specified according to currency rules.

Examples

Example 1: Track a refund of 1234 cents for a user identified by email

Provide Email, Amount, Event ID, and optionally Currency, Quantity, and Sale Event ID

Links

Discussion