For AI agents: a machine-readable documentation index is available at /llms.txt. Every documentation page is also available as Markdown by appending .md to its URL.

chargebee api

API Playground Open in Postman

Claim a gift

Open in Postman

Idempotency Supported

Claiming a gift will move the status to 'claimed'. Only gifts in 'unclaimed' state can be claimed.

Sample Request

Open in Postman

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/gifts/{gift-id}/claim

Returns

Gift object

Resource object representing gift

Subscription object

Resource object representing subscription