Product Catalog
    Library
You are viewing the documentation for Chargebee API V2. If you're using the older version (V1), click here.

Gifts

Gift represents a subscription of a customer(recipient) to a 'gift plan' which has been gifted by another customer(gifter). It may also have addons and coupons. Gift will be created only on immediate successful payment collection from the gifter's payment method.

Gift is initially created in 'scheduled' state. The gift can be scheduled to be notified on a particular date to the recipient by passing 'scheduled_at'. If not, the recipient is notified immediately. Gift will be moved to 'unclaimed' state on the date of notification. If you pass auto_claim as true, gift status will be moved to ‘claimed’ immediately, otherwise, the gift will remain 'unclaimed' till the recipient claims the gift.

If the gift is not claimed before the claim_expiry_date, it will be moved to the 'expired' state.

GIFT SUBSCRIPTION

Gift subscriptions will be created in 'future' state. Once the gift is claimed, the subscription will be moved to 'non-renewing' state.

INVOICE

Gift subscriptions will be invoiced immediately. The invoice created has is_gifted as 'true' and term_finalized as 'false'. This is because initially the invoice term_start and term_end are set as the subscription's start_date till the end of the plan period. Once the gift is claimed, the invoice's term_finalized will be marked as 'true'. The term_start will be changed to the actual invoice's term, which is the gift-claim date and the term_end will be changed till plan's period.

Sample gift [ JSON ]

{ "auto_claim": false, "claim_expiry_date": 1525850488, "gift_receiver": { "customer_id": "receiver", "email": "james@user.com", "first_name": "James", "last_name": "William", "object": "gift_receiver", "subscription_id": "__test__8asuuSB15GTGh" }, "gift_timelines": [{ "object": "gift_timeline", "occurred_at": 1517469689, "status": "scheduled" }], "gifter": { "customer_id": "gifter", "invoice_id": "__demo_inv__1", "object": "gifter", "signature": "Sam" }, "id": "__test__8asuuSB15GYVo__test__sfsBDu8yg3K6cFiTkMu3cdNcF5Hz9NufM", "no_expiry": false, "object": "gift", "resource_version": 1517469689000, "scheduled_at": 1518074488, "status": "scheduled", "updated_at": 1517469689 }

API Index URL GET

https://{site}.chargebee.com/api/v2/gifts

Gift attributes

id
string, max chars=150
Uniquely identifies a gift
status
enumerated string
Status of the gift.
Possible values are
scheduledGift has been scheduled.unclaimedGift is not yet claimed and is ready to be claimed.claimedGift is claimed.cancelledGift is cancelled.expiredGift is expired.
scheduled_at
optional, timestamp(UTC) in seconds
Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
auto_claim
boolean, default=false
When true, the claim happens automatically. When not passed, the default value in the site settings is used.
no_expiry
boolean
When true, indicates that the gift does not expire. Do not pass or pass as false when auto_claim is set.
claim_expiry_date
optional, timestamp(UTC) in seconds
The date until which the gift can be claimed. Must be set to a value after scheduled_at. If the gift is not claimed within claim_expiry_date, it will expire and the subscription will move to cancelled state. When not passed, the value specified in the site settings will be used. Pass as NULL or do not pass when auto_claim or no_expiry are set.
resource_version
optional, long
Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
updated_at
optional, timestamp(UTC) in seconds
Timestamp indicating when this gift resource was last updated.
gifter
Show attributes[+]
gifter
Gifter details
Gifter attributes
customer_id
string, max chars=50
Gifter customer id.
invoice_id
optional, string, max chars=50
Invoice raised on the gifter.
signature
optional, string, max chars=50
Gifter sign-off name
note
optional, string, max chars=500
Personalized message for the gift.
gift_receiver
Show attributes[+]
gift_receiver
Receiver details
Gift receiver attributes
customer_id
string, max chars=50
Receiver customer id.
subscription_id
string, max chars=50
Subscription created for the gift.
first_name
optional, string, max chars=150
First name of the receiver as given by the gifter.
last_name
optional, string, max chars=150
Last name of the receiver as given by the gifter,
email
optional, string, max chars=70
Email of the receiver. All gift related emails are sent to this email.
gift_timelines
Show attributes[+]
optional, list of gift_timeline
Gift timeline details
Gift timeline attributes
status
enumerated string
Status of the gift.
Possible values are
scheduledGift has been scheduled.unclaimedGift is not yet claimed and is ready to be claimed.claimedGift is claimed.cancelledGift is cancelled.expiredGift is expired.
occurred_at
optional, timestamp(UTC) in seconds
Timestamp indicating when this event occurred.

Create a gift subscription for items

Idempotency Supported
Create a gift subscription with items like plans, addons, or charges and gift it to an existing customer.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/gifts/create_for_items \
     -u {site_api_key}:\
     -d scheduled_at=1518074488 \
     -d gifter[customer_id]="gifter" \
     -d gifter[signature]="Sam" \
     -d gift_receiver[customer_id]="receiver" \
     -d gift_receiver[first_name]="James" \
     -d gift_receiver[last_name]="William" \
     -d gift_receiver[email]="james@user.com" \
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[quantity][0]=2 \
     -d subscription_items[item_price_id][1]="day-pass-USD"
copy
curl  https://{site}.chargebee.com/api/v2/gifts/create_for_items \
     -u {site_api_key}:\
     -d scheduled_at=1518074488 \
     -d gifter[customer_id]="gifter" \
     -d gifter[signature]="Sam" \
     -d gift_receiver[customer_id]="receiver" \
     -d gift_receiver[first_name]="James" \
     -d gift_receiver[last_name]="William" \
     -d gift_receiver[email]="james@user.com" \
     -d subscription_items[item_price_id][0]="basic-USD" \
     -d subscription_items[quantity][0]=2 \
     -d subscription_items[item_price_id][1]="day-pass-USD"

Sample Response [ JSON ]

Show more...
{ "gift": { "auto_claim": false, "claim_expiry_date": 1525850488, "gift_receiver": { "customer_id": "receiver", "email": "james@user.com", "first_name": "James", "last_name": "William", "object": "gift_receiver", "subscription_id": "__test__8asuuSB15GTGh" }, "gift_timelines": [ { "object": "gift_timeline", "occurred_at": 1517469689, "status": "scheduled" }, {..} ], "gifter": { "customer_id": "gifter", "invoice_id": "__demo_inv__1", "object": "gifter", "signature": "Sam" }, "id": "__test__8asuuSB15GYVo__test__sfsBDu8yg3K6cFiTkMu3cdNcF5Hz9NufM", "no_expiry": false, "object": "gift", "resource_version": 1517469689000, "scheduled_at": 1518074488, "status": "scheduled", "updated_at": 1517469689 }, "invoice": { "adjustment_credit_notes": [], "amount_adjusted": 0, "amount_due": 0, "amount_paid": 2500, "amount_to_collect": 0, "applied_credits": [], "base_currency_code": "USD", "billing_address": { "first_name": "John", "last_name": "Doe", "object": "billing_address", "validation_status": "not_validated" }, "credits_applied": 0, "currency_code": "USD", "customer_id": "gifter", "date": 1517469688, "deleted": false, "due_date": 1517469688, "dunning_attempts": [], "exchange_rate": 1, "first_invoice": true, "has_advance_charges": true, "id": "__demo_inv__1", "is_gifted": true, "issued_credit_notes": [], "line_items": [ { "amount": 2000, "customer_id": "receiver", "date_from": 1612768888, "date_to": 1615188088, "description": "basic USD", "discount_amount": 0, "entity_id": "basic-USD", "entity_type": "plan_item_price", "id": "li___test__8asuuSB15GVNj", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "per_unit", "quantity": 2, "subscription_id": "__test__8asuuSB15GTGh", "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_orders": [], "linked_payments": [ { "applied_amount": 2500, "applied_at": 1517469689, "txn_amount": 2500, "txn_date": 1517469689, "txn_id": "txn___test__8asuuSB15GXhl", "txn_status": "success" }, {..} ], "net_term_days": 0, "new_sales_amount": 2500, "object": "invoice", "paid_at": 1517469689, "price_type": "tax_exclusive", "recurring": true, "resource_version": 1517469689000, "round_off_amount": 0, "status": "paid", "sub_total": 2500, "tax": 0, "term_finalized": false, "total": 2500, "updated_at": 1517469689, "write_off_amount": 0 }, "subscription": { "billing_period": 1, "billing_period_unit": "month", "created_at": 1517469688, "currency_code": "USD", "customer_id": "receiver", "deleted": false, "due_invoices_count": 0, "gift_id": "__test__8asuuSB15GYVo__test__sfsBDu8yg3K6cFiTkMu3cdNcF5Hz9NufM", "has_scheduled_changes": false, "id": "__test__8asuuSB15GTGh", "next_billing_at": 1615188088, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1517469689000, "start_date": 1612768888, "status": "future", "subscription_items": [ { "amount": 2000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 2, "unit_price": 1000 }, {..} ], "updated_at": 1517469689 } }

URL Format POST

https://{site}.chargebee.com/api/v2/gifts/create_for_items

Input Parameters

scheduled_at
optional, timestamp(UTC) in seconds
Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
auto_claim
optional, boolean
When true, the claim happens automatically. When not passed, the default value in the site settings is used.
no_expiry
optional, boolean
When true, indicates that the gift does not expire. Do not pass or pass as false when auto_claim is set. .
claim_expiry_date
optional, timestamp(UTC) in seconds
The date until which the gift can be claimed. Must be set to a value after scheduled_at. If the gift is not claimed within claim_expiry_date, it will expire and the subscription will move to cancelled state. When not passed, the value specified in the site settings will be used. Pass as NULL or do not pass when auto_claim or no_expiry are set.
coupon_ids[0..n]
optional, list of string
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
+
gifter
Parameters for gifter
pass parameters as gifter[<param name>]
gifter[customer_id]
required, string, max chars=50
Gifter customer id.
gifter[signature]
required, string, max chars=50
Gifter sign-off name
gifter[note]
optional, string, max chars=500
Personalized message for the gift.
gifter[payment_src_id]
optional, string, max chars=40
Identifier of the payment source
+
gift_receiver
Parameters for gift_receiver
pass parameters as gift_receiver[<param name>]
gift_receiver[customer_id]
required, string, max chars=50
Receiver customer id.
gift_receiver[first_name]
required, string, max chars=150
First name of the receiver as given by the gifter.
gift_receiver[last_name]
required, string, max chars=150
Last name of the receiver as given by the gifter,
gift_receiver[email]
required, string, max chars=70
Email of the receiver. All gift related emails are sent to this email.
+
payment_intent
Parameters for payment_intent
pass parameters as payment_intent[<param name>]
payment_intent[id]
optional, string, max chars=150
Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
payment_intent[gateway_account_id]
required if payment intent token provided, string, max chars=50
The gateway account used for performing the 3DS flow.
payment_intent[gw_token]
optional, string, max chars=65k
Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
payment_intent[payment_method_type]
optional, enumerated string
The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
Possible values are
cardcardidealidealsofortsofortbancontactbancontact
google_paygoogle_paydotpaydotpaygiropaygiropayapple_payapple_payupiupinetbanking_emandatesnetbanking_emandatespaypal_express_checkoutpaypal_express_checkoutdirect_debitdirect_debitboletoboleto
Show all values[+]
payment_intent[reference_id]
optional, string, max chars=65k
Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
payment_intent[additional_information]
optional, jsonobject
  • checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
    • payer: User related information.
      • country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
      • document: Document ID is the user’s identification number based on their country.
  • bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
    • fraud: Fraud identification related information.
  • braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
    • fraud: Fraud identification related information.
      • device_session_id: Session ID associated with the user's device.
      • fraud_merchant_id: Your merchant ID for fraud detection.
  • chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
    • fraud: Fraud identification related information.
      • fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
+
shipping_address
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
shipping_address[first_name]
optional, string, max chars=150
The first name of the contact.
shipping_address[last_name]
optional, string, max chars=150
The last name of the contact.
shipping_address[email]
optional, string, max chars=70
The email address.
shipping_address[company]
optional, string, max chars=250
The company name.
shipping_address[phone]
optional, string, max chars=50
The phone number.
shipping_address[line1]
optional, string, max chars=150
Address line 1
shipping_address[line2]
optional, string, max chars=150
Address line 2
shipping_address[line3]
optional, string, max chars=150
Address line 3
shipping_address[city]
optional, string, max chars=50
The name of the city.
shipping_address[state_code]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
shipping_address[state]
optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.
shipping_address[zip]
optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
shipping_address[country]
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

Note: If you enter an invalid country code, the system will return an error.

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

shipping_address[validation_status]
optional, enumerated string, default=not_validated
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
+
subscription_items
Parameters for subscription_items. Multiple subscription_items can be passed by specifying unique indices.
pass parameters as subscription_items[<param name>][<idx:0..n>]
subscription_items[item_price_id][0..n]
optional, string, max chars=100
The unique identifier of the item price.
subscription_items[quantity][0..n]
optional, integer, default=1, min=1
The quantity of the item purchased
subscription_items[quantity_in_decimal][0..n]
optional, string, max chars=33
The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.

Returns

gift
always returned
Resource object representing gift
subscription
always returned
Resource object representing subscription
invoice
optional
Resource object representing invoice

Retrieve a gift

Retrieves a gift subscription. This API accepts the gift ‘id’ and returns the gift along with the subscription.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTKhSAD__test__XF08jFEYWbAon3fSbc3IriS1N4UNhacdS \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTKhSAD__test__XF08jFEYWbAon3fSbc3IriS1N4UNhacdS \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{ "gift": { "auto_claim": false, "claim_expiry_date": 1525277496, "gift_receiver": { "customer_id": "receiver", "email": "james@user.com", "first_name": "James", "last_name": "William", "object": "gift_receiver", "subscription_id": "__test__KyVnHhSBWTKfDA7" }, "gift_timelines": [ { "object": "gift_timeline", "occurred_at": 1517501491, "status": "scheduled" }, {..} ], "gifter": { "customer_id": "gifter", "invoice_id": "__demo_inv__6", "object": "gifter", "signature": "John" }, "id": "__test__KyVnHhSBWTKhSAD__test__XF08jFEYWbAon3fSbc3IriS1N4UNhacdS", "no_expiry": false, "object": "gift", "resource_version": 1517501491000, "scheduled_at": 1517501496, "status": "scheduled", "updated_at": 1517501491 }, "subscription": { "billing_period": 1, "billing_period_unit": "month", "created_at": 1517501491, "currency_code": "USD", "customer_id": "receiver", "deleted": false, "due_invoices_count": 0, "gift_id": "__test__KyVnHhSBWTKhSAD__test__XF08jFEYWbAon3fSbc3IriS1N4UNhacdS", "has_scheduled_changes": false, "id": "__test__KyVnHhSBWTKfDA7", "next_billing_at": 1614615096, "object": "subscription", "plan_amount": 10000, "plan_free_quantity": 0, "plan_id": "GiftPlan$100", "plan_quantity": 1, "plan_unit_price": 10000, "remaining_billing_cycles": 1, "resource_version": 1517501491000, "start_date": 1612195896, "status": "future", "updated_at": 1517501491 } }

URL Format GET

https://{site}.chargebee.com/api/v2/gifts/{gift_id}

Returns

gift
always returned
Resource object representing gift
subscription
always returned
Resource object representing subscription

List gifts

Retrieves the list of gifts.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/gifts \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2 \
     --data-urlencode status[is]="scheduled"
copy
curl  https://{site}.chargebee.com/api/v2/gifts \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2 \
     --data-urlencode status[is]="scheduled"

Sample Response [ JSON ]

Show more...
{ "list": [ { "gift": { "auto_claim": true, "gift_receiver": { "customer_id": "receiver", "email": "james@user.com", "first_name": "James", "last_name": "William", "object": "gift_receiver", "subscription_id": "__test__KyVnHhSBWTKZn9w" }, "gift_timelines": [ { "object": "gift_timeline", "occurred_at": 1517501490, "status": "scheduled" }, {..} ], "gifter": { "customer_id": "gifter", "invoice_id": "__demo_inv__5", "object": "gifter", "signature": "John" }, "id": "__test__KyVnHhSBWTKc1A2__test__DVeEFlt0Io1pxooTbvEgPrvmsY7vbgk8", "no_expiry": false, "object": "gift", "resource_version": 1517501490000, "scheduled_at": 1517501495, "status": "scheduled", "updated_at": 1517501490 }, "subscription": { "billing_period": 1, "billing_period_unit": "month", "created_at": 1517501490, "currency_code": "USD", "customer_id": "receiver", "deleted": false, "due_invoices_count": 0, "gift_id": "__test__KyVnHhSBWTKc1A2__test__DVeEFlt0Io1pxooTbvEgPrvmsY7vbgk8", "has_scheduled_changes": false, "id": "__test__KyVnHhSBWTKZn9w", "next_billing_at": 1614615095, "object": "subscription", "plan_amount": 10000, "plan_free_quantity": 0, "plan_id": "GiftPlan$100", "plan_quantity": 1, "plan_unit_price": 10000, "remaining_billing_cycles": 1, "resource_version": 1517501490000, "start_date": 1612195895, "status": "future", "updated_at": 1517501490 } }, {..} ], "next_offset": "[\"462000000004\"]" }

URL Format GET

https://{site}.chargebee.com/api/v2/gifts

Input Parameters

limit
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
offset
optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
Filter Params
For operator usages, see the Pagination and Filtering section.
status[<operator>]
optional, enumerated string filter
Status of the gift. Possible values are : scheduled, unclaimed, claimed, cancelled, expired.
Supported operators : is, is_not, in, not_in

Example → status[is] = "claimed"
+
gift_receiver
Parameters for gift_receiver
pass parameters as gift_receiver[<param name>][<operator>]
gift_receiver[email][operator]
optional, string filter
Email of the receiver. All gift related emails are sent to this email.
Supported operators : is, is_not, starts_with

Example → gift_receiver[email][is] = "john@test.com"
gift_receiver[customer_id][operator]
optional, string filter
Receiver customer id.
Supported operators : is, is_not, starts_with

Example → gift_receiver[customer_id][is] = "1xRt6ifdr"
+
gifter
Parameters for gifter
pass parameters as gifter[<param name>][<operator>]
gifter[customer_id][operator]
optional, string filter
Gifter customer id.
Supported operators : is, is_not, starts_with

Example → gifter[customer_id][is_not] = "1xRt6ifdr"

Returns

gift
always returned
Resource object representing gift
subscription
always returned
Resource object representing subscription
next_offset
optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter “offset”.

Claim a gift

Idempotency Supported
Claiming a gift will move the status to ‘claimed’. Only gifts in ‘unclaimed’ state can be claimed.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G/claim \
     -X POST  \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G/claim \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{ "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
always returned
Resource object representing gift
subscription
always returned
Resource object representing subscription

Cancel a gift

Idempotency Supported
This API allows to cancel gifts. Only gift in ‘scheduled’ and ‘unclaimed’ states can be cancelled.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTJsq9A__test__Y3tQPFRGBG1DZEFsDztdQMlBxpQcdkTcdM/cancel \
     -X POST  \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTJsq9A__test__Y3tQPFRGBG1DZEFsDztdQMlBxpQcdkTcdM/cancel \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{ "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__KyVnHhSBWTJpi94" }, "gift_timelines": [ { "object": "gift_timeline", "occurred_at": 1517501489, "status": "scheduled" }, {..} ], "gifter": { "customer_id": "gifter", "invoice_id": "__demo_inv__1", "object": "gifter", "signature": "John" }, "id": "__test__KyVnHhSBWTJsq9A__test__Y3tQPFRGBG1DZEFsDztdQMlBxpQcdkTcdM", "no_expiry": true, "object": "gift", "resource_version": 1517501489000, "scheduled_at": 1517501493, "status": "cancelled", "updated_at": 1517501489 }, "subscription": { "billing_period": 1, "billing_period_unit": "month", "cancelled_at": 1517501489, "created_at": 1517501488, "currency_code": "USD", "customer_id": "receiver", "deleted": false, "due_invoices_count": 0, "gift_id": "__test__KyVnHhSBWTJsq9A__test__Y3tQPFRGBG1DZEFsDztdQMlBxpQcdkTcdM", "has_scheduled_changes": false, "id": "__test__KyVnHhSBWTJpi94", "mrr": 0, "object": "subscription", "plan_amount": 10000, "plan_free_quantity": 0, "plan_id": "GiftPlan$100", "plan_quantity": 1, "plan_unit_price": 10000, "resource_version": 1517501489000, "status": "cancelled", "updated_at": 1517501489 } }

URL Format POST

https://{site}.chargebee.com/api/v2/gifts/{gift_id}/cancel

Returns

gift
always returned
Resource object representing gift
subscription
always returned
Resource object representing subscription

Update a gift

Idempotency Supported
Change the date/time at which the gift notification email is to be sent. This only applies to gifts in the scheduled status.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTKnYAO__test__KdVPIxcd0gzgN1seidYQtm0ScuBcUgc3av/update_gift \
     -X POST  \
     -u {site_api_key}:\
     -d comment="Customer called and requested the change." \
     -d scheduled_at=1517587891
copy
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTKnYAO__test__KdVPIxcd0gzgN1seidYQtm0ScuBcUgc3av/update_gift \
     -X POST  \
     -u {site_api_key}:\
     -d comment="Customer called and requested the change." \
     -d scheduled_at=1517587891

Sample Response [ JSON ]

Show more...
{ "gift": { "auto_claim": false, "claim_expiry_date": 1525277496, "gift_receiver": { "customer_id": "receiver", "email": "james@user.com", "first_name": "James", "last_name": "William", "object": "gift_receiver", "subscription_id": "__test__KyVnHhSBWTKkwAI" }, "gift_timelines": [ { "object": "gift_timeline", "occurred_at": 1517501491, "status": "scheduled" }, {..} ], "gifter": { "customer_id": "gifter", "invoice_id": "__demo_inv__7", "object": "gifter", "signature": "John" }, "id": "__test__KyVnHhSBWTKnYAO__test__KdVPIxcd0gzgN1seidYQtm0ScuBcUgc3av", "no_expiry": false, "object": "gift", "resource_version": 1517501491000, "scheduled_at": 1517587891, "status": "scheduled", "updated_at": 1517501491 }, "subscription": { "billing_period": 1, "billing_period_unit": "month", "created_at": 1517501491, "currency_code": "USD", "customer_id": "receiver", "deleted": false, "due_invoices_count": 0, "gift_id": "__test__KyVnHhSBWTKnYAO__test__KdVPIxcd0gzgN1seidYQtm0ScuBcUgc3av", "has_scheduled_changes": false, "id": "__test__KyVnHhSBWTKkwAI", "next_billing_at": 1614615096, "object": "subscription", "plan_amount": 10000, "plan_free_quantity": 0, "plan_id": "GiftPlan$100", "plan_quantity": 1, "plan_unit_price": 10000, "remaining_billing_cycles": 1, "resource_version": 1517501491000, "start_date": 1612195896, "status": "future", "updated_at": 1517501491 } }

URL Format POST

https://{site}.chargebee.com/api/v2/gifts/{gift_id}/update_gift

Input Parameters

scheduled_at
required, timestamp(UTC) in seconds
The new date/time at which the gift notification email is to be sent. The value must be greater than current time. If no_expiry is false then the value must also be less than claim_expiry_date.
comment
optional, string, max chars=250
An internal comment for this action. The comments are not retrievable via API and are only available on request via Chargebee Support.

Returns

gift
always returned
Resource object representing gift
subscription
always returned
Resource object representing subscription