Subscriptions API

Code Snippets related to Subscription API

• How to view & export subscription status?
• How to retrieve a coupon Id from the subscription_created webhook event?
• How do I remove/change/add an addon to a subscription that already has one or more addon via APIs (PC 1.0)?
• How can I cancel a subscription using the APIs?
• Retrieve Subscription details on custom thank you page.
• How can I reactivate a subscription using the APIs?
• How to automatically apply coupon only to the first subscription of the customer during sign up?
• How do I automate the offline payments management using Chargebee's APIs?
• Limiting duplicate subscriptions via API
• How do I avoid unpaid invoices for active subscriptions?
• How to edit the cancelled subscription message displayed on the customer portal?
• Error- Non-recurring add-on cannot be added now as invoice is not raised immediately
• ChargeBee::InvalidRequestError "customer[company] : wrong value"
• How to create a subscription/customer without Chargebee's checkout?
• Verify any 16 digit number in Chargebee fields (Luhn Algorithm)
• How to prevent multiple users or subscriptions with the same email address?
• Can I apply contact terms to my existing subscriptions?
• How to configure backdate subscription and invoices?
• Prerequisites for Backdating Subscription actions
• Assign Payment roles via API
• Timezone for Subscription filters in Chargebee
• How can I apply multiple Manual discounts via API to an existing subscription?
• Will a manual discount be shown in the response of the List Subscriptions API?
• Subscription Id is not being received in Chargebee response when transaction is created
• Estimate API for metered line items
• How to reactivate a cancelled subscription using the create_checkout_to_update_a _subscription API call?
• What are the reasons the invoice will not be generated for non-recurring addons?
• How to get the recent subscription of each individual customer via API?
• How can I make a subscription change immediately using API?
• Error 'Should be in valid date format' via API
• How to create a subscription with a future start date using a plan and a charge and invoice the charge alone on subscription creation using Hosted page URL?
• How to add usage via API?
• The remote certificate is invalid according to the validation procedure: RemoteCertificateNameMismatch- DotNet SDK error
• Operation failed as the country entered in the billing address by customer cannot be verified against ip address or card bin number
• How can I retrieve more than one shipping address for a subscription using retrieve_a_subscription API?
• How to add contract terms to an existing subscription without invoicing the un-billed charges

Trial and Plans

Solutions to Plans & Trials in Chargebee.

• How to extend the trial period for a subscription?
• What is the maximum duration of a trial period that I can offer using Chargebee?
• Editing a Plan's Pricing & Billing Frequency
• Is it possible to limit the coupons only to certain plans via the UI?
• Can I change the trial end date for an existing trial subscription?
• How do I create/manage a subscription with users or licences ?
• Can customers get the trial period when moved to a paid plan with trial period from a free plan? When I do this, the subscription is going directly into Active state, instead of the In-Trial state.
• How do I setup paid trial for my plans, in Chargebee?
• Is there any option to add a trial period for a subscription/plan?
• How can I customize prices for some of my plans?
• Is it possible to move an active subscription into trial?
• How to Generate the hosted page URL? - PC 1.0
• How to configure plans with different currencies in bulk?
• My customers are unable to see specific plans on the portal. Why?
• Where to find the drop-in script for the plan-specific URL?
• I want to edit and update Plans and Addons, which API key should I use?
• What happens when I delete a plan in Chargebee?
• Redirect URL not working while integrating the plan using drop-in-script
• Is metered billing site level or can I customize it for a few plans alone?
• Can I set trial period for addons?
• How will invoices be generated for addons in trial?
• The addon trial details are not reflecting when I cancelled and reactivated the subscription
• Limitations of addon trial
• Changing to a plan with different trial days
• Unable to remove trial for a plan
• How to configure trial period for a plan in PC 2.0?
• How do I configure end of trial action?
• How do I set a Free Billing Period (manual free trial) for an existing Active subscription?
• How to restrict trial email content for a 100% coupon customers?
• Effect of “Edit trial end date” on Billing Cycles of a subscription
• Need to extend trial days when the customers add their payment methods during trial period.
• How to add a trial period for an active subscription?

End Customer

• How can I create a customer in Chargebee?
• How to delete the personal data of my customers?
• How to give my customers the credits for the unused period when there is a subscription change?
• How is "Clear Personal Data" different from "Delete Customer"?
• Once PII is deleted for a customer, can a new subscription be created for them?
• How to delete a customer?
• What are the login methods available with Chargebee?
• How can my customers set a password for their self serve portal?
• Bank based payment methods are not coming up for existing customer
• Generate a report that shows add-ons by customer/subscription
• How to validate the login of a user for the website using Chargebee's login credentials?
• Types of addresses added for customers in Chargebee
• How to export list of customers with excess payment?
• Why was PII Data Cleared automatically for customers?
• What does this statement mean: "This customer has signed up but has not set up their Self-Serve Portal account."?‌
• How to Change the Payment Gateway for an Existing Payment Method

Cancellation & Reactivation

• Can I reactivate a subscription by keeping the original term dates of the subscription in place?
• What happens when I schedule a cancellation?
• How do I cancel a subscription in Chargebee?
• What's the difference between the subscription created, subscription activated and subscription started events?
• How do I configure refunds during cancellations?
• How to cancel subscriptions and refund them in bulk?
• I am not able to refund my customer when I schedule a cancellation
• I can't schedule a cancellation 2 years from today. Why is this happening?
• How to retain credit on subscription cancellation?
• How to send an email notification with a link to update the billing address?
• Expected execution of subscription cancellation reason codes
• Can I update or make changes to a canceled Subscription?
• Error : Cannot schedule cancellation beyond subscription end date
• Why I'm getting an error 'Subscription cannot be updated as it is scheduled for cancellation at end of current term'?
• I want my user to reactivate the canceled subscription from Portal
• Error: Reactivate from date should be in past
• Error: Reactivation date is incompatible with plan terms
• How to prevent the subscription cancelled due to no card reason and avoid churn?
• Error: Scheduled date for changes occurs beyond the permissible duration

Subscription Management

Subscription Management

• How to change next billing for multiple subscriptions?
• Can I change the plan of an existing subscription on behalf of the customer ?
• How do I collect the setup fee upfront for a trial subscription?
• Can I construct the admin console URL for direct access to Chargebee page from your application?
• How to get a list of all subscriptions in the customer details page for Reseller type business- (above 20 subscriptions)?
• How do I add or remove coupons in Subscriptions?
• How to filter the list the plans in cancelled state by source? Where can I view the source?
• How do I setup Gift Subscriptions in Chargebee Using Checkout V2?
• How can I delete a subscription in Chargebee?
• How to restrict certain addons for specific plans?
• What is the difference between price override and creating customer specific plans or addons?
• Can I add multiple subscriptions to a single invoice?
• How to enable Proration Settings in Chargebee
• How do I get yearlong subscriptions where customer has to pay us monthly but for 12 months minimum?
• Calendar Billing date not applied for a few subscriptions
• How to retrieve the next billing date of a subscription?
• Can we have multiple subscriptions in Chargebee?
• Is there any option to stop a subscription.?
• How do I change my subscription status from Non-Renewing to Active?
• What happens to Subscription and other entities once the subscription is paused?
• How can we pause a subscription?
• Error- Non-recurring addon cannot be added now as invoice is not raised immediately
• Unable to create a subscription: “Cannot create the subscription as there is no valid card on file”. How do I proceed?
• My customers cannot add addons to their existing subscription
• Subscription Status as Active when payment failed on renewal
• Bulk action to extend the trial period by a few days/months from the Subscription Index page
• Extra charges applied while creating a quote from an existing subscription
• How to change the term end date for a specific subscription?
• Can I get an automatic notification with the cancellation reason when a user cancels a subscription?
• Can I make changes to a subscription at a specific future date?
• How to add a non-recurring addon (or Charges for PC 2.0) when a subscription is in the canceled state?
• My customer is unable to edit coupons in an “in-trial” subscription
• When does a subscription cancel in Chargebee?
• How to cancel subscriptions with an unpaid invoice?
• My customer has added a payment method but they are not being charged automatically for payments. Why is this happening?
• Will a new plan price affect the existing subscriptions?
• What happens when Auto collection is switched OFF at the subscription level?
• How to differentiate a subscription that is canceled within the trial period or after activation?
• What happens when I change the price of a subscription after having issued an advance invoice?
• I am not able to change the price of an existing subscription.
• Can I restrict having one subscription per customer?
• How do I create a zero-dollar or zero cost plan in Chargebee?
• How to set metered billing for a plan with base fee/without base fee? - PC 2.0
• Can I collect advance payment from customers for multiple months and do the billing monthly or quarterly?
• Don't provide credit notes while downgrading/changing a subscription
• How to create a subscription which will start in future?
• How to get event contents from Chargebee's UI?
• How to change plan pricing in PC 2.0?
• How to record advance payments made by customer that can be applied for future invoices?
• How to change a parent-child relationship? - Account hierarchy
• Can I cancel a paused subscription?
• How to view, copy & edit the Customer ID?
• Is It Possible To Backdate A Subscription In Chargebee?
• How is tax calculated for a backdated subscription?
• How to reactivate subscriptions in bulk?
• How to create separate subscriptions interval from billing interval
• How can I cancel manually a subscription item (e.g. addon) to the end of term?
• Edit the resumption date of a paused subscription
• How to reactivate subscription when credit card detail is entered?
• Error : ChargeBee_InvalidRequestException
• Unable to edit the free quantity in per-unit price plans
• How to change the billing cycles & frequency on an existing subscription?
• How do I see which subscriptions were cancelled last month?
• Unable to find customer using last 4 digits of their credit card.
• How to perform a bulk operation to override subscription price for a specific plan?
• How to apply a coupon while reactivating a cancelled subscription?
• How to extend the pause date for a subscription?
• How can I preview subscription before creating?
• "You must have one active reason to display on self-serve portal" error
• Can a Child's company name be displayed in the Parent's Invoice?
• How to change the plan of a canceled subscription without reactivation?
• How to create a subscription with a higher first payment and lower subsequent payments?
• How does Payment Terms with Auto Collection "On" work?
• Is it possible to move the subscription's start date once it's activated?
• Error: “Sorry, the operation has been cancelled as it took more than expected time to complete. Please try again after some time.”
• Edit Subscription Error - Changing subscriptions term/trial period is not allowed
• Account hierarchy and proration calculation
• Maximum number of days for Pause Subscription
• Why am I not able to find the existing plan price point in the list of plans while changing a subscription in my PC 2.0 site?
• How to fetch historical subscription data that is more than 12 months data old?
• Reason Codes Error “Sorry the url or the some of the parameters are not valid”
• Metered Add-ons not included in MRR calculations.Why?
• How can I offer credits to customers at the time of signup?
• One of my subscriptions says E-Mandate not set. I’m unable to receive recurring payments from such subscriptions.
• How can I override unbilled charges for a specific customer?
• How to configure self-serve calendar billing for E-Commerce business?
• How to configure self-serve calendar billing for SaaS business?
• Customers are unable to update subscriptions via portal - RazorPay gateway
• Can a normal plan be subscribed as a gift plan?
• Why do we not send Modified "Next billing date" as an event when using the Bill Future Renewal feature.
• I added metadata to a non-renewing subscription, and the subscription status changed to Active, why?
• Is it possible to assign payment methods specific to location?
• Error: The next renewal date cannot be the same as the current renewal date.
• Can account hierarchy be overriden at a subscription level?
• Is it possible to bill customers monthly for their usages by using an Metered Addon when the Plan of subscription is Yearly?
• How to add a charge to the upcoming renewal ?
• How do I restore a deleted Subscription? Undoing Delete operation

UI - Issues (Leap+Classic)

• Can we apply the setup cost while changing a subscription in PC 1.0 sites?

Contract Terms

• How to set termination fee for Contract terms?
• How to configure Contract Terms?
• Error “Subscription is in contract so you cannot pause” while pausing the subscription
• Unable to backdate subscription cancellation when a contract term is applied

Gift Subscription

• Is it possible to merge customers that have gift subscriptions?
• Possible to Change billing date of gift subscription?

Currencies

• How can I change the base currency of my Chargebee site?
• Can I update the currency of an existing subscription?
• What is multi-decimal support in Chargebee? How does it work?
• How to configure multi-decimal support in Chargebee?
• What are Zero decimal currencies?
• Euro currency display on invoice PDF - Symbol is displayed in the incorrect order.
• Currency must be EUR for a sepa_core mandate

Migration

• How do I migrate subscriptions from Stripe to Chargebee while continuing to use Stripe as my payment gateway?
• How do I migrate subscriptions from a different billing system to Chargebee while using Stripe as my payment gateway?
• How to raise a migration request with Chargebee?
• Self Migration of data
• What are the prerequisites for self migration?

Entitlement

• What is entitlement in Chargebee? How to configure it in Chargebee?
• Creating features - Entitlement Management
• Adding product entitlement for a feature - Entitlement Management
• Activating Features - entitlement management
• I am unable to access some feature in Entitlement.
• How to modify product entitlements for a feature
• How to view the entitlement section in a subscription?
• How to find the plans that are associated with a feature using API?
• What are the User Access Control limitations for Entities?
• Keeping track of updated Entitlements at Subscriptions level.
• How is the total value of quantity-based entitlements calculated?

Orders

• How to automate orders in Chargebee?
• Retrieving order information from Chargebee.
• We only ship products to our customers during a certain time of the month (or particular day of the month). How can this be setup?
• I'm cancelling a subscription, how can I ensure that the unfulfilled orders alone are refunded?
• How to resend Orders in Chargebee?
• How to export order reference IDs?
• The order has not been generated automatically while creating one invoice with a Quick charge only. Why?
• Can we change the order status back to Queued from Awaiting Shipment?

Bulk Operations

• What bulk operations can I perform in Chargebee?
• How can I import multiple coupons into Chargebee using Bulk operations?
• File size limit exceeded. Allowed size is ‘20000000’ bytes.
• Bulk upload subscriptions for an existing customer: Parallel processing of data
• How to export subscriptions specific to a recurring addon?
• How to change the net payment terms for customers in bulk?
• Where can I export non-recurring addons or charges in Chargebee?
• Extract new trial customers contact details on a daily basis
• How to export customers data of all active subscribers?
• How can I export a list of customers with their billing and shipping addresses?
• How to migrate offline customers into Chargebee?
• While performing bulk operations, all the columns are consolidated into a single column in the template upload file.
• import subscriptions with their original sign up date: Sequentially iterating each data
• How to export list of customers who has payment method with auto-collection 'OFF'?
• Why are the emails masked while bulk uploading on the test site?
• How to disable or remove the trial period from the multiple price points of multiple plans in bulk on PC 2.0 Chargebee site?
• I am getting the “the column () appears more than once in file” while importing data into Chargebee. How can I fix this?
• How to update customers' auto collection in bulk?
• How to view and export the Card billing address information?
• How to update plan tier range prices for existing subscriptions in bulk?
• How to list the items that belong to the same Product family?
• How to update customers as safe from fraud status in bulk?
• How to fetch the list of customers with multiple active subscriptions from the Chargebee UI?
• How to exports customer records with additional contacts?
• “Subscription[Start_Date] should not be passed for cancelled subscription” error while importing subscriptions via Bulk operation.

Custom Fields

• Pre-filling/Passing custom fields to hosted pages (via Plan URL)
• Can custom fields be displayed in the customer portal and checkout pages?
• Is it possible to filter set custom fields as filters via the APIs?
• How to delete a Custom Field?
• How to display custom fields to customers?
• How do I create a Custom Field in my Chargebee account?
• What is Meta Data?
• How to rearrange fields in Chargebee?
• How to create a custom mandatory field?
• How to pass values to custom fields using in-app scripts?
• Error message: "There were errors while submitting" "cannot be blank".drop-in script with custom fields

Coupons and Coupon Sets

• How can I pass coupon directly to the checkout page, without the users having to enter it manually?
• How do I apply Coupons to subscriptions?
• How to create a Coupon in PC 2.0?
• Error - coupon Id is 'already exists' while creating coupon
• What are coupons sets?
• How is coupon validity different from coupon duration?
• What is the order type in which coupons are applied?
• How to disable 'multiple coupons for a subscription'?
• How to delete a coupon?
• How to add a coupon for a specific plans? - PC 1.0
• How to unarchive a coupon that was accidentally archived?
• Bulk apply coupons to subscriptions
• How to find out list of coupon code‌s redeemed by the customer?
• How to configure manual discounting?
• How do coupons and taxes work on Chargebee’s checkout page?
• What does it mean when a coupon is marked as 'Exhausted'?
• Why coupon redemption count is more than the coupons actually applied to the Subscription?
• How my customer used the one-time coupon twice on the same subscription. How to prevent this from happening?

Pause Subscription

• Why do I see “Advance charges will be issued as credits to this customer at the time Subscription pause” message while pausing a subscription?

Account Hierarchy

• Reseller model

Configuration

• Updating the backend chargebee-typescript lib to version 2.22.0

Manual Discount

• Difference between coupons and manual discounts

Reason codes

• My custom reason codes are not showing up during the subscription cancellation process.
• Export reasons chosen by my customers when canceling their subscriptions - RS