Skip to main content
POST
Claim

Authorizations

Authorization
string
header
required

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-07-2"

Path Parameters

id
string
required

The public claim code from the c parameter in the claim URL. A claim-link ID does not authorize redemption.

Response

claim link claimed

A shareable link anyone holding its code can open to claim the funds.

amount
string
required

Amount each claim receives.

Example:

"25.00"

claim_url
string | null
required

Shareable claim URL. Null when retrieving by ID without claim-link management access.

Example:

"https://whop.com/claim"

claimable
boolean
required

Whether this link can currently be claimed.

Example:

false

code
string | null
required

Redeemable claim code. Null when retrieving by ID without claim-link management access.

Example:

"demoClaim123"

created_at
string<date-time>
required
Example:

"2026-01-01T12:00:00.000Z"

currency
string
required
Example:

"usd"

expires_at
string<date-time> | null
required
Example:

null

id
string
required

Claim-link ID, prefixed airdrp_.

Example:

"airdrp_xxxxxxxxxxxxxx"

object
enum<string>
required
Available options:
claim_link
Example:

"claim_link"

redeemable_count
integer
required

Maximum number of claims.

Example:

1

redeemed_count
integer
required

Number of completed claims.

Example:

1

remaining_claims
integer
required

Number of available claims, excluding slots reserved by pending claims.

Example:

0

sender
ClaimLinkSenderAccount · object
required

The public account or user funding the claim link.

source
object
required
status
enum<string>
required

The link's lifecycle status. A newly funded link is pending. Check claimable for current availability, including expiry and reserved claims.

Available options:
pending,
fully_claimed,
canceled,
expired
Example:

"fully_claimed"