Skip to main content
GET
/
new-users
/
{productUserId}
/
reward
cURL
curl --request GET \
  --url https://api.cello.so/new-users/{productUserId}/reward \
  --header 'Authorization: Bearer <token>'
{
  "eligible": true,
  "reward": {
    "type": "standard",
    "interval": "month",
    "intervalCount": 3,
    "percentage": 20
  },
  "signupId": "signup_abc123",
  "signupAt": "2024-01-15T10:30:00Z",
  "referralUcc": "ucc_xyz789",
  "campaignId": "campaign_id_123",
  "campaignRevision": "v2"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cello.so/llms.txt

Use this file to discover all available pages before exploring further.

​
Common reasons for eligible: false

If the response is { "eligible": false } even though the user has a cello_ucc, the most common causes are:
  • No active new-user reward on the campaign - the campaign tied to the UCC has no new-user discount configured, or the reward is inactive/expired.
  • productUserId mismatch - the productUserId you passed isn’t the user who actually signed up through the referral.
  • Attribution arrived after the first invoice - cello_ucc was added to the customer after the first invoice.paid; attribution can be retroactive, but reward eligibility is still evaluated against the reward rules.
  • Self-referral - the new user signed up using their own UCC, or the signup was flagged as a self-referral by Cello’s fraud detection. Self-referrals are not eligible for new-user discounts.
To verify, compare referralUcc, campaignId, and campaignRevision from the response (when eligible: true) against what you expect, and check the Review Referrals section in the portal for self-referral flags.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
productUserId
string
required

The Id of the user you want to check

Response

New user reward and eligibility information

​
eligible
boolean
required

Whether the user is eligible for a new user discount

​
reward
object

Discount details if eligible

​
signupId
string

Unique identifier for the signup record

​
signupAt
string<date-time>

ISO 8601 timestamp when the user signed up

​
referralUcc
string

The UCC (Unique Customer Code) that referred this user

​
campaignId
string

The campaign ID associated with the signup

​
campaignRevision
string

The campaign revision used for the reward calculation