# Update a subscription > For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt). [Idempotency Supported](/docs/api/v2/pcv-1/idempotency) **Note:** - This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started) and pass it as input parameter to this API. - When the **Remove mandatory add-ons from old plan during subscription plan update** setting is [enabled](https://www.chargebee.com/docs/1.0/subscriptions.html#editing-a-subscription_remove-mandatory-addons) on your Chargebee site, all [mandatory addons](/docs/api/attached_items) with the old plan will be automatically removed during the subscription update to a new plan. You can modify the plan, plan quantity and add or remove addons for the subscription. By default the changes are applied immediately and the charges (/credits) are prorated and adjusted with the next billing term. You may also choose to effect the changes at the end of the current term by passing **end\_of\_term** as "true". In this case proration will not be done. Only the parameters that are passed are modified for the subscription. Rest will reflect the existing values. By default, the addons passed are appended to the existing list of addons for this subscription. In case a passed addon already exists for this subscription, quantity value is replaced. If you want to completely replace the addons for this subscription, pass **replace\_addon\_list** as "true". [Card](/docs/api/cards/card-object) and 'vat\_number' attributes can also be passed during subscription update. If they are passed, corresponding Billing Info attributes - the [Billing Address](/docs/api/customers/customer-object) and 'vat\_number' - will be replaced automatically. Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable - If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your checkout form. Take a look at this [Stripe tutorial](https://stripe.com/docs/payments/accept-a-payment-charges) for more details. - If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your checkout form. Please refer this [tutorial](https://www.chargebee.com/tutorials/braintree-js-example.html) for more details. - If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your checkout form. - If you are using the Adyen gateway, you will have to use the Adyen's [Client Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API. - You can also use our [Hosted Pages](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-capabilities) based integration. **Proration Scenario:** A customer changes from a $15 plan to $30 plan after 15 days of a monthly term. He will be charged for $7.50 immediately. The following Credit Note and Invoice will be generated **Credit Note** Prorated credits for Old Plan $7.50 **Invoice** Prorated charges for New Plan $15.00 Total $15.00 Credits ($7.50) **Amount Due** $7.50 Meanwhile downgrading will result in net credits being created which will be applied when the subscription is charged on start of the next term. Learn more about our proration scenarios [here](https://www.chargebee.com/docs/proration.html). **Billing Cycle:** The billing period for a subscription does not change if the plans intervals of both old and new are same. However, if a customer changes to a plan that has different billing interval(say monthly to yearly), the billing period is reset. Customer is charged immediately for the modified subscription after applying credit for the unused period for the old subscription. **Card and VAT number Input:** If they are passed, corresponding [Billing Address](/docs/api/customers/customer-object) attributes and [vat\_number](/docs/api/customers/customer-object) will be replaced. i.e existing values for Billing Address and 'vat\_number' will be cleared and the new values will be set. If an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied. **Advance charges**, if any, will be refunded as credits and a new invoice will be generated on renewal. ## Sample Request ### updates the subscription's plan and replaces the addons associated with it .The changes made will be effective from current end of term. #### cURL ```bash curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkvzp2Yd \ -u {site_api_key}:\ -d plan_id="plan1" \ -d "addons[id][0]"="sub_ssl" \ -d "addons[id][1]"="sub_monitor" \ -d "addons[quantity][1]"=2 \ -d end_of_term="true" ``` #### .NET ```dotnet using ChargeBee.Api; using ChargeBee.Models; ApiConfig.Configure("{site}","{site_api_key}"); EntityResult result = Subscription.Update("__test__KyVnHhSBWkvzp2Yd") .PlanId("plan1") .AddonId(0, "sub_ssl") .AddonId(1, "sub_monitor") .AddonQuantity(1, 2) .EndOfTerm(true) .Request(); Subscription subscription = result.Subscription; Customer customer = result.Customer; Card card = result.Card; Invoice invoice = result.Invoice; List unbilledCharges = result.UnbilledCharges; List creditNotes = result.CreditNotes; ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v3" subscriptionAction "github.com/chargebee/chargebee-go/v3/actions/subscription" "github.com/chargebee/chargebee-go/v3/models/subscription" ) func main() { chargebee.Configure("{site_api_key}","{site}"); res,err := subscriptionAction.Update("__test__KyVnHhSBWkvzp2Yd", &subscription.UpdateRequestParams{ Addons : []*subscription.UpdateAddonParams{ { Id : "sub_ssl", }, { Id : "sub_monitor", Quantity : chargebee.Int32(2), }, }, PlanId : "plan1", EndOfTerm : chargebee.Bool(true), }).Request() if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges CreditNotes := res.CreditNotes } } ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v4" ) func main() { config := &chargebee.ClientConfig{ SiteName: "{site}", ApiKey: "{site_api_key}", } client := chargebee.NewClient(config) req := &chargebee.SubscriptionUpdateRequest{ Addons : []*chargebee.SubscriptionUpdateAddon{ { Id : "sub_ssl", }, { Id : "sub_monitor", Quantity : chargebee.Int32(2), }, }, PlanId : "plan1", EndOfTerm : chargebee.Bool(true), } res, err := client.Subscription.Update("__test__KyVnHhSBWkvzp2Yd", req) if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges CreditNotes := res.CreditNotes } } ``` #### Java ```java import com.chargebee.*; import com.chargebee.ListResult; import com.chargebee.models.*; import com.chargebee.models.enums.*; import java.io.IOException; import java.util.List; public class Sample { public static void main(String args[]) throws IOException, Exception { Environment.configure("{site}", "{site_api_key}"); Result result = Subscription.update("__test__KyVnHhSBWkvzp2Yd") .planId("plan1") .addonId(0, "sub_ssl") .addonId(1, "sub_monitor") .addonQuantity(1, 2) .endOfTerm(true) .request(); Subscription subscription = result.subscription(); Customer customer = result.customer(); Card card = result.card(); Invoice invoice = result.invoice(); List unbilledCharges = result.unbilledCharges(); List creditNotes = result.creditNotes(); } } ``` #### Java ```java import com.chargebee.v4.client.ChargebeeClient; import com.chargebee.v4.models.card.Card; import com.chargebee.v4.models.creditNote.CreditNote; import com.chargebee.v4.models.customer.Customer; import com.chargebee.v4.models.invoice.Invoice; import com.chargebee.v4.models.subscription.Subscription; import com.chargebee.v4.models.subscription.params.SubscriptionUpdateParams; import com.chargebee.v4.models.subscription.responses.SubscriptionUpdateResponse; import com.chargebee.v4.models.unbilledCharge.UnbilledCharge; import java.util.List; public class SubscriptionUpdate { public static void main(String[] args) { ChargebeeClient client = ChargebeeClient.builder() .apiKey("{site_api_key}") .siteName("{site}") .build(); SubscriptionUpdateParams.AddonsParams addon0 = SubscriptionUpdateParams.AddonsParams.builder() .id("sub_ssl") .build(); SubscriptionUpdateParams.AddonsParams addon1 = SubscriptionUpdateParams.AddonsParams.builder() .id("sub_monitor") .quantity(2) .build(); List addonsList = List.of(addon0, addon1); SubscriptionUpdateParams params = SubscriptionUpdateParams.builder() .planId("plan1") .addons(addonsList) .endOfTerm(true) .build(); SubscriptionUpdateResponse response = client .subscriptions() .update("__test__KyVnHhSBWkvzp2Yd", params); Subscription subscription = response.getSubscription(); Customer customer = response.getCustomer(); Card card = response.getCard(); Invoice invoice = response.getInvoice(); List unbilledCharges = response.getUnbilledCharges(); List creditNotes = response.getCreditNotes(); } } ``` #### Node.js ```node import Chargebee from "chargebee"; const chargebee = new Chargebee({ site: "{site}", apiKey: "{site_api_key}", }); try { const result = await chargebee.subscription.update("__test__KyVnHhSBWkvzp2Yd", { addons: [ { id: "sub_ssl" }, { id: "sub_monitor", quantity: 2 } ], plan_id: "plan1", end_of_term: true }); console.log(result); const subscription = result.subscription; const customer = result.customer; const card = result.card; const invoice = result.invoice; const unbilledCharges = result.unbilled_charges; const creditNotes = result.credit_notes; } catch (err) { console.log(err); } ``` #### PHP ```php "{site}", "apiKey" => "{site_api_key}", ]); $result = $chargebee->subscription()->update("__test__KyVnHhSBWkvzp2Yd", [ "addons" => [ [ "id" => "sub_ssl" ], [ "id" => "sub_monitor", "quantity" => 2 ] ], "plan_id" => "plan1", "end_of_term" => true ]); $subscription = $result->subscription; $customer = $result->customer; $card = $result->card; $invoice = $result->invoice; $unbilledCharges = $result->unbilled_charges; $creditNotes = $result->credit_notes; ``` #### Python ```python from chargebee import Chargebee cb_client = Chargebee(api_key="{site_api_key}", site="{site}") response = cb_client.Subscription.update("__test__KyVnHhSBWkvzp2Yd", cb_client.Subscription.UpdateParams( addons=[ cb_client.Subscription.UpdateAddonParams( id="sub_ssl" ), cb_client.Subscription.UpdateAddonParams( id="sub_monitor", quantity=2 ) ], plan_id="plan1", end_of_term=True ) ) subscription = response.subscription customer = response.customer card = response.card invoice = response.invoice unbilled_charges = response.unbilled_charges credit_notes = response.credit_notes ``` #### Ruby ```ruby require 'chargebee' ChargeBee.configure(:site => "{site}", :api_key => "{site_api_key}") result = ChargeBee::Subscription.update("__test__KyVnHhSBWkvzp2Yd",{ :plan_id => "plan1", :addons => [ { :id => "sub_ssl" }, { :id => "sub_monitor", :quantity => 2 } ], :end_of_term => "true" }) subscription = result.subscription customer = result.customer card = result.card invoice = result.invoice unbilled_charges = result.unbilled_charges credit_notes = result.credit_notes ``` ### Resets the subscription's term. #### cURL ```bash curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkx5j2ZC \ -u {site_api_key}:\ -d plan_unit_price=300 \ -d force_term_reset="true" ``` #### .NET ```dotnet using ChargeBee.Api; using ChargeBee.Models; ApiConfig.Configure("{site}","{site_api_key}"); EntityResult result = Subscription.Update("__test__KyVnHhSBWkx5j2ZC") .PlanUnitPrice(300) .ForceTermReset(true) .Request(); Subscription subscription = result.Subscription; Customer customer = result.Customer; Card card = result.Card; Invoice invoice = result.Invoice; List unbilledCharges = result.UnbilledCharges; List creditNotes = result.CreditNotes; ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v3" subscriptionAction "github.com/chargebee/chargebee-go/v3/actions/subscription" "github.com/chargebee/chargebee-go/v3/models/subscription" ) func main() { chargebee.Configure("{site_api_key}","{site}"); res,err := subscriptionAction.Update("__test__KyVnHhSBWkx5j2ZC", &subscription.UpdateRequestParams{ PlanUnitPrice : chargebee.Int64(300), ForceTermReset : chargebee.Bool(true), }).Request() if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges CreditNotes := res.CreditNotes } } ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v4" ) func main() { config := &chargebee.ClientConfig{ SiteName: "{site}", ApiKey: "{site_api_key}", } client := chargebee.NewClient(config) req := &chargebee.SubscriptionUpdateRequest{ PlanUnitPrice : chargebee.Int64(300), ForceTermReset : chargebee.Bool(true), } res, err := client.Subscription.Update("__test__KyVnHhSBWkx5j2ZC", req) if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges CreditNotes := res.CreditNotes } } ``` #### Java ```java import com.chargebee.*; import com.chargebee.ListResult; import com.chargebee.models.*; import com.chargebee.models.enums.*; import java.io.IOException; import java.util.List; public class Sample { public static void main(String args[]) throws IOException, Exception { Environment.configure("{site}", "{site_api_key}"); Result result = Subscription.update("__test__KyVnHhSBWkx5j2ZC") .planUnitPrice(300L) .forceTermReset(true) .request(); Subscription subscription = result.subscription(); Customer customer = result.customer(); Card card = result.card(); Invoice invoice = result.invoice(); List unbilledCharges = result.unbilledCharges(); List creditNotes = result.creditNotes(); } } ``` #### Java ```java import com.chargebee.v4.client.ChargebeeClient; import com.chargebee.v4.models.card.Card; import com.chargebee.v4.models.creditNote.CreditNote; import com.chargebee.v4.models.customer.Customer; import com.chargebee.v4.models.invoice.Invoice; import com.chargebee.v4.models.subscription.Subscription; import com.chargebee.v4.models.subscription.params.SubscriptionUpdateParams; import com.chargebee.v4.models.subscription.responses.SubscriptionUpdateResponse; import com.chargebee.v4.models.unbilledCharge.UnbilledCharge; import java.util.List; public class SubscriptionUpdate { public static void main(String[] args) { ChargebeeClient client = ChargebeeClient.builder() .apiKey("{site_api_key}") .siteName("{site}") .build(); SubscriptionUpdateParams params = SubscriptionUpdateParams.builder() .planUnitPrice(300L) .forceTermReset(true) .build(); SubscriptionUpdateResponse response = client .subscriptions() .update("__test__KyVnHhSBWkx5j2ZC", params); Subscription subscription = response.getSubscription(); Customer customer = response.getCustomer(); Card card = response.getCard(); Invoice invoice = response.getInvoice(); List unbilledCharges = response.getUnbilledCharges(); List creditNotes = response.getCreditNotes(); } } ``` #### Node.js ```node import Chargebee from "chargebee"; const chargebee = new Chargebee({ site: "{site}", apiKey: "{site_api_key}", }); try { const result = await chargebee.subscription.update("__test__KyVnHhSBWkx5j2ZC", { plan_unit_price: 300, force_term_reset: true }); console.log(result); const subscription = result.subscription; const customer = result.customer; const card = result.card; const invoice = result.invoice; const unbilledCharges = result.unbilled_charges; const creditNotes = result.credit_notes; } catch (err) { console.log(err); } ``` #### PHP ```php "{site}", "apiKey" => "{site_api_key}", ]); $result = $chargebee->subscription()->update("__test__KyVnHhSBWkx5j2ZC", [ "plan_unit_price" => 300, "force_term_reset" => true ]); $subscription = $result->subscription; $customer = $result->customer; $card = $result->card; $invoice = $result->invoice; $unbilledCharges = $result->unbilled_charges; $creditNotes = $result->credit_notes; ``` #### Python ```python from chargebee import Chargebee cb_client = Chargebee(api_key="{site_api_key}", site="{site}") response = cb_client.Subscription.update("__test__KyVnHhSBWkx5j2ZC", cb_client.Subscription.UpdateParams( plan_unit_price=300, force_term_reset=True ) ) subscription = response.subscription customer = response.customer card = response.card invoice = response.invoice unbilled_charges = response.unbilled_charges credit_notes = response.credit_notes ``` #### Ruby ```ruby require 'chargebee' ChargeBee.configure(:site => "{site}", :api_key => "{site_api_key}") result = ChargeBee::Subscription.update("__test__KyVnHhSBWkx5j2ZC",{ :plan_unit_price => 300, :force_term_reset => "true" }) subscription = result.subscription customer = result.customer card = result.card invoice = result.invoice unbilled_charges = result.unbilled_charges credit_notes = result.credit_notes ``` ### reactivates a cancelled subscription from a specific date. #### cURL ```bash curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkwhA2Z2 \ -u {site_api_key}:\ -d reactivate_from=1517505689 ``` #### .NET ```dotnet using ChargeBee.Api; using ChargeBee.Models; ApiConfig.Configure("{site}","{site_api_key}"); EntityResult result = Subscription.Update("__test__KyVnHhSBWkwhA2Z2") .ReactivateFrom(1517505689) .Request(); Subscription subscription = result.Subscription; Customer customer = result.Customer; Card card = result.Card; Invoice invoice = result.Invoice; List unbilledCharges = result.UnbilledCharges; List creditNotes = result.CreditNotes; ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v3" subscriptionAction "github.com/chargebee/chargebee-go/v3/actions/subscription" "github.com/chargebee/chargebee-go/v3/models/subscription" ) func main() { chargebee.Configure("{site_api_key}","{site}"); res,err := subscriptionAction.Update("__test__KyVnHhSBWkwhA2Z2", &subscription.UpdateRequestParams{ ReactivateFrom : chargebee.Int64(1517505689), }).Request() if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges CreditNotes := res.CreditNotes } } ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v4" ) func main() { config := &chargebee.ClientConfig{ SiteName: "{site}", ApiKey: "{site_api_key}", } client := chargebee.NewClient(config) req := &chargebee.SubscriptionUpdateRequest{ ReactivateFrom : chargebee.Int64(1517505689), } res, err := client.Subscription.Update("__test__KyVnHhSBWkwhA2Z2", req) if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges CreditNotes := res.CreditNotes } } ``` #### Java ```java import com.chargebee.*; import com.chargebee.ListResult; import com.chargebee.models.*; import com.chargebee.models.enums.*; import java.io.IOException; import java.util.List; import java.sql.Timestamp; public class Sample { public static void main(String args[]) throws IOException, Exception { Environment.configure("{site}", "{site_api_key}"); Result result = Subscription.update("__test__KyVnHhSBWkwhA2Z2") .reactivateFrom(new Timestamp(1517505689L * 1000)) .request(); Subscription subscription = result.subscription(); Customer customer = result.customer(); Card card = result.card(); Invoice invoice = result.invoice(); List unbilledCharges = result.unbilledCharges(); List creditNotes = result.creditNotes(); } } ``` #### Java ```java import com.chargebee.v4.client.ChargebeeClient; import com.chargebee.v4.models.card.Card; import com.chargebee.v4.models.creditNote.CreditNote; import com.chargebee.v4.models.customer.Customer; import com.chargebee.v4.models.invoice.Invoice; import com.chargebee.v4.models.subscription.Subscription; import com.chargebee.v4.models.subscription.params.SubscriptionUpdateParams; import com.chargebee.v4.models.subscription.responses.SubscriptionUpdateResponse; import com.chargebee.v4.models.unbilledCharge.UnbilledCharge; import java.sql.Timestamp; import java.util.List; public class SubscriptionUpdate { public static void main(String[] args) { ChargebeeClient client = ChargebeeClient.builder() .apiKey("{site_api_key}") .siteName("{site}") .build(); SubscriptionUpdateParams params = SubscriptionUpdateParams.builder() .reactivateFrom(new Timestamp(1517505689L * 1000)) .build(); SubscriptionUpdateResponse response = client .subscriptions() .update("__test__KyVnHhSBWkwhA2Z2", params); Subscription subscription = response.getSubscription(); Customer customer = response.getCustomer(); Card card = response.getCard(); Invoice invoice = response.getInvoice(); List unbilledCharges = response.getUnbilledCharges(); List creditNotes = response.getCreditNotes(); } } ``` #### Node.js ```node import Chargebee from "chargebee"; const chargebee = new Chargebee({ site: "{site}", apiKey: "{site_api_key}", }); try { const result = await chargebee.subscription.update("__test__KyVnHhSBWkwhA2Z2", { reactivate_from: 1517505689 }); console.log(result); const subscription = result.subscription; const customer = result.customer; const card = result.card; const invoice = result.invoice; const unbilledCharges = result.unbilled_charges; const creditNotes = result.credit_notes; } catch (err) { console.log(err); } ``` #### PHP ```php "{site}", "apiKey" => "{site_api_key}", ]); $result = $chargebee->subscription()->update("__test__KyVnHhSBWkwhA2Z2", [ "reactivate_from" => 1517505689 ]); $subscription = $result->subscription; $customer = $result->customer; $card = $result->card; $invoice = $result->invoice; $unbilledCharges = $result->unbilled_charges; $creditNotes = $result->credit_notes; ``` #### Python ```python from chargebee import Chargebee cb_client = Chargebee(api_key="{site_api_key}", site="{site}") response = cb_client.Subscription.update("__test__KyVnHhSBWkwhA2Z2", cb_client.Subscription.UpdateParams( reactivate_from=1517505689 ) ) subscription = response.subscription customer = response.customer card = response.card invoice = response.invoice unbilled_charges = response.unbilled_charges credit_notes = response.credit_notes ``` #### Ruby ```ruby require 'chargebee' ChargeBee.configure(:site => "{site}", :api_key => "{site_api_key}") result = ChargeBee::Subscription.update("__test__KyVnHhSBWkwhA2Z2",{ :reactivate_from => 1517505689 }) subscription = result.subscription customer = result.customer card = result.card invoice = result.invoice unbilled_charges = result.unbilled_charges credit_notes = result.credit_notes ``` ### updates the customer's card details.The changes made are effective immediately. #### cURL ```bash curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkwL02Yl \ -u {site_api_key}:\ -d "card[number]"="5105105105105100" \ -d "card[cvv]"="100" \ -d "card[expiry_year]"=2022 \ -d "card[expiry_month]"=12 \ -d end_of_term="false" ``` #### .NET ```dotnet using ChargeBee.Api; using ChargeBee.Models; ApiConfig.Configure("{site}","{site_api_key}"); EntityResult result = Subscription.Update("__test__KyVnHhSBWkwL02Yl") .CardNumber("5105105105105100") .CardCvv("100") .CardExpiryYear(2022) .CardExpiryMonth(12) .EndOfTerm(false) .Request(); Subscription subscription = result.Subscription; Customer customer = result.Customer; Card card = result.Card; Invoice invoice = result.Invoice; List unbilledCharges = result.UnbilledCharges; List creditNotes = result.CreditNotes; ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v3" subscriptionAction "github.com/chargebee/chargebee-go/v3/actions/subscription" "github.com/chargebee/chargebee-go/v3/models/subscription" ) func main() { chargebee.Configure("{site_api_key}","{site}"); res,err := subscriptionAction.Update("__test__KyVnHhSBWkwL02Yl", &subscription.UpdateRequestParams{ Card : &subscription.UpdateCardParams{ Number : "5105105105105100", Cvv : "100", ExpiryYear : chargebee.Int32(2022), ExpiryMonth : chargebee.Int32(12), }, EndOfTerm : chargebee.Bool(false), }).Request() if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges CreditNotes := res.CreditNotes } } ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v4" ) func main() { config := &chargebee.ClientConfig{ SiteName: "{site}", ApiKey: "{site_api_key}", } client := chargebee.NewClient(config) req := &chargebee.SubscriptionUpdateRequest{ Card : &chargebee.SubscriptionUpdateCard{ Number : "5105105105105100", Cvv : "100", ExpiryYear : chargebee.Int32(2022), ExpiryMonth : chargebee.Int32(12), }, EndOfTerm : chargebee.Bool(false), } res, err := client.Subscription.Update("__test__KyVnHhSBWkwL02Yl", req) if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges CreditNotes := res.CreditNotes } } ``` #### Java ```java import com.chargebee.*; import com.chargebee.ListResult; import com.chargebee.models.*; import com.chargebee.models.enums.*; import java.io.IOException; import java.util.List; public class Sample { public static void main(String args[]) throws IOException, Exception { Environment.configure("{site}", "{site_api_key}"); Result result = Subscription.update("__test__KyVnHhSBWkwL02Yl") .cardNumber("5105105105105100") .cardCvv("100") .cardExpiryYear(2022) .cardExpiryMonth(12) .endOfTerm(false) .request(); Subscription subscription = result.subscription(); Customer customer = result.customer(); Card card = result.card(); Invoice invoice = result.invoice(); List unbilledCharges = result.unbilledCharges(); List creditNotes = result.creditNotes(); } } ``` #### Java ```java import com.chargebee.v4.client.ChargebeeClient; import com.chargebee.v4.models.card.Card; import com.chargebee.v4.models.creditNote.CreditNote; import com.chargebee.v4.models.customer.Customer; import com.chargebee.v4.models.invoice.Invoice; import com.chargebee.v4.models.subscription.Subscription; import com.chargebee.v4.models.subscription.params.SubscriptionUpdateParams; import com.chargebee.v4.models.subscription.responses.SubscriptionUpdateResponse; import com.chargebee.v4.models.unbilledCharge.UnbilledCharge; import java.util.List; public class SubscriptionUpdate { public static void main(String[] args) { ChargebeeClient client = ChargebeeClient.builder() .apiKey("{site_api_key}") .siteName("{site}") .build(); SubscriptionUpdateParams.CardParams cardParams = SubscriptionUpdateParams.CardParams.builder() .number("5105105105105100") .cvv("100") .expiryYear(2022) .expiryMonth(12) .build(); SubscriptionUpdateParams params = SubscriptionUpdateParams.builder() .card(cardParams) .endOfTerm(false) .build(); SubscriptionUpdateResponse response = client .subscriptions() .update("__test__KyVnHhSBWkwL02Yl", params); Subscription subscription = response.getSubscription(); Customer customer = response.getCustomer(); Card card = response.getCard(); Invoice invoice = response.getInvoice(); List unbilledCharges = response.getUnbilledCharges(); List creditNotes = response.getCreditNotes(); } } ``` #### Node.js ```node import Chargebee from "chargebee"; const chargebee = new Chargebee({ site: "{site}", apiKey: "{site_api_key}", }); try { const result = await chargebee.subscription.update("__test__KyVnHhSBWkwL02Yl", { card: { number: 5105105105105100, cvv: 100, expiry_year: 2022, expiry_month: 12 }, end_of_term: false }); console.log(result); const subscription = result.subscription; const customer = result.customer; const card = result.card; const invoice = result.invoice; const unbilledCharges = result.unbilled_charges; const creditNotes = result.credit_notes; } catch (err) { console.log(err); } ``` #### PHP ```php "{site}", "apiKey" => "{site_api_key}", ]); $result = $chargebee->subscription()->update("__test__KyVnHhSBWkwL02Yl", [ "card" => [ "number" => "5105105105105100", "cvv" => "100", "expiry_year" => 2022, "expiry_month" => 12 ], "end_of_term" => false ]); $subscription = $result->subscription; $customer = $result->customer; $card = $result->card; $invoice = $result->invoice; $unbilledCharges = $result->unbilled_charges; $creditNotes = $result->credit_notes; ``` #### Python ```python from chargebee import Chargebee cb_client = Chargebee(api_key="{site_api_key}", site="{site}") response = cb_client.Subscription.update("__test__KyVnHhSBWkwL02Yl", cb_client.Subscription.UpdateParams( card=cb_client.Subscription.UpdateCardParams( number="5105105105105100", cvv="100", expiry_year=2022, expiry_month=12 ), end_of_term=False ) ) subscription = response.subscription customer = response.customer card = response.card invoice = response.invoice unbilled_charges = response.unbilled_charges credit_notes = response.credit_notes ``` #### Ruby ```ruby require 'chargebee' ChargeBee.configure(:site => "{site}", :api_key => "{site_api_key}") result = ChargeBee::Subscription.update("__test__KyVnHhSBWkwL02Yl",{ :card => { :number => "5105105105105100", :cvv => "100", :expiry_year => 2022, :expiry_month => 12 }, :end_of_term => "false" }) subscription = result.subscription customer = result.customer card = result.card invoice = result.invoice unbilled_charges = result.unbilled_charges credit_notes = result.credit_notes ``` ## Sample Response ```json { "credit_notes": {}, "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1517505686, "deleted": false, "excess_payments": 0, "id": "__test__KyVnHhSBWkvzp2Yd", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1517505686000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1517505686 }, "subscription": { "activated_at": 1517505686, "billing_period": 1, "billing_period_unit": "month", "created_at": 1517505686, "currency_code": "USD", "current_term_end": 1519924886, "current_term_start": 1517505686, "customer_id": "__test__KyVnHhSBWkvzp2Yd", "deleted": false, "due_invoices_count": 1, "due_since": 1517505686, "has_scheduled_changes": true, "id": "__test__KyVnHhSBWkvzp2Yd", "mrr": 0, "next_billing_at": 1519924886, "object": "subscription", "plan_amount": 895, "plan_free_quantity": 0, "plan_id": "no_trial", "plan_quantity": 1, "plan_unit_price": 895, "resource_version": 1517505686000, "started_at": 1517505686, "status": "active", "total_dues": 895, "updated_at": 1517505686 } } ``` ## URL Format **POST** https://[site].chargebee.com/api/v2/subscriptions/{subscription-id} ## Input Parameters - `plan_id` (optional, string, max chars=100) Identifier of the plan for this subscription. - `plan_quantity` (optional, integer, default=1, min=1) Represents the plan quantity for this subscription. - `plan_unit_price` (optional, in cents, min=0) Amount that will override the plan's default price. The unit depends on the [type of currency](/docs/api/getting-started). If `changes_scheduled_at` is in the past and a `plan_unit_price` is not passed, then the plan's current unit price is considered even if the plan did not exist on the date as of when the change is scheduled. - `setup_fee` (optional, in cents, min=0) Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started) . - `replace_addon_list` (optional, boolean, default=false) Should be true if the existing addons should be replaced with the ones that are being passed. - `mandatory_addons_to_remove` (optional, string, max chars=100) A list of IDs representing the [mandatorily attached addons](/docs/api/attached_items) associated with the plan to which the subscription is being updated. These addons will be removed from the subscription during the subscription update process. - `plan_quantity_in_decimal` (optional, string, max chars=33) The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `plan_unit_price_in_decimal` (optional, string, max chars=39) When [price overriding](https://www.chargebee.com/docs/price-override.html) is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-object#price) is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/getting-started) is enabled. If `changes_scheduled_at` is in the past and a `unit_price_in_decimal` is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled. - `invoice_date` (optional, timestamp(UTC) in seconds) The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if `create_pending_invoices` is set to `true` , and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line\_item\_taxes are computed based on the tax configuration as of `invoice_date`. When passing this parameter, the following prerequisites must be met: - `invoice_date` must be in the past. - `invoice_date` is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December. - It is not earlier than `changes_scheduled_at`, `reactivate_from`, or `trial_end`. - `invoice_immediately` is `true`. . - `start_date` (optional, timestamp(UTC) in seconds) The new start date of a `future` subscription. Applicable only for `future` subscriptions. - `trial_end` (optional, timestamp(UTC) in seconds) The time at which the trial has ended or will end for the subscription. Set it to `0` to have no trial period. **Note** - This is only allowed when the subscription `status` is `future`, `in_trial`, or `cancelled`. - The value must not be earlier than `changes_scheduled_at` or `start_date`. - This parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled` or `in_trial` `status`. Do this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end` is backdated, the subscription immediately goes into `active` or `non_renewing` status. - `billing_cycles` (optional, integer, min=0) The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used. - `terms_to_charge` (optional, integer, min=1) The number of subscription billing cycles to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html). If a new term is started for the subscription due to this API call, then `terms_to_charge` is inclusive of this new term. See description for the `force_term_reset` parameter to learn more about when a subscription term is reset. - `reactivate_from` (optional, timestamp(UTC) in seconds) If the subscription `status` is `cancelled` and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated. **Note:** It is recommended not to pass this parameter along with `changed_scheduled_at`. `reactivate_from` can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met: - Backdating must be enabled for subscription reactivation operations. - The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed. - The date is on or after the last date/time any of the product catalog items of the subscription were changed. - The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, `changes_scheduled_at` cannot be earlier than 14th February. . - `billing_alignment_mode` (optional, enumerated string) Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date) chosen for the site for calendar billing. Only applicable when using calendar billing. Possible enum values: - `immediate` Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly.. - `delayed` Subscription period will be aligned with the configured billing date at the next renewal. - `auto_collection` (optional, enumerated string) Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property. Possible enum values: - `on` Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available. - `off` Automatic collection of charges will not be made for this subscription. Use this for offline payments. - `offline_payment_method` (optional, enumerated string) The preferred offline payment method for the subscription. Possible enum values: - `no_preference` No Preference - `cash` Cash - `check` Check - `bank_transfer` Bank Transfer - `ach_credit` ACH Credit - `sepa_credit` SEPA Credit - `boleto` Boleto - `us_automated_bank_transfer` US Automated Bank Transfer - `eu_automated_bank_transfer` EU Automated Bank Transfer - `uk_automated_bank_transfer` UK Automated Bank Transfer - `jp_automated_bank_transfer` JP Automated Bank Transfer - `mx_automated_bank_transfer` MX Automated Bank Transfer - `custom` Custom - `po_number` (optional, string, max chars=100) Purchase order number for this subscription. - `coupon_ids` (optional, string, max chars=100) List of coupons to be applied to this subscription. You can provide coupon ids or [coupon codes](/docs/api/coupon_codes). If `changes_scheduled_at` is in the past, then the currently available coupons can be used even if they were not available as of the date for when the change is scheduled. - `replace_coupon_list` (optional, boolean, default=false) If `true` then the existing `coupon_ids` list for the subscription is replaced by the one provided. If `false` then the provided list gets added to the existing `coupon_ids` . - `prorate` (optional, boolean) - When `true`: [Prorated credits or charges](https://www.chargebee.com/docs/1.0/proration.html#proration-mechanism) are created as applicable for this change. - When `false`: The subscription is changed without creating any credits or charges. - When not provided, the value configured in the [site settings](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change) is considered. **Caveat** For further changes within the same billing term, when `prorate` is set to `true`, **credits** are **not created** when **all** the conditions below hold true: An immediate previous change was made - with `prorate` set to `false` and - no changes were made to the subscription's billing term and - a change was made to either the subscription's plan, its addons, or the prices of the plan or addons. - `end_of_term` (optional, boolean, default=false) Set this to true if you want the update to be applied at the end of the current subscription billing cycle. - `force_term_reset` (optional, boolean, default=false) Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as `true` will have the subscription reset its term to the current date (provided `end_of_term` is false). **Note**: When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter. - `reactivate` (optional, boolean) When the `status` of the subscription is `cancelled` , this parameter determines whether the subscription is reactivated upon making this API request. Unless passed explicitly as `false` , this parameter is implied as `true` when you provide `plan_id` or `addons[id]` - `token_id` (optional, string, max chars=40) The Chargebee payment token generated by [Chargebee.js](https://www.chargebee.com/docs/payments/2.0/card-components-and-helpers/3ds-helper#using-the-gateways-hosted-fields). **Note**: The payment token created via Chargebee.js uses the gateway selected through [Smart Routing](https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing). Explicitly passing a `gateway_id` in this API call will not override the gateway associated with the token. - `invoice_notes` (optional, string, max chars=2000) A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes) displayed on the invoice PDF. - `meta_data` (optional, jsonobject) A collection of key-value pairs that provides extra information about the subscription. **Note:** There's a character limit of 65,535. [Learn more](/docs/api/v2/pcv-1/advanced-features) . - `invoice_immediately` (optional, boolean) If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration) . **Note:** `invoice_immediately` only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter. . - `override_relationship` (optional, boolean) If `true` , ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship) and uses customer as payment and invoice owner. - `changes_scheduled_at` (optional, timestamp(UTC) in seconds) When `change_option` is set to `specific_date` , then set the date/time at which the subscription change is to happen or has happened. **Note:** It is recommended not to pass this parameter along with `reactivate_from`. `changes_scheduled_at` can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met: - Backdating must be enabled for subscription change operations. - Only the following changes can be backdated: - Changes in the recurring items or their prices. - Addition of non-recurring items. - Subscription `status` is `active`, `cancelled`, or `non_renewing`. - The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is typically the day of the month by which the accounting for the previous month must be closed. - The date is on or after `current_term_start`. - The date is on or after the last date/time any of the following changes were made: - Changes in the recurring items or their prices. - Addition of non-recurring items. - The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, `changes_scheduled_at` cannot be earlier than 14th February.. **Note:** The `changes_scheduled_at` parameter does not apply to `auto_collection` , `shipping_address` , and `po_number` ; these parameters take effect **immediately** when scheduling a subscription update. - `change_option` (optional, enumerated string) When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out. Possible enum values: - `immediately` The change is carried out immediately. - `end_of_term` The change is carried out at the end of the current billing cycle of the subscription. - `specific_date` The change is carried out as of the date specified under `changes_scheduled_at` . - `contract_term_billing_cycle_on_renewal` (optional, integer, min=1, max=100) Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles` or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms) . - `free_period` (optional, integer, min=1) The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free\_period\_unit. - `free_period_unit` (optional, enumerated string) The unit of time in multiples of which the free\_period parameter is expressed. The value must be equal to or lower than the [period\_unit](/docs/api/v2/pcv-1/plans/create-a-plan#period_unit) attribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id) chosen. Possible enum values: - `day` Charge based on day(s) - `week` Charge based on week(s) - `month` Charge based on month(s) - `year` Charge based on year(s) - `trial_end_action` (optional, enumerated string) Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. Possible enum values: - `site_default` This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. - `plan_default` The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. - `activate_subscription` The subscription activates and charges are raised for non-metered items. - `cancel_subscription` The subscription cancels. - `card` (optional, string) Parameters for card - `gateway_account_id` (optional, string, max chars=50) The gateway account in which this payment source is stored. - `first_name` (optional, string, max chars=50) Cardholder's first name - `last_name` (optional, string, max chars=50) Cardholder's last name - `number` (required if card provided, string, max chars=1500) The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js) , you can specify the Braintree encrypted card number here. - `expiry_month` (required if card provided, integer, min=1, max=12) Card expiry month. - `expiry_year` (required if card provided, integer) Card expiry year. - `cvv` (optional, string, max chars=520) The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js) , you can specify the Braintree encrypted CVV here. - `preferred_scheme` (optional, enumerated string) The customer's preferred card scheme for co-branded cards. **Note**: Currently, this parameter is only supported for Stripe. Possible enum values: - `cartes_bancaires` A Cartes Bancaires card scheme. - `mastercard` A MasterCard scheme. - `visa` A Visa card scheme. - `billing_addr1` (optional, string, max chars=150) Address line 1, as available in card billing address. - `billing_addr2` (optional, string, max chars=150) Address line 2, as available in card billing address. - `billing_city` (optional, string, max chars=50) City, as available in card billing address. - `billing_state_code` (optional, string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_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` ). For Dubai (UAE), set as `DU` (not `AE-DU` ). - `billing_state` (optional, string, max chars=50) The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `billing_state_code` is provided. - `billing_zip` (optional, string, max chars=20) Postal or Zip code, as available in card billing address. - `billing_country` (optional, string, max chars=50) The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html) . **Note**: If you enter an invalid country code, the system will return an error. **Brexit** If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then `XI` (the code for **United Kingdom - Northern Ireland**) is available as an option. - `additional_information` (optional, jsonobject) - `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/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](https://docs.checkout.com/resources/codes/country-codes). - `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country. - `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions. - `fraud`: Fraud identification related information. - `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation. - `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](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) 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](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) 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. - `bank_of_america`: While passing raw card details to Bank of America, your 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. - `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part. - `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted. - `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions. - `payer`: User related information. - `document`: Document is the user's identification number based on their country. - `fraud`: Fraud identification related information. - `device_session_id`: Session ID associated with the user's device - `payment_method` (optional, enumerated string) Parameters for payment\_method - `type` (optional, enumerated string) The type of payment method. For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer) API under Customer resource. Possible enum values: - `card` Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. - `paypal_express_checkout` Payments made via PayPal Express Checkout. - `amazon_payments` Payments made via Amazon Payments. - `direct_debit` Represents bank account for which the direct debit or ACH agreement/mandate is created. - `generic` Payments made via Generic Payment Method. - `alipay` Payments made via Alipay. This payment source is deprecated. - `unionpay` Payments made via UnionPay. - `apple_pay` Payments made via Apple Pay. - `wechat_pay` Payments made via WeChat Pay. This payment source is deprecated. - `ideal` Payments made via iDEAL. - `google_pay` Payments made via Google Pay. - `sofort` Payments made via Sofort. - `bancontact` Payments made via Bancontact Card. - `giropay` Payments made via giropay. - `dotpay` Payments made via Dotpay. - `upi` UPI Payments. - `netbanking_emandates` Netbanking (eMandates) Payments. - `venmo` Payments made via Venmo - `pay_to` Payments made via PayTo - `faster_payments` Payments made via Faster Payments - `sepa_instant_transfer` Payments made via Sepa Instant Transfer - `automated_bank_transfer` Represents virtual bank account using which the payment will be done. - `klarna_pay_now` Payments made via Klarna Pay Now - `online_banking_poland` Payments made via Online Banking Poland - `payconiq_by_bancontact` Payments made via Payconiq by Bancontact. - `electronic_payment_standard` Electronic Payment Standard - `kbc_payment_button` KBC Payment Button - `pay_by_bank` Pay By Bank - `trustly` Trustly - `stablecoin` Payments made via Stablecoin. - `kakao_pay` Payments made via Kakao Pay. - `naver_pay` Payments made via Naver Pay. - `revolut_pay` Payments made via Revolut Pay. - `cash_app_pay` Payments made via Cash App Pay. - `twint` Payments made via Twint - `go_pay` Payments made via GoPay - `grab_pay` Payments made via GrabPay - `pay_co` Payments made via PayCo - `after_pay` Payments made via Afterpay - `swish` Payments made via Swish - `payme` Payments made via PayMe - `pix` Payments made via Pix - `klarna` Payments made via Klarna. - `alipay_hk` Payments made via Alipay HK. - `paypay` Payments made via PayPay - `gcash` Payments made via GCash. - `south_korean_cards` Payments made via South Korean Cards - `paynow` - `bizum` - `promptpay` - `dana` Payments made via Dana. - `touch_n_go` Payments made via Touch 'n Go. - `tamara` Payments made via Tamara. - `qpay` Payments made via Qpay. - `ovo` - `momo` - `mercado_pago` - `nequi` - `nupay` - `picpay` - `thai_qr` - `blik` - `fpx` - `wero` - `p24` - `affirm_pay` - `rakuten_pay` - `gateway_account_id` (optional, string, max chars=50) The gateway account in which this payment source is stored. - `reference_id` (optional, string, max chars=200) The reference id. In the case of Amazon and PayPal this will be the _billing agreement id_. For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:** This is not the one-time temporary token provided by gateways like Stripe. For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer) API under Customer resource. - `tmp_token` (required if reference_id not provided, string, max chars=65k) Single-use tokens created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details. - `issuing_country` (optional, string, max chars=50) [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html) . **Note**: If you enter an invalid country code, the system will return an error. If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then `XI` (the code for **United Kingdom - Northern Ireland** ) is available as an option. - `additional_information` (optional, jsonobject) - `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/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](https://docs.checkout.com/resources/codes/country-codes). - `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country. - `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions. - `fraud`: Fraud identification related information. - `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation. - `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](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) 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](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) 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. - `bank_of_america`: While passing raw card details to Bank of America, your 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. - `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part. - `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted. - `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions. - `payer`: User related information. - `document`: Document is the user's identification number based on their country. - `fraud`: Fraud identification related information. - `device_session_id`: Session ID associated with the user's device - `payment_intent` (optional, string) Parameters for 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. - `gateway_account_id` (required if payment intent token provided, string, max chars=50) The gateway account used for performing the 3DS flow. - `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](/docs/api/3ds_card_payments) to find out the gateway-specific gw\_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow. - `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 enum values: - `card` card - `ideal` ideal - `sofort` sofort - `bancontact` bancontact - `google_pay` google\_pay - `dotpay` dotpay - `giropay` giropay - `apple_pay` apple\_pay - `upi` upi - `netbanking_emandates` netbanking\_emandates - `paypal_express_checkout` paypal\_express\_checkout - `direct_debit` direct\_debit - `boleto` boleto - `venmo` - `amazon_payments` Amazon Payments - `pay_to` - `faster_payments` - `sepa_instant_transfer` - `klarna_pay_now` Klarna Pay Now - `online_banking_poland` Online Banking Poland - `payconiq_by_bancontact` Payments made via Payconiq by Bancontact. - `electronic_payment_standard` Electronic Payment Standard - `kbc_payment_button` KBC Payment Button - `pay_by_bank` Pay By Bank - `trustly` Trustly - `stablecoin` Payments made via Stablecoin. - `kakao_pay` Payments made via Kakao Pay. - `naver_pay` Payments made via Naver Pay. - `revolut_pay` Payments made via Revolut Pay. - `cash_app_pay` Payments made via Cash App Pay. - `wechat_pay` Payments made via WeChat Pay. - `alipay` Payments made via Alipay. - `twint` Payments made via Twint - `go_pay` Payments made via GoPay - `grab_pay` Payments made via GrabPay - `pay_co` Payments made via PayCo - `after_pay` Payments made via Afterpay - `swish` Payments made via Swish - `payme` Payments made via PayMe - `pix` Pix - `klarna` Payments made via Klarna. - `alipay_hk` Payments made via Alipay HK. - `paypay` PayPay - `gcash` Payments made via GCash. - `south_korean_cards` Payments made via South Korean Cards - `paynow` - `bizum` - `promptpay` - `dana` Payments made via Dana. - `touch_n_go` Payments made via Touch 'n Go. - `tamara` Payments made via Tamara. - `qpay` Payments made via Qpay. - `ovo` - `momo` - `mercado_pago` - `nequi` - `nupay` - `picpay` - `thai_qr` - `blik` - `fpx` - `wero` - `p24` - `affirm_pay` - `rakuten_pay` - `reference_id` (optional, string, max chars=65k) Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow. - `additional_information` (optional, jsonobject) - `checkout_com`: While adding a new payment method using [permanent token](/docs/api/payment_sources/create-using-permanent-token) or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through [dLocal](https://www.checkout.com/docs/previous/payments/payment-methods/cards/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](https://docs.checkout.com/resources/codes/country-codes). - `document`: Document ID is the user's [identification number](https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents) based on their country. - `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, [additional validation](https://developers.bluesnap.com/docs/fraud-prevention) is performed to avoid fraudulent transactions. - `fraud`: Fraud identification related information. - `fraud_session_id`: Your [BlueSnap fraud session ID](https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector) required to perform anti-fraud validation. - `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](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) 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](https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data) 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. - `bank_of_america`: While passing raw card details to Bank of America, your 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. - `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part. - `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted. - `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform [additional validation](https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint) and avoid fraudulent transactions. - `payer`: User related information. - `document`: Document is the user's identification number based on their country. - `fraud`: Fraud identification related information. - `device_session_id`: Session ID associated with the user's device - `billing_address` (optional, string) Parameters for billing\_address - `first_name` (optional, string, max chars=150) The first name of the billing contact. - `last_name` (optional, string, max chars=150) The last name of the billing contact. - `email` (optional, string, max chars=70) The email address. - `company` (optional, string, max chars=250) The company name. - `phone` (optional, string, max chars=50) The phone number. - `line1` (optional, string, max chars=150) Address line 1 - `line2` (optional, string, max chars=150) Address line 2 - `line3` (optional, string, max chars=150) Address line 3 - `city` (optional, string, max chars=50) The name of the city. - `state_code` (optional, string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada, India and UAE. 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` ). For Dubai (UAE), set as `DU` (not `AE-DU` ). - `state` (optional, string, max chars=50) The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code` is provided. - `zip` (optional, string, max chars=20) Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address) . - `country` (optional, string, max chars=50) The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) . **Brexit** If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then `XI` (the code for **United Kingdom - Northern Ireland**) is available as an option. - `validation_status` (optional, enumerated string, default=not_validated) The address verification status. Possible enum values: - `not_validated` Address is not yet validated. - `valid` Address was validated successfully. - `partially_valid` The address is valid for taxability but has not been validated for shipping. - `invalid` Address is invalid. - `shipping_address` (optional, string) Parameters for shipping\_address - `first_name` (optional, string, max chars=150) The first name of the contact. - `last_name` (optional, string, max chars=150) The last name of the contact. - `email` (optional, string, max chars=70) The email address. - `company` (optional, string, max chars=250) The company name. - `phone` (optional, string, max chars=50) The phone number. - `line1` (optional, string, max chars=150) Address line 1 - `line2` (optional, string, max chars=150) Address line 2 - `line3` (optional, string, max chars=150) Address line 3 - `city` (optional, string, max chars=50) The name of the city. - `state_code` (optional, string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada, India and UAE. 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` ). For Dubai (UAE), set as `DU` (not `AE-DU` ). - `state` (optional, string, max chars=50) The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code` is provided. - `zip` (optional, string, max chars=20) Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address) . - `country` (optional, string, max chars=50) The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html) . **Note**: If you enter an invalid country code, the system will return an error. **Brexit** If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then `XI` (the code for **United Kingdom - Northern Ireland**) is available as an option. - `validation_status` (optional, enumerated string, default=not_validated) The address verification status. Possible enum values: - `not_validated` Address is not yet validated. - `valid` Address was validated successfully. - `partially_valid` The address is valid for taxability but has not been validated for shipping. - `invalid` Address is invalid. - `statement_descriptor` (optional, string) Parameters for statement\_descriptor - `descriptor` (optional, string, max chars=65k) Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html) text configured in the Chargebee site for all the subscription renewal transactions. - `customer` (optional, string) Parameters for customer - `vat_number` (optional, string, max chars=20) The VAT/tax registration number for the customer. For customers with `[billing_address](/docs/api/customers/customer-object#billing_address)` `country` as `XI` (which is **United Kingdom - Northern Ireland** ), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number) can be overridden by setting `[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)` . - `vat_number_prefix` (optional, string, max chars=10) An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number). Only applicable specifically for customers with `[billing_address](/docs/api/customers/customer-object#billing_address)` `country` as `XI` (which is **United Kingdom - Northern Ireland** ). When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, you have the option of setting `[billing_address](/docs/api/customers/customer-object#billing_address)` `country` as `XI`. That's the code for **United Kingdom - Northern Ireland**. The first two characters of the VAT number in such a case is `XI` by default. However, if the VAT number was registered in UK, the value should be `GB`. Set `vat_number_prefix` to `GB` for such cases. - `entity_identifier_scheme` (optional, string, max chars=50) The Peppol BIS scheme associated with the `[vat_number](/docs/api/customers/customer-object#vat_number)` of the customer. This helps identify the specific type of customer entity. For example, `DE:VAT` is used for a German business entity while `DE:LWID45` is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under `billing_address.country`. See [list of possible values](https://www.chargebee.com/docs/e-invoicing.html#supported-countries) . **Tip:** If there are additional entity identifiers for the customer not associated with the `vat_number`, they can be provided as the `entity_identifiers[]` array. - `is_einvoice_enabled` (optional, boolean) Determines whether the customer is e-invoiced. When set to `true` or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (`billing_address.country` ). When set to `false` , the customer is not e-invoiced even if e-invoicing is enabled for their country. **Tip:** It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled. - `einvoicing_method` (optional, enumerated string) Determines whether to send einvoice manually or automatic. Possible enum values: - `automatic` Use this value to send e-invoice every time an invoice or credit note is created. - `manual` When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API. - `site_default` The default value of the site which can be overridden at the customer level. - `entity_identifier_standard` (optional, string, default=iso6523-actorid-upis, max chars=50) The standard used for specifying the `entity_identifier_scheme`. Currently only `iso6523-actorid-upis` is supported and is used by default when not provided. **Tip:** If there are additional entity identifiers for the customer not associated with the `vat_number`, they can be provided as the `entity_identifiers[]` array. - `business_customer_without_vat_number` (optional, boolean) Confirms that a customer is a valid business without an EU/UK VAT number. - `registered_for_gst` (optional, boolean) Confirms that a customer is registered under GST. If set to `true` then the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism) is applicable. This field is applicable only when Australian GST is configured for your site. - `contract_term` (optional, enumerated string) Parameters for contract\_term - `action_at_term_end` (optional, enumerated string, default=renew) Action to be taken when the contract term completes. Possible enum values: - `renew` - Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal). - The `action_at_term_end` for the new contract term is set to `renew`. - `evergreen` Contract term completes and the subscription renews. - `cancel` Contract term completes and subscription is canceled. - `renew_once` Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in [`contract_billing_cycle_on_renewal`](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal). - The `action_at_term_end` for the new contract term is set to `cancel`. - `cancellation_cutoff_period` (optional, integer) The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end) , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure. - `addons` (optional, array) Parameters for addons - `id` (optional, string, max chars=100) Identifier of the addon. Multiple addons can be passed. - `quantity` (optional, integer) Quantity of the addon. Applicable for addons with `pricing_model` other than `flat_fee` . - `unit_price` (optional, in cents) Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started). The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10 x 3). If `changes_scheduled_at` is in the past and `addons[unit_price][i]` is not passed, then the addon's current unit price is considered even if the addon did not exist on the date as of when the change is scheduled. - `billing_cycles` (optional, integer) Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely. - `quantity_in_decimal` (optional, string, max chars=33) The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `unit_price_in_decimal` (optional, string, max chars=39) When [price overriding](https://www.chargebee.com/docs/price-override.html) is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price) is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon period. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/getting-started) is enabled. If `changes_scheduled_at` is in the past and `addons[unit_price_in_decimal][i]` is not passed, then the addon's current unit price is considered even if the addon did not exist on the date as of when the change is scheduled. - `trial_end` (optional, timestamp(UTC) in seconds) The time at which the trial ends for the addon. To update this value, redo the complete addon set using [`replace_addon_list`](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list). (Addon trial periods must be enabled by [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support) .) - `proration_type` (optional, enumerated string) Specifies how to manage charges or credits for the addon during this subscription update. It's relevant only for addons that have their `[pricing_model](/docs/api/v2/pcv-1/addons/addon-object#pricing_model)` set to `per_unit`. You may use this parameter only if the change to the subscription takes effect [immediately](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#change_option). **Note** - Once set, this parameter becomes a [subscription attribute](/docs/api/v2/pcv-1/subscriptions/subscription-object#addons_proration_type) and automatically applies to any additional changes to the addon during the current term. It's removed from the subscription attributes at renewal. You can't alter this parameter's value within the current term via later API calls. - If you don't provide a value, Chargebee determines the proration logic based on the following precedence: this parameter > `[prorate](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#prorate)` parameter > `[addon.proration_type](/docs/api/v2/pcv-1/addons/addon-object#proration_type)` > [site-wide proration](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change) setting. Possible enum values: - `full_term` Charge the full price of the addon or give the full credit. Don't apply any proration. - `partial_term` Prorate the charges or credits for the rest of the current term. - `none` Don't apply any charges or credits for the addon. - `event_based_addons` (optional, array) Parameters for event\_based\_addons - `id` (optional, string, max chars=100) A unique 'id' used to identify the addon. - `quantity` (optional, integer) Quantity of the addon. Applicable for addons with `pricing_model` other than `flat_fee` . - `unit_price` (optional, in cents) Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started) . - `service_period_in_days` (optional, integer) Defines service period of the addon in days from the day of charge. - `charge_on` (optional, enumerated string) Indicates when the non-recurring addon will be charged. Possible enum values: - `immediately` Charges for the addon will be applied immediately. - `on_event` Charge for the addon will be applied on the occurrence of a specified event. - `on_event` (optional, enumerated string) Event on which this addon will be charged. Possible enum values: - `subscription_creation` Addon will be charged on subscription creation. - `subscription_trial_start` Addon will be charged when the trial period starts. - `plan_activation` Addon will be charged on plan activation. - `subscription_activation` Addon will be charged on subscription activation. - `contract_termination` Addon will be charged on contract termination. - `charge_once` (optional, boolean) If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons. - `quantity_in_decimal` (optional, string, max chars=33) The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `unit_price_in_decimal` (optional, string, max chars=39) When [price overriding](http://chargebee.com/docs/price-override.html ) is enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price) is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. ## Returns - `subscription` (Subscription object) Resource object representing subscription - `customer` (Customer object) Resource object representing customer - `card` (Card object) Resource object representing card - `invoice` (Invoice object) Resource object representing invoice - `unbilled_charges` (optional) Resource object representing unbilled\_charge - `credit_notes` (optional) Resource object representing credit\_note