Offer
A cashback offer from a retailer.string
Stable identifier, e.g.
"nike". Use it for offers.get(), openOffer() and trackingUrl().string
Display name, e.g.
"Nike".string | null
Retailer’s domain, e.g.
"nike.com". Searched by offers.list({ search }).string | null
Category label, e.g.
"Fashion and Apparel". Filterable with offers.list({ category }).string | null
ISO 3166-1 alpha-2 country code the offer applies to, e.g.
"US".string | null
URL of the retailer’s logo, or
null if none is available.Cashback | null
The cashback rate, or
null if the offer currently has no cashback.boolean
Whether you’ve featured this offer in the publisher portal. Pinned offers are returned first by
offers.list().boolean
Whether the
deeplink tracking option is honoured for this offer.string | null
Tracked-link template with
{PublisherClickID}, {SubId} and {DeepLink} placeholders, or null if click tracking isn’t available. Don’t use this directly; use openOffer() or trackingUrl().Cashback
"percentage" | "flat"
Whether
amount is a percentage of the sale or a fixed amount.number
The rate. For
"percentage", a value like 3.2 means 3.2%. For "flat", a currency amount.string
ISO 4217 currency code. Present for
"flat" cashback.Member
A signed-in Cashback Hive member.string
Stable member identifier.
string
The member’s email address.
string | null
Display name, if set.
object
string
ISO 8601 timestamp of account creation.
ActivityItem
A single cashback transaction.string
Transaction identifier.
string
Slug of the offer the purchase was made through.
string
Retailer display name at the time of the transaction.
"pending" | "confirmed" | "paid" | "declined"
Where the transaction is in its lifecycle.
number
The purchase amount reported by the retailer.
number
Cashback earned.
0 for declined transactions.string
ISO 4217 currency code.
string
ISO 8601 timestamp of the purchase.
TypeScript declarations
The SDK is a plain script and doesn’t ship its own types. Copy this file into your project (for exampletypes/cashback-hive.d.ts) and ensure it’s included by your tsconfig.json. It declares window.CashbackHive, window.onCashbackHiveReady, and the cbh:ready event.
types/cashback-hive.d.ts
window.addEventListener("cbh:ready", e => …) infers e as CbhReadyEvent, and window.CashbackHive is typed as CashbackHiveSdk | undefined.