Retrieve a Partner Reward Link
Resolves the public reward terms and whether redemption capacity remains. Immediate rewards claim capacity at business creation; qualified rewards claim it when the business reaches the threshold.
Headers
Pins the request to a dated API version.
"2026-09-02-2"
Query Parameters
Username from the partner link's a query parameter.
Reward slug from the partner link's reward query parameter.
Response
reward link verified
When the reward stops accepting new claims and qualifying volume, as an ISO 8601 timestamp. Null when it does not expire.
Onboarding reward ID, prefixed onbr_.
"onbr_xxxxxxxxxxxxxx"
Partner whose link attributed this reward.
Required qualifying volume. Null for an immediate reward.
Income source whose volume qualifies the business. Null for an immediate reward.
sales, ad_spend, null "sales"
Whether the attributed business met the requirement. Null before a business claims the link.
Qualifying volume accumulated by the attributed business. Null before a business claims the link and for immediate rewards.
Reward value delivered after qualification.
How the reward is delivered.
ad_credit, balance_credit "balance_credit"
Whether the reward was credited to the attributed business. Null before a business claims the link.
Whether the reward can still be claimed: available, fully_claimed, expired, or unavailable.
available, fully_claimed, expired, unavailable "available"

