# Claim a gift

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Idempotency Supported](/docs/api/idempotency)

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

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G/claim \
     -X POST  \
     -u {site_api_key}:
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Gift.Claim("__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G").Request();

Gift gift = result.Gift;
Subscription subscription = result.Subscription;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    giftAction "github.com/chargebee/chargebee-go/v3/actions/gift"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := giftAction.Claim("__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G").Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Gift := res.Gift
        Subscription := res.Subscription
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.GiftClaimRequest{
    Id : "__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G",
}
  res, err := client.Gift.Claim(req)
      if err != nil {
        fmt.Println(err)
    } else {
        Gift := res.Gift
        Subscription := res.Subscription
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Gift.claim("__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G").request();

        Gift gift = result.gift();
        Subscription subscription = result.subscription();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.gift.Gift;
import com.chargebee.v4.models.gift.params.GiftClaimParams;
import com.chargebee.v4.models.gift.responses.GiftClaimResponse;
import com.chargebee.v4.models.subscription.Subscription;

public class GiftClaim {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        GiftClaimResponse response = client.gifts().claim("__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G");

        Gift gift = response.getGift();
        Subscription subscription = response.getSubscription();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.gift.claim("__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G");

    console.log(result);
    const gift = result.gift;
    const subscription = result.subscription;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->gift()->claim("__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G");
$gift = $result->gift;
$subscription = $result->subscription;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Gift.claim("__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G")
gift = response.gift
subscription = response.subscription
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::Gift.claim("__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G")

gift = result.gift
subscription = result.subscription
```

## Sample Response

```json
{
  "gift": {
    "auto_claim": false,
    "gift_receiver": {
      "customer_id": "receiver",
      "email": "james@user.com",
      "first_name": "James",
      "last_name": "William",
      "object": "gift_receiver",
      "subscription_id": "__test__KyVnHhSBWTK149H"
    },
    "gift_timelines": [
      {
        "object": "gift_timeline",
        "occurred_at": 1517674289,
        "status": "claimed"
      },
      {..}
    ],
    "gifter": {
      "customer_id": "gifter",
      "invoice_id": "__demo_inv__2",
      "object": "gifter",
      "signature": "John"
    },
    "id": "__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G",
    "no_expiry": true,
    "object": "gift",
    "resource_version": 1517674289000,
    "scheduled_at": 1517501493,
    "status": "claimed",
    "updated_at": 1517674289
  },
  "subscription": {
    "activated_at": 1517674289,
    "base_currency_code": "USD",
    "billing_period": 1,
    "billing_period_unit": "month",
    "cancelled_at": 1520093489,
    "created_at": 1517501488,
    "currency_code": "USD",
    "current_term_end": 1520093489,
    "current_term_start": 1517674289,
    "customer_id": "receiver",
    "deleted": false,
    "due_invoices_count": 0,
    "exchange_rate": 1,
    "gift_id": "__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G",
    "has_scheduled_changes": false,
    "id": "__test__KyVnHhSBWTK149H",
    "mrr": 0,
    "object": "subscription",
    "plan_amount": 10000,
    "plan_free_quantity": 0,
    "plan_id": "GiftPlan$100",
    "plan_quantity": 1,
    "plan_unit_price": 10000,
    "remaining_billing_cycles": 0,
    "resource_version": 1517674289000,
    "started_at": 1517674289,
    "status": "non_renewing",
    "updated_at": 1517674289
  }
}
```

## URL Format

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

## Returns

- `gift` (Gift object)
  Resource object representing gift

- `subscription` (Subscription object)
  Resource object representing subscription