The useReferrals hook provides methods to create and redeem referral codes as part of a referral program.
Parameters
The ID of your referral program.
Returns
data
The referral code response. The hook starts with enabled: false, so call refetch() to create/fetch the code.
import { useReferrals } from "autumn-js/react";
export default function ReferralCode() {
const { data, refetch, isLoading } = useReferrals({ programId: "refer-a-friend" });
return (
<div>
<button onClick={() => refetch()}>Get My Referral Code</button>
{data && <p>Share this code: {data.code}</p>}
</div>
);
}
{
"code": "REF123ABC",
"customerId": "cus_123",
"createdAt": 1717000000
}
redeemCode()
Redeems a referral code for the current customer.
import { useReferrals } from "autumn-js/react";
export default function RedeemForm() {
const { redeemCode } = useReferrals({ programId: "refer-a-friend" });
const handleRedeem = async (code: string) => {
const result = await redeemCode({ code });
console.log("Redeemed! Reward:", result.rewardId);
};
return <button onClick={() => handleRedeem("REF123ABC")}>Redeem Code</button>;
}
The referral code to redeem.
{
"id": "red_123",
"customerId": "cus_456",
"rewardId": "reward_789"
}
isLoading
Boolean indicating whether a referral code is being created/fetched.
error
Any error that occurred.
refetch()
Creates or fetches the referral code for the configured programId. 
