Introducing the Better Auth Chargebee plugin: Use it to handle subscriptions, billing, and auth seamlessly.Try now
Chargebeechargebee API

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

Sample Result[JSON]

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, 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
optional, string, max chars=100

List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.

meta_data
optional, jsonobject

A collection of key-value pairs that provides extra information about the subscription.

Constraints

  • Character limit: 65,535.
gifter
Parameters for gifter
pass parameters as gifter[<param name>]
gift_receiver
Parameters for gift_receiver
pass parameters as gift_receiver[<param name>]
payment_intent
Parameters for payment_intent
pass parameters as payment_intent[<param name>]
shipping_address
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
subscription_items[0..n]
Parameters for subscription_items. Multiple subscription_items can be passed by specifying unique indices.
pass parameters as subscription_items[<param name>][<idx:0..n>]
item_tiers[0..n]
Parameters for item_tiers. Multiple item_tiers can be passed by specifying unique indices.
pass parameters as item_tiers[<param name>][<idx:0..n>]

Returns

gift
Gift object
Resource object representing gift
subscription
Subscription object
Resource object representing subscription
invoice
Invoice object
Resource object representing invoice