# Update a subscription > For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt). [Idempotency Supported](/docs/api/v1/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. 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/v1/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/v1/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. - 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 billed a total of $7.50 immediately. Calculation will be as follows: Prorated Charge(New Plan) $15.00 Prorated Credit(Old Plan) for unused period ($7.50) Total prorated amount $7.50 Downgrading will result in credit being created which will be applied when the subscription is charged on start of the next term. **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/v1/customers/customer-object) attributes and [vat\_number](/docs/api/v1/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 #### cURL ```bash curl https://{site}.chargebee.com/api/v1/subscriptions/__test__5SK0bLNFRFuBwXZ9h \ -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__5SK0bLNFRFuBwXZ9h") .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; ``` #### 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__5SK0bLNFRFuBwXZ9h", &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 } } ``` #### 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__5SK0bLNFRFuBwXZ9h", req) if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice } } ``` #### Java ```java import com.chargebee.*; import com.chargebee.ListResult; import com.chargebee.models.*; import com.chargebee.models.enums.*; import java.io.IOException; public class Sample { public static void main(String args[]) throws IOException, Exception { Environment.configure("{site}", "{site_api_key}"); Result result = Subscription.update("__test__5SK0bLNFRFuBwXZ9h") .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(); } } ``` #### Java ```java import com.chargebee.v4.client.ChargebeeClient; import com.chargebee.v4.models.card.Card; 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 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__5SK0bLNFRFuBwXZ9h", params); Subscription subscription = response.getSubscription(); Customer customer = response.getCustomer(); Card card = response.getCard(); Invoice invoice = response.getInvoice(); } } ``` #### 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__5SK0bLNFRFuBwXZ9h", { 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; } catch (err) { console.log(err); } ``` #### PHP ```php "{site}", "apiKey" => "{site_api_key}", ]); $result = $chargebee->subscription()->update("__test__5SK0bLNFRFuBwXZ9h", [ "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; ``` #### Python ```python from chargebee import Chargebee cb_client = Chargebee(api_key="{site_api_key}", site="{site}") response = cb_client.Subscription.update("__test__5SK0bLNFRFuBwXZ9h", 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 ``` #### Ruby ```ruby require 'chargebee' ChargeBee.configure(:site => "{site}", :api_key => "{site_api_key}") result = ChargeBee::Subscription.update("__test__5SK0bLNFRFuBwXZ9h",{ :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 ``` ## Sample Response ```json { "customer": { "account_credits": 0, "allow_direct_debit": false, "auto_collection": "off", "created_at": 1517506674, "excess_payments": 0, "id": "__test__5SK0bLNFRFuBwXZ9h", "object": "customer", "refundable_credits": 0, "taxability": "taxable" }, "subscription": { "activated_at": 1517506674, "created_at": 1517506674, "current_term_end": 1519925874, "current_term_start": 1517506674, "due_invoices_count": 1, "due_since": 1517506674, "has_scheduled_changes": true, "id": "__test__5SK0bLNFRFuBwXZ9h", "object": "subscription", "plan_id": "no_trial", "plan_quantity": 1, "started_at": 1517506674, "status": "active", "total_dues": 895 } } ``` ## URL Format **POST** https://[site].chargebee.com/api/v1/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. - `replace_addon_list` (optional, boolean, default=false) Should be true if the existing addons should be replaced with the ones that are being passed. - `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. This is only allowed when the subscription `status` is `future` , `in_trial` , or `cancelled`. Also, the value must not be earlier than `changes_scheduled_at` or `start_date`. **Note**: 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. - `coupon` (optional, string, max chars=100) Used to uniquely identify the coupon in your website/application and to integrate with Chargebee. **Note:** When the coupon ID contains a special character; for example: `#`, the API returns an error. Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the path parameter before making an API call. . - `po_number` (optional, string, max chars=100) Purchase order number for this subscription. - `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. - `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 set of key-value pairs stored as additional information for the subscription. [Learn more](/docs/api/v1/subscriptions) . - `card` (optional, enumerated string) Parameters for card - `gateway` (optional, enumerated string) Name of the gateway this payment source is stored with. Possible enum values: - `chargebee` Chargebee test gateway. - `stripe` Stripe is a payment gateway. - `braintree` Braintree is a payment gateway. - `authorize_net` Authorize.net is a payment gateway - `paypal_pro` PayPal Pro Account is a payment gateway. - `pin` Pin is a payment gateway - `eway` eWAY Account is a payment gateway. - `eway_rapid` eWAY Rapid is a payment gateway. - `worldpay` WorldPay is a payment gateway - `balanced_payments` Balanced is a payment gateway - `beanstream` Bambora(formerly known as Beanstream) is a payment gateway. - `bluepay` BluePay is a payment gateway. - `elavon` Elavon Virtual Merchant is a payment solution. - `first_data_global` First Data Global Gateway Virtual Terminal Account - `hdfc` HDFC Account is a payment gateway. - `migs` MasterCard Internet Gateway Service payment gateway. - `nmi` NMI is a payment gateway. - `ogone` Ingenico ePayments (formerly known as Ogone) is a payment gateway. - `paymill` PAYMILL is a payment gateway. - `paypal_payflow_pro` PayPal Payflow Pro is a payment gateway. - `sage_pay` Sage Pay is a payment gateway. - `tco` 2Checkout is a payment gateway. - `wirecard` WireCard Account is a payment service provider. - `tmp_token` (optional, string, max chars=300) The single-use card token returned by vaults like Stripe/Braintree which act as a substitute for your card details. Before calling this API, you should have submitted your card details to the gateway and gotten this token in return. **Note:** Supported only for Stripe, Braintree and Authorize.Net. If this value is specified, there is no need to specify other card details (like number, cvv, etc). - `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. - `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. - `ip_address` (optional, string, max chars=50) The IP address of the customer. Used primarily for referral integration and EU VAT validation. - `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. - `automated_bank_transfer` Represents virtual bank account using which the payment will be done. - `gateway` (optional, enumerated string) Name of the gateway the payment method is associated with. Possible enum values: - `stripe` Stripe is a payment gateway. - `braintree` Braintree is a payment gateway. - `authorize_net` Authorize.net is a payment gateway - `paypal_pro` PayPal Pro Account is a payment gateway. - `pin` Pin is a payment gateway - `eway` eWAY Account is a payment gateway. - `eway_rapid` eWAY Rapid is a payment gateway. - `worldpay` WorldPay is a payment gateway - `balanced_payments` Balanced is a payment gateway - `beanstream` Bambora(formerly known as Beanstream) is a payment gateway. - `bluepay` BluePay is a payment gateway. - `elavon` Elavon Virtual Merchant is a payment solution. - `first_data_global` First Data Global Gateway Virtual Terminal Account - `hdfc` HDFC Account is a payment gateway. - `migs` MasterCard Internet Gateway Service payment gateway. - `nmi` NMI is a payment gateway. - `ogone` Ingenico ePayments (formerly known as Ogone) is a payment gateway. - `paymill` PAYMILL is a payment gateway. - `paypal_payflow_pro` PayPal Payflow Pro is a payment gateway. - `sage_pay` Sage Pay is a payment gateway. - `tco` 2Checkout is a payment gateway. - `wirecard` WireCard Account is a payment service provider. - `reference_id` (optional, string, max chars=200) The reference id. In the case of Amazon and Paypal this will be the _billing agreement 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. - `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. - `reference_id` (optional, string, max chars=65k) Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow. - `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. - `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. - `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)` . - `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` . - `proration_type` (optional, enumerated string) 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. ## 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