New in Chargebee: Explore Reveal and understand your payment performance end-to-end.Try Now

Docschargebeedocs

HomeBillingPaymentsRevRecGrowthReveal
Support

Product Updates

  • Release Notes

Getting Started

  • Overview
  • Chargebee Billing Data Centers
  • Object Relationship Model
  • Understanding Sites
  • Chargebee Tech Glossary
  • Articles and FAQ

Implementing Chargebee

  • Implementation Guide
  • Go-live Checklist
  • Articles and FAQ

AI in Chargebee

  • Chargebee Agents
  • Chargebee Copilot
  • Chargebee MCP Server (Model Context Protocol)

Developer Resources

  • Developer Resources Overview
  • Articles and FAQ

Product Catalog

  • Product Catalog Overview
  • Coupons
  • Articles and FAQ

Subscriptions

  • Working with Subscriptions
    • Multi-Frequency Billing
    • Subscription Ramps
    • Next Billing Date
    • Trial Management
    • Price Override
    • Pause Subscription
    • Subscription Cancellation
    • Reactivation
    • Gift Subscriptions
    • Backdating Subscriptions and Invoices
    • Managing Contract Terms
    • Manual Discounts
  • Billing
  • Orders
  • Articles and FAQ

Customers

  • Managing Customers
  • Account Hierarchy
  • Email Notifications
  • Branding
  • Configure Multiple Languages
  • Articles and FAQ

Entitlements

  • Entitlements Overview
  • Features Overview
  • Feature Management
  • Managing Product Entitlements
  • Subscription Entitlements
  • Customer Entitlements
  • Grandfathering Entitlements
  • Articles and FAQ

Usage Based Billing

  • Understanding Usages
  • Setting up Usage Based Billing
  • Usage Alerts
  • Metered Billing
  • Articles and FAQ

Chargebee CPQ

  • Chargebee CPQ
  • Chargebee CPQ for Salesforce
  • Chargebee CPQ for HubSpot

Invoices, Credit Notes, and Quotes

  • Invoices
  • Credit Notes
  • Quotes [Legacy]
  • Transactions
  • Articles and FAQ

Taxes

  • Overview
  • Configuring Taxes
  • Country-specific Taxes
  • Articles and FAQ

Hosted Capabilities

  • Overview
  • Hosted Checkout
  • Hosted Self-Serve Portal
  • Hosted Pages Features
  • Additional Hosted Pages
  • Payment Components
  • Pricing Table
  • Managing Payments with Chargebee.js
  • Mobile-Optimized Hosted Pages
  • Articles and FAQ

Site Configuration

  • Users & Roles
  • Custom Fields & Metadata
  • Approvals
  • Mandatory Fields
  • File Attachments & Comments
  • Advanced Filter Options
  • Multicurrency Pricing
  • Multi-decimal Support
  • Configuring Reason Codes
  • Events and Webhooks
  • API Keys
  • Time Zone
  • Time Machine
  • Transfer Configurations
  • Articles and FAQ

Multi Business Entity

  • Multi Business Entity Overview
  • Customer Transfer Overview
  • Articles and FAQ

Mobile Subscriptions

  • Overview
  • Omnichannel Subscriptions
  • Omnichannel One-Time Orders
  • Mobile Subscriptions (Legacy)

Reports and Analytics

  • RevenueStory
  • Home Dashboard
  • Frequently Asked Questions
  • FAQs for Classic Reports Sunset
  • Articles and FAQ

Integrations

  • Sales
  • Customer Support and Success
  • Finance
  • Tax
  • Marketing
  • Stitch
  • Collaboration
  • Contract Management
  • Ecommerce Management
  • Articles and FAQ

Data Privacy & Security

  • Two Factor Authentication
  • SAML Single Sign-On
  • System for Cross-Domain Identity Management (SCIM)
  • EU-GDPR
  • Consent Management
  • Personal Data Management
  • Compliance Certificates
  • HIPAA Guidelines
  • PCI Recommendations and Integration Types
  • Articles and FAQ

Data Operations

  • Bulk Operations
  • Migration
  • Articles and FAQ
  1. Billing
  3. Subscriptions
  5. Working with Subscriptions
  6. Gift Subscriptions
  1. Billing
  3. Subscriptions
  5. Working with Subscriptions
  6. Gift Subscriptions

Gift Subscriptions

Introduction

A great way to acquire new revenue for your business is by allowing your customers to gift subscriptions to family and friends. Gifts could be sent to recipients immediately on sign-up or scheduled for special occasions such as holidays or birthdays.

This way, new prospects are introduced to your products/services, increasing the chances that they may sign up with you once they have experienced the gift plan.

While signing up, your customers can provide contact details of the gift recipient and a personal message to be sent to them. On the date and time chosen by the gifter, a welcome email is sent to the recipient, who may then claim the gift, activating their gift subscription.

Note

Gift subscriptions are supported only with sync payment gateways and are currently not supported with async gateways like Adyen, Checkout.com, GoCardless, Worldline(Direct) (formerly known as Ingenico), WorldPay(Direct), Razorpay.

Gift Subscription Workflow

Let's look at a typical workflow for using gift subscriptions:

image

Once you create gift plans in Chargebee, a customer can sign up for a gift using Checkout:

image

On successful immediate payment by the gifter, a purchase confirmation email is sent to them promptly. Soon after, a gift notification email is sent to the recipient of the gift at the date and time chosen by the gifter:

image

The email allows the gift recipient to claim the gift as shown below:

image

Post claim, the gift subscription gets activated and the gift recipient receives an email confirmation. The gifter is also notified that the gift has been claimed.

Gift subscriptions are non-renewing and therefore are canceled automatically at the end of their term. At this point, the gift recipient can be notified via the subscription cancellation email. Also, you can use the subscription cancellation reminder email to prompt gift recipients to sign up for a regular subscription.

For the last two email notifications mentioned above, use the notification segmenting feature to send them to gift recipients only.

Configuring Gift Subscriptions

Configuring gift subscriptions in your Chargebee site involves the following three steps:

  1. Enabling the gift subscriptions feature.
  2. Configuring gift subscription fields in Checkout and Portal.
  3. Configuring email notifications.

Enabling the gift subscriptions feature

To enable gift subscriptions in your Chargebee site, follow these steps:

  1. Click Settings > Configure Chargebee > Billing LogIQ > Customers & Subscriptions > Gift Subscription > Enable.

    image

  2. Automatically claim gifts: When this setting is enabled, gifts are claimed automatically on the notification date and the gift notification email is skipped. When the setting is turned off (default), gifts must be claimed by the recipients manually.

  3. Allow customers to claim their gifts anytime: When this setting is enabled, gifts are valid forever. They never expire and can be claimed any time. When it is turned off (default), gifts have a period of validity within which they must be claimed, or they expire. Upon expiry, the gift subscription is canceled. You can specify this period under All gifts must be claimed within. The allowed range is 1-365 days.

  4. Click Apply and Confirm.

Information

  • Disabling the gift subscriptions feature does not affect any gifts created in the past.
  • The settings here can be overridden via API.

Configuring gift subscription fields in Checkout and Portal

Note

  • Gifts are only supported for in-app Checkout and Self-Serve Portal.
  • Only online, immediate payment methods are supported for gift subscriptions.

After enabling the gift subscriptions feature in your Chargebee site, configure the following Checkout and Portal settings to enable relevant fields in your hosted pages:

  1. Click Settings > Configure Chargebee > Checkout & Self-Serve Portal > Configuration > Gift Subscriptions.

  2. Click Enable and you can configure the following fields:

    image
    • Allow gifter to schedule when gifts are sent: When turned on, the setting allows gifters to select during checkout, a date and time when the gift notification email is to be sent to the recipient. When turned off, the email is sent immediately on sign-up.
    • Allow gifter to cancel gift until the recipient is notified: You can allow the gifter to cancel the gift from the Self-Serve Portal. It is only allowed as long as the gift is in scheduled status.
    • Allow recipients to cancel gifts from the Self-serve Portal: Allow the recipient of the gift to log in to the Self-serve Portal and cancel the gift subscription.

  3. Click Publish to save your updates.

Configuring Email Notifications

Note: Gift subscriptions are only supported in the latest version of email notifications.

To enable the required email notifications for gift subscriptions, follow these steps:

  1. Navigate to Settings > Configure Chargebee > Email notifications > Gift subscription emails.
  2. You can configure the following emails for notifying the gifters and the gift recipients respectively:

Notifying Gifters

Email NotificationDescription
On gift confirmationOn successful sign-up, this notification is sent to the gifter confirming their purchase.
On gift claim by receiverThis notification is sent to the gifter when the gift is claimed(whether the claim happens via API, auto-claim or by the gift recipient via the gift notification email).
On gift cancellationThis is a confirmation sent to the gifter only when they cancel the gift or the gift is cancelled via API.

Notifying Gift Recipients

Email NotificationDescription
On gift receiptThis is the notification email sent to the gift recipient inviting them to claim their gift. It is not sent when auto-claim is enabled.
X-days(s) after gift is unclaimedThis is a claim reminder email sent to the gift recipient a configurable x-number of days since the gift went into unclaimed status.
On gift claimThis is a confirmation email for claiming the gift and activating the gift subscription. It is sent to the recipient of the gift on gift claim(whether the claim happens via API, auto-claim or by the gift recipient via the gift notification email).

Creating Gift Plans

Once you have configured gift settings in Chargebee, you can create gift plans. Gift plans are those used to create gift subscriptions.

To create a gift plan in your Chargebee site, follow these steps:

  1. Click Product Catalog > Plans > Create Plan.

  2. Enter the plan details and check the box This is a gift plan.

    image

  3. You can also set the Claim Redirect URL for the gift plan to which the recipient will be redirected to after claiming their gift. The domain of this URL must be allow-listed in Chargebee for successful redirection. To do this, go to Settings > Configure Chargebee > Checkout and Self-Serve Portal > Advanced Settings > Add Domains and add the domain name.

  4. Click Create.

The gift plan is successfully created. You can start defining price points for your gift plan as required.

Note

Gift plans cannot be signed up via the Self-serve Portal or created via the Chargebee user interface. They can only be signed up via Checkout or created via API.

Editing Gift Plan

To edit an existing gift plan in your Chargebee site, follow these steps:

  1. Click Product Catalog > Plans > select the plan that you want to edit. You can edit gift plans by using the Edit Plan option on the details page of the gift plan.
  2. The fields that can be edited depend on whether there are subscriptions created for the plan or not.

Gift Status

The status of a gift subscription is affected by status changes in the corresponding gift. The following is the list of possible statuses for gifts:

Gift StatusDescription
ScheduledThe gift has been created and has not yet been notified to the gift recipient or been claimed. At this stage, the gift subscription is created and its status is future.
UnclaimedThe recipient has been notified but the gift is yet to be claimed. The gift subscription status is still future at this stage.
ClaimedThe gift has been claimed. The gift subscription activates, changing status to non-renewing.
ExpiredThe number of days for which the gift can remain unclaimed, has passed. This cancels the gift subscription.
CanceledThe gift has been cancelled. This also cancels the gift subscription.

Note

On changing the status of gift subscription, the gift status is not affected.

Gift Subscription Operations

You can view gift subscriptions and also change the notification date for any of them.

Viewing Gift Subscriptions

You can view all the gift subscriptions in Chargebee by using filters on the Subscriptions page. Set the Is Gift filter to True and click Apply Filter to list all gift subscriptions:

image

Claiming Gifts

Claiming a gift activates the associated gift subscription.

A gift can be claimed in any of the following ways:

  1. By the recipient, from the gift notification email sent to them.
  2. By you, using an API call.
  3. Automatically via auto-claim, when enabled.

Canceling Gifts

Gift subscriptions can be canceled in the following ways:

  • If the setting allows, the gifter may cancel the gift from the Self-Serve Portal so long as the gift is in scheduled status.
image
  • If the setting allows, the recipient can also cancel their gift subscription mid-term from the Self-Serve Portal.
image
  • A gift subscription can be canceled by you from its details page by using the Cancel Immediately button.
  • Gifts can also be automatically canceled after a set number of days of remaining unclaimed.
  • Finally, there is also the gift cancellation API call.

Cancellation Behavior

The site settings for subscription cancellation are not applicable for gift subscriptions. Instead, the following rules apply when gift subscriptions are canceled:

ScenarioBehavior
For unused period of the gift subscriptionNo credits are issued
If there are existing refundable creditsThey are retained as refundable credits
If there are existing unpaid invoicesThey are retained as unpaid
If there are existing unbilled chargesThey are retained as unbilled

Note

Canceled gift subscriptions cannot be reactivated.

Disabling Gift Subscriptions

To disable the gift subscriptions feature in your Chargebee site, follow these steps:

  1. Click Settings > Configure Chargebee > Gift Subscription.
  2. Click Disable.

Disabling this setting automatically removes the Checkout and Self-serve Portal fields and the email notifications related to gift subscriptions.

After you have disabled the gift subscriptions feature in your Chargebee site, customers can no longer gift subscriptions. However, the gift subscriptions given or received in the past will stay unaffected.

Gift API and Events

API

Apart from the gift API that allows you to create, retrieve, list, claim, and cancel gifts, the following is a list of other API calls/parameters that may be used to work with gifts:

  • Plans/Addons/Charges

    • https://apidocs.chargebee.com/docs/api/items#item_is_giftable
    • https://apidocs.chargebee.com/docs/api/items#create_an_item_is_giftable
    • https://apidocs.chargebee.com/docs/api/items#list_items_is_giftable

  • Invoices

    • https://apidocs.chargebee.com/docs/api/invoices#invoice_is_gifted

  • Orders

    • https://apidocs.chargebee.com/docs/api/orders#order_is_gifted

  • Hosted Pages

    • https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_gift_subscription
    • https://apidocs.chargebee.com/docs/api/hosted_pages#claim_a_gift_subscription

  • Exports

    • https://apidocs.chargebee.com/docs/api/exports#export_plans_plan_giftable

Events

Your system can be notified of gift-related events such as gift_scheduled by configuring webhooks.

FAQ

1. I have calendar billing enabled in Chargebee. How do gift subscriptions work with it?

Gift subscriptions are only created on gift claim and are not affected by your calendar billing settings.

2. Can I override the price of a gift plan?

Yes, with Price Override feature enabled on your Billing site, you can override the price of a gift plan. While creating a gift subscription, you can specify a custom price for the chosen price point. Chargebee Billing applies this override only to that particular gift subscription, allowing you to offer tailored pricing without modifying the base plan configuration.

Articles & FAQs

Can a normal plan be subscribed as a gift plan?
How do I setup Gift Subscriptions in Chargebee Using Checkout V2?
Is it possible to merge customers that have gift subscriptions?
Possible to Change billing date of gift subscription?

Was this article helpful?