API Version
Product Catalog
Library

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

Model Class

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.
Show all values[+]
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.
required, gifter
Gifter details
gift_receiver
Show attributes [+]
required, gift_receiver
Receiver details
gift_timelines
Show attributes [+]
optional, list of gift_timeline
Gift timeline details
id id
string, max chars=150
Uniquely identifies a gift
status status
enumerated string
Status of the gift.
scheduled_at 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 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 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 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 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 updated_at
optional, timestamp(UTC) in seconds
Timestamp indicating when this gift resource was last updated.
gifter
gifter
Gifter details
gift_receiver
gift_receiver
Receiver details
gift_timelines
optional, list of gift_timeline
Gift timeline details
Create a gift subscription with items like plans, addons, or charges and gift it to an existing customer.

Notes

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
Click to Copy

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

Method

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, default=false
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]][0..n]
optional, list of string
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
gifter[customer_id]
required, string, max chars=50
gifter[signature]
required, string, max chars=50
gifter[note]
optional, string, max chars=500
gifter[payment_src_id]
optional, string, max chars=40
gift_receiver[customer_id]
required, string, max chars=50
gift_receiver[first_name]
required, string, max chars=150
gift_receiver[last_name]
required, string, max chars=150
gift_receiver[email]
required, string, max chars=70
payment_intent[id]
optional, string, max chars=150
payment_intent[gateway_account_id]
required if payment intent token provided, string, max chars=50
payment_intent[gw_token]
optional, string, max chars=65k
payment_intent[payment_method_type]
optional, enumerated string
Possible values are
cardcardidealidealsofortsofortbancontactbancontact
Show all values[+]
payment_intent[reference_id]
optional, string, max chars=65k
payment_intent[additional_information]
optional, jsonobject
shipping_address[first_name]
optional, string, max chars=150
shipping_address[last_name]
optional, string, max chars=150
shipping_address[email]
optional, string, max chars=70
shipping_address[company]
optional, string, max chars=250
shipping_address[phone]
optional, string, max chars=50
shipping_address[line1]
optional, string, max chars=150
shipping_address[line2]
optional, string, max chars=150
shipping_address[line3]
optional, string, max chars=150
shipping_address[city]
optional, string, max chars=50
shipping_address[state_code]
optional, string, max chars=50
shipping_address[state]
optional, string, max chars=50
shipping_address[zip]
optional, string, max chars=20
shipping_address[country]
optional, string, max chars=50
shipping_address[validation_status]
optional, enumerated string, default=not_validated
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.
Show all values[+]
subscription_items[item_price_id][0..n]
optional, string, max chars=100
subscription_items[quantity][0..n]
optional, integer, default=1, min=1
subscription_items[quantity_in_decimal][0..n]
optional, string, max chars=33
gift gift
always returned
Resource object representing gift
subscription subscription
always returned
Resource object representing subscription
invoice invoice
optional
Resource object representing invoice

Sample admin console URL

https://{site}.chargebee.com/admin-console/gifts/123x
Retrieves a gift subscription. This API accepts the gift ‘id’ and returns the gift along with the subscription.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTKhSAD__test__XF08jFEYWbAon3fSbc3IriS1N4UNhacdS \
     -u {site_api_key}:
copy
Click to Copy

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}

Method

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

Sample admin console URL

https://{site}.chargebee.com/admin-console/gifts/123x
Retrieves the list of gifts.

Notes

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
Click to Copy

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

Method

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"
status[is][operator]
optional, enumerated string filter
Possible values are : scheduled, unclaimed, claimed, cancelled, expired
Supported operators :

Example
status[is_not][operator]
optional, enumerated string filter
Possible values are : scheduled, unclaimed, claimed, cancelled, expired
Supported operators :

Example
status[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
status[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
gift_receiver[<operator>]
required, string filter
Parameters for gift_receiver Possible values are :
Supported operators : email, customer_id

Example gift_receiver[email] = "undefined"
gift_receiver[email][operator]
optional, string filter
Email of the receiver. All gift related emails are sent to this email. Possible values are :
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. Possible values are :
Supported operators : is, is_not, starts_with

Example gift_receiver[customer_id][is] = "1xRt6ifdr"
gifter[<operator>]
required, string filter
Parameters for gifter Possible values are :
Supported operators : customer_id

Example gifter[customer_id] = "undefined"
gifter[customer_id][operator]
optional, string filter
Gifter customer id. Possible values are :
Supported operators : is, is_not, starts_with

Example gifter[customer_id][is] = "1xRt6ifdr"
gift gift
always returned
Resource object representing gift
subscription subscription
always returned
Resource object representing subscription
next_offset 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`.

Sample admin console URL

https://{site}.chargebee.com/admin-console/gifts/123x
Claiming a gift will move the status to ‘claimed’. Only gifts in ‘unclaimed’ state can be claimed.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTK3l9N__test__ydFDqluaE3CT6DkcdbI5SNhpzjXlrnh5G/claim \
     -X POST  \
     -u {site_api_key}:
copy
Click to Copy

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

Method

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

Sample admin console URL

https://{site}.chargebee.com/admin-console/gifts/123x
This API allows to cancel gifts. Only gift in ‘scheduled’ and ‘unclaimed’ states can be cancelled.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTJsq9A__test__Y3tQPFRGBG1DZEFsDztdQMlBxpQcdkTcdM/cancel \
     -X POST  \
     -u {site_api_key}:
copy
Click to Copy

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

Method

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

Sample admin console URL

https://{site}.chargebee.com/admin-console/gifts/123x
Change the date/time at which the gift notification email is to be sent. This only applies to gifts in the scheduled status.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/gifts/__test__KyVnHhSBWTKnYAO__test__KdVPIxcd0gzgN1seidYQtm0ScuBcUgc3av/update_gift \
     -u {site_api_key}:\
     -d comment="Customer called and requested the change." \
     -d scheduled_at=1517587891
copy
Click to Copy

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

Method

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

Sample admin console URL

https://{site}.chargebee.com/admin-console/gifts/123x