# Create a subscription > For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt). [Idempotency Supported](/docs/api/idempotency) **Note:** This endpoint optionally supports 3DS. To use it [create](/docs/api/payment_intents/create-a-payment-intent) a `payment_intent` and provide it via this endpoint. Creates a new subscription for an existing customer in Chargebee. Any available [credits and excess payments](/docs/api/customers/customer-object#balances) for the customer are automatically applied on the invoice. ## Sample Request #### cURL ```bash curl https://{site}.chargebee.com/api/v2/customers/__test__8asz8Ru9WhHOJO/subscription_for_items \ -X POST \ -u {site_api_key}:\ -d "subscription_items[item_price_id][0]"="basic-USD" \ -d "subscription_items[billing_cycles][0]"=2 \ -d "subscription_items[quantity][0]"=1 \ -d "subscription_items[item_price_id][1]"="day-pass-USD" \ -d "subscription_items[unit_price][1]"=100 ``` #### .NET ```dotnet using ChargeBee.Api; using ChargeBee.Models; ApiConfig.Configure("{site}","{site_api_key}"); EntityResult result = Subscription.CreateWithItems("__test__8asz8Ru9WhHOJO") .SubscriptionItemItemPriceId(0, "basic-USD") .SubscriptionItemBillingCycles(0, 2) .SubscriptionItemQuantity(0, 1) .SubscriptionItemItemPriceId(1, "day-pass-USD") .SubscriptionItemUnitPrice(1, 100) .Request(); Subscription subscription = result.Subscription; Customer customer = result.Customer; Card card = result.Card; Invoice invoice = result.Invoice; List unbilledCharges = result.UnbilledCharges; ``` #### 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.CreateWithItems("__test__8asz8Ru9WhHOJO", &subscription.CreateWithItemsRequestParams{ SubscriptionItems : []*subscription.CreateWithItemsSubscriptionItemParams{ { ItemPriceId : "basic-USD", BillingCycles : chargebee.Int32(2), Quantity : chargebee.Int32(1), }, { ItemPriceId : "day-pass-USD", UnitPrice : chargebee.Int64(100), }, }, }).Request() if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges } } ``` #### 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.SubscriptionCreateWithItemsRequest{ SubscriptionItems : []*chargebee.SubscriptionCreateWithItemsSubscriptionItem{ { ItemPriceId : "basic-USD", BillingCycles : chargebee.Int32(2), Quantity : chargebee.Int32(1), }, { ItemPriceId : "day-pass-USD", UnitPrice : chargebee.Int64(100), }, }, } res, err := client.Subscription.CreateWithItems("__test__8asz8Ru9WhHOJO", req) if err != nil { fmt.Println(err) } else { Subscription := res.Subscription Customer := res.Customer Card := res.Card Invoice := res.Invoice UnbilledCharges := res.UnbilledCharges } } ``` #### 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.createWithItems("__test__8asz8Ru9WhHOJO") .subscriptionItemItemPriceId(0, "basic-USD") .subscriptionItemBillingCycles(0, 2) .subscriptionItemQuantity(0, 1) .subscriptionItemItemPriceId(1, "day-pass-USD") .subscriptionItemUnitPrice(1, 100L) .request(); Subscription subscription = result.subscription(); Customer customer = result.customer(); Card card = result.card(); Invoice invoice = result.invoice(); List unbilledCharges = result.unbilledCharges(); } } ``` #### 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.SubscriptionCreateWithItemsParams; import com.chargebee.v4.models.subscription.responses.SubscriptionCreateWithItemsResponse; import com.chargebee.v4.models.unbilledCharge.UnbilledCharge; import java.util.List; public class SubscriptionCreateWithItems { public static void main(String[] args) { ChargebeeClient client = ChargebeeClient.builder() .apiKey("{site_api_key}") .siteName("{site}") .build(); SubscriptionCreateWithItemsParams.SubscriptionItemsParams subscriptionItem0 = SubscriptionCreateWithItemsParams.SubscriptionItemsParams.builder() .itemPriceId("basic-USD") .billingCycles(2) .quantity(1) .build(); SubscriptionCreateWithItemsParams.SubscriptionItemsParams subscriptionItem1 = SubscriptionCreateWithItemsParams.SubscriptionItemsParams.builder() .itemPriceId("day-pass-USD") .unitPrice(100L) .build(); List subscriptionItemsList = List.of(subscriptionItem0, subscriptionItem1); SubscriptionCreateWithItemsParams params = SubscriptionCreateWithItemsParams.builder() .subscriptionItems(subscriptionItemsList) .build(); SubscriptionCreateWithItemsResponse response = client .subscriptions() .createWithItems("__test__8asz8Ru9WhHOJO", params); Subscription subscription = response.getSubscription(); Customer customer = response.getCustomer(); Card card = response.getCard(); Invoice invoice = response.getInvoice(); List unbilledCharges = response.getUnbilledCharges(); } } ``` #### Node.js ```node import Chargebee from "chargebee"; const chargebee = new Chargebee({ site: "{site}", apiKey: "{site_api_key}", }); try { const result = await chargebee.subscription.createWithItems("__test__8asz8Ru9WhHOJO", { subscription_items: [ { item_price_id: "basic-USD", billing_cycles: 2, quantity: 1 }, { item_price_id: "day-pass-USD", unit_price: 100 } ] }); console.log(result); const subscription = result.subscription; const customer = result.customer; const card = result.card; const invoice = result.invoice; const unbilledCharges = result.unbilled_charges; } catch (err) { console.log(err); } ``` #### PHP ```php "{site}", "apiKey" => "{site_api_key}", ]); $result = $chargebee->subscription()->createWithItems("__test__8asz8Ru9WhHOJO", [ "subscription_items" => [ [ "item_price_id" => "basic-USD", "billing_cycles" => 2, "quantity" => 1 ], [ "item_price_id" => "day-pass-USD", "unit_price" => 100 ] ] ]); $subscription = $result->subscription; $customer = $result->customer; $card = $result->card; $invoice = $result->invoice; $unbilledCharges = $result->unbilled_charges; ``` #### Python ```python from chargebee import Chargebee cb_client = Chargebee(api_key="{site_api_key}", site="{site}") response = cb_client.Subscription.create_with_items("__test__8asz8Ru9WhHOJO", cb_client.Subscription.CreateWithItemsParams( subscription_items=[ cb_client.Subscription.CreateWithItemsSubscriptionItemParams( item_price_id="basic-USD", billing_cycles=2, quantity=1 ), cb_client.Subscription.CreateWithItemsSubscriptionItemParams( item_price_id="day-pass-USD", unit_price=100 ) ] ) ) subscription = response.subscription customer = response.customer card = response.card invoice = response.invoice unbilled_charges = response.unbilled_charges ``` #### Ruby ```ruby require 'chargebee' ChargeBee.configure(:site => "{site}", :api_key => "{site_api_key}") result = ChargeBee::Subscription.create_with_items("__test__8asz8Ru9WhHOJO",{ :subscription_items => [ { :item_price_id => "basic-USD", :billing_cycles => 2, :quantity => 1 }, { :item_price_id => "day-pass-USD", :unit_price => 100 } ] }) subscription = result.subscription customer = result.customer card = result.card invoice = result.invoice unbilled_charges = result.unbilled_charges ``` ## Sample Response ```json { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890916, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdulGOV", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890916000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890916 }, "invoice": { "adjustment_credit_notes": {}, "amount_adjusted": 0, "amount_due": 1100, "amount_paid": 0, "amount_to_collect": 1100, "applied_credits": {}, "base_currency_code": "USD", "billing_address": { "first_name": "John", "last_name": "Doe", "object": "billing_address", "validation_status": "not_validated" }, "credits_applied": 0, "currency_code": "USD", "customer_id": "__test__8asukSOXdulGOV", "date": 1612890916, "deleted": false, "due_date": 1612890916, "dunning_attempts": {}, "exchange_rate": 1, "first_invoice": true, "has_advance_charges": false, "id": "__demo_inv__10", "is_gifted": false, "issued_credit_notes": {}, "line_items": [ { "amount": 1000, "customer_id": "__test__8asukSOXdulGOV", "date_from": 1612890916, "date_to": 1615310116, "description": "basic USD", "discount_amount": 0, "entity_id": "basic-USD", "entity_type": "plan_item_price", "id": "li___test__8asukSOXdutkOa", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "per_unit", "quantity": 1, "subscription_id": "__test__8asukSOXduqmOY", "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_orders": {}, "linked_payments": {}, "net_term_days": 0, "new_sales_amount": 1100, "object": "invoice", "price_type": "tax_exclusive", "recurring": true, "resource_version": 1612890917000, "round_off_amount": 0, "status": "payment_due", "sub_total": 1100, "subscription_id": "__test__8asukSOXduqmOY", "tax": 0, "term_finalized": true, "total": 1100, "updated_at": 1612890917, "write_off_amount": 0 }, "subscription": { "activated_at": 1612890916, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890916, "currency_code": "USD", "current_term_end": 1615310116, "current_term_start": 1612890916, "customer_id": "__test__8asukSOXdulGOV", "deleted": false, "due_invoices_count": 1, "due_since": 1612890916, "has_scheduled_changes": false, "id": "__test__8asukSOXduqmOY", "mrr": 0, "next_billing_at": 1615310116, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890917000, "started_at": 1612890916, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890917 } } ``` ## URL Format **POST** https://[site].chargebee.com/api/v2/customers/{customer-id}/subscription_for_items ## Input Parameters - `id` (optional, string, max chars=50) A unique and immutable identifier for the subscription. If not provided, it is autogenerated. - `business_entity_id` (optional, string, max chars=50) The unique ID of the [business entity](/docs/api/advanced-features) this subscription should be [linked](/docs/api/advanced-features) to. Applicable only when multiple business entities have been created for the site. This must be the same as the business entity of the `{"customer_id"}` for the operation to be successful. **Note** An alternative way of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features). - `brand_id` (optional, string, max chars=50) The unique ID of the [brand](/docs/api/brands) this subscription should be linked to. Applicable only when multiple brands have been created for the site. Unlike `business_entity_id`, this need not match the brand of the `{"customer_id"}`; when the two differ, the value provided here is used for the subscription. An alternative way of passing this parameter is by means of the `chargebee-brand-id` custom HTTP header; when both are provided, they must specify the same brand. **Default behavior** - When not provided, the subscription is linked to the brand of the customer it is created for. - `trial_end` (optional, timestamp(UTC) in seconds) End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`. Set it to `0` to have no trial period. - `billing_cycles` (optional, integer, min=0) Specifies the number of billing cycles for the subscription. The behavior of the subscription after the billing cycles have completed depends on whether the subscription is on a [contract term](/docs/api/contract_terms) or not. - When the subscription is not on a contract term: if `billing_cycles` is not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles) is used. Moreover, once the `billing_cycles` have completed, the subscription cancels. - When the subscription is on a contract term: Providing `billing_cycles` is mandatory. Moreover, once the `billing_cycles` have completed, the behavior of the subscription is determined by the `contract_term[action_at_term_end]` parameter. - `mandatory_items_to_remove` (optional, string, max chars=100) Item ids of [mandatorily attached addons](/docs/api/attached_items) that are to be removed from the subscription. - `net_term_days` (optional, integer) Defines [Net D](https://www.chargebee.com/docs/net_d.html) for the subscription. Net D is the number of days from [`invoice.date`](/docs/api/invoices/invoice-object#date) until payment for the invoice is due. - If a value is provided: Net D is set explicitly for the subscription to the value provided. The value must be one among those defined in the [site configuration](https://www.chargebee.com/docs/net_d.html#enable-net-d-for-chargebee-invoices). - If not provided: The attribute is not set and therefore not returned by the API. In this case, when an invoice is raised - whether now or later - the `net_term_days` defined at the [customer level](/docs/api/customers/customer-object#net_term_days) is considered. . - `start_date` (optional, timestamp(UTC) in seconds) The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met: - Backdating is enabled for subscription creation operations. - The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed. - 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, `start_date` cannot be earlier than 14th February. . - `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. - `terms_to_charge` (optional, integer, min=1) The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html) . - `billing_alignment_mode` (optional, enumerated string) Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date) for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site. 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. - `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. - `payment_source_id` (optional, string, max chars=40) Id of the payment source to be attached to this subscription. - `override_relationship` (optional, boolean) If `true` , ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship) and uses customer as payment and invoice owner. - `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. - `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 the 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. - It is not earlier than `start_date`. - It is not more than one calendar month into the past. Eg. If today is 13th January, then you cannot pass a value that is earlier than 13th December. - `invoice_immediately` is true. . - `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/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. . - `replace_primary_payment_source` (optional, boolean, default=true) Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False. - `free_period` (optional, integer, min=1) The period of time by which the first term of the subscription is extended free of charge. The value is expressed in the time unit specified by `free_period_unit`. For example, `3` with `free_period_unit` = `month` adds 3 free months to the first term of the subscription. - `free_period_unit` (optional, enumerated string) The time unit for `free_period`. **Constraints** Must be equal to or lower than the [`period_unit`](/docs/api/item_prices#period_unit) of the plan [item price](/docs/api/subscriptions/create-subscription-for-items#subscription_items_item_price_id) of the subscription. 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) - `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) . - `create_pending_invoices` (optional, boolean) Indicates whether the invoices for this subscription are generated with a `pending` `status`. This attribute is set to `true` automatically when the subscription has item prices that belong to `metered` items. You can also set this to `true` explicitly using the [create](/docs/api/subscriptions/create-subscription-for-items#create_pending_invoices)/[update](/docs/api/subscriptions/update-subscription-for-items#create_pending_invoices) subscription operations. This is useful in the following scenarios: - When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a [one-time charge](https://www.chargebee.com/docs/charges.html) at the end of the billing term. - When you need to inspect all charges before closing invoices for this subscription. Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_billing.html) is enabled for the site . - `auto_close_invoices` (optional, boolean) Set to `false` to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the [customer level](/docs/api/customers/customer-object#auto_close_invoices) . - `first_invoice_pending` (optional, boolean, default=false) If you want to bill the usages from the previous billing cycle, set this parameter to `true`. This is useful if the subscription has moved from another system into Chargebee and you haven't closed the previous cycle's invoice yet. This creates a `pending` invoice immediately on subscription creation, to which you can [add usages](/docs/api/usages/create-a-usage) for the previous cycle. If any non-`metered` items are present for the current term, they're also added to this `pending` invoice. As with all `pending` invoices, this invoice is also [closed automatically](https://www.chargebee.com/docs/metered_billing.html#configuring-metered-billing) or via an [API call](/docs/api/invoices/close-a-pending-invoice). This parameter can be passed only when the `create_pending_invoices` is `true` . - `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. - `payment_initiator` (optional, enumerated string) The type of initiator to be used for the payment request triggered by this operation. Possible enum values: - `customer` Pass this value to indicate that the request is initiated by the customer - `merchant` Pass this value to indicate that the request is initiated by the merchant - `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. - `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` Venmo - `amazon_payments` Amazon Payments - `pay_to` PayTo - `faster_payments` Faster Payments - `sepa_instant_transfer` 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 - `contract_term` (optional, enumerated string) Parameters for contract\_term - `action_at_term_end` (optional, enumerated string) 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. - `cancellation_cutoff_period` (optional, integer, default=0) 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. - `billing_override` (optional, long) Specify limits on how credits and payments are applied to individual invoices for the subscription. Contact [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) to enable this feature. Note: These limits do not apply to [consolidated invoices](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html) . - `max_excess_payment_usage` (optional, long, min=-1) Maximum amount of [excess payments](/docs/api/customers/customer-object#excess_payments) that can be automatically applied to a single invoice associated with this subscription. **Supported values:** - `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply excess payments. - `0`: Disable auto-application for the subscription. No excess payments will be automatically applied to invoices. - Any positive value: Specifies the maximum amount of excess payments that can be automatically applied to a single invoice for this subscription. - `max_refundable_credits_usage` (optional, long, min=-1) Maximum amount of [refundable credits](/docs/api/customers/customer-object#refundable_credits) that can be automatically applied to a single invoice associated with this subscription. **Supported values:** - `-1`: Set to `-1` to reset the subscription-level limit. In this case, the site-level configuration will apply, whether it is configured to Auto Apply or Do Not Auto Apply refundable credits. - `0`: Disable auto-application for the subscription. No refundable credits will be automatically applied to invoices. - Any positive value: Specifies the maximum amount of refundable credits that can be automatically applied to a single invoice for this subscription. - `subscription_items` (optional, array) Parameters for subscription\_items - `item_price_id` (required, string, max chars=100) The unique identifier of the item price. - `quantity` (optional, integer) The quantity of the item purchased - `quantity_in_decimal` (optional, string, max chars=33) The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started) is enabled. - `unit_price` (optional, in cents) Sub Item Plan Unit Amount for create subscription - `unit_price_in_decimal` (optional, string, max chars=39) Sub Item Plan Unit Amount in Decimal for create subscription - `billing_cycles` (optional, integer) For the plan-item price: the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object) for the plan-item price is used. For addon-item prices: If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object) is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object) is used. - `trial_end` (optional, timestamp(UTC) in seconds) The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html) --addon-items as well. - `service_period_days` (optional, integer) The service period of the item in days from the day of charge. - `charge_on_event` (optional, enumerated string) When `charge_on_option` option is set to `on_event` , this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items. Possible enum values: - `subscription_creation` the time of creation of the subscription. - `subscription_trial_start` the time when the trial period of the subscription begins. - `plan_activation` same as subscription activation, but also includes the case when the plan-item of the subscription is changed. - `subscription_activation` the moment a subscription enters an `active` or `non-renewing` state. Also includes reactivations of canceled subscriptions. - `contract_termination` when a contract term is [terminated](/docs/api/subscriptions/cancel-subscription-for-items#contract_term_cancel_option) . - `charge_once` (optional, boolean) Indicates if the charge-item is to be charged only once or each time the `charge_on_event` occurs. This parameter only applies to charge-items. - `description` (optional, string, max chars=500) **Limited availability** Subscription-level item descriptions are available only on sites where this feature is enabled. Please reach out to the 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) to enable this feature. A description for this item that applies only to this subscription. When set, it is used on the customer-facing invoice instead of the description configured for the item price, and is returned as `entity_description` on the invoice [line item](/docs/api/invoices/invoice-object#invoice_line_items). When not set, the description configured for the item price is used. **Constraints** - Maximum 500 characters. - Whether a description is shown on the invoice at all continues to be controlled by the item price's [show\_description\_in\_invoices](/docs/api/item_prices#show_description_in_invoices) setting. This parameter determines which description is shown, not whether one is shown. - `charge_on_option` (optional, enumerated string) Indicates when the charge-item is to be charged. This parameter only applies to charge-items. Possible enum values: - `immediately` The item is charged immediately on being added to the subscription. - `on_event` The item is charged at the occurrence of the event specified as `charge_on_event` . - `usage_accumulation_reset_frequency` (optional, enumerated string) Specifies the frequency at which the usage counter needs to be reset. Possible enum values: - `never` Accumulates usage without ever resetting it. - `subscription_billing_frequency` Accumulates usage until the subscription's billing frequency ends. - `discounts` (optional, array) Parameters for discounts - `apply_on` (optional, enumerated string) The amount on the invoice to which the discount is applied. Possible enum values: - `invoice_amount` The discount is applied to the invoice `sub_total` . - `specific_item_price` The discount is applied to the `invoice.line_item.amount` that corresponds to the item price specified by `item_price_id` . - `duration_type` (required, enumerated string) Specifies the time duration for which this discount is attached to the subscription. Possible enum values: - `one_time` The discount stays attached to the subscription till it is applied on an invoice **once**. It is removed after that from the subscription. - `forever` The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions/update-subscription-for-items#discounts_operation_type) . - `limited_period` The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit` . - `percentage` (optional, double) The percentage of the original amount that should be deducted from it. - `amount` (optional, in cents) The value of the discount. [The format of this value](/docs/api/currencies) depends on the kind of currency. - `period` (optional, integer) The duration of time for which the discount is attached to the subscription, in `period_units`. Applicable only when `duration_type` is `limited_period`. - `period_unit` (optional, enumerated string) The unit of time for `period`. Applicable only when `duration_type` is `limited_period`. Possible enum values: - `day` A period of 24 hours. - `week` A period of 7 days. - `month` A period of 1 calendar month. - `year` A period of 1 calendar year. - `included_in_mrr` (optional, boolean) The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type` is `one_time` and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation) in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation) is to exclude one-time discounts from MRR calculations, this value is always returned `false`. - `item_price_id` (optional, string, max chars=100) The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when `apply_on` = `specific_item_price`. - `quantity` (optional, integer) Specifies the number of free units provided for the item, without affecting the total quantity sold - `item_tiers` (optional, array) Parameters for item\_tiers - `item_price_id` (optional, string, max chars=100) The id of the item price for which the tier price is being overridden. - `starting_unit` (optional, integer) The lowest value in the quantity tier. - `ending_unit` (optional, integer) The highest value in the quantity tier. - `price` (optional, in cents) The overridden price of the tier. The value depends on the [type of currency](/docs/api/subscriptions) . - `starting_unit_in_decimal` (optional, string, max chars=33) The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal` of the next lower tier. Returned only when the pricing\_model is `tiered` , `volume` or `stairstep` and [multi-decimal pricing](/docs/api/getting-started) is enabled. - `ending_unit_in_decimal` (optional, string, max chars=33) The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal` of the next higher tier. Returned only when the pricing\_model is `tiered` , `volume` or `stairstep` and [multi-decimal pricing](/docs/api/getting-started) is enabled. - `price_in_decimal` (optional, string, max chars=39) The decimal representation of the per-unit price for the tier when the `pricing_model` is `tiered` or `volume`. When the `pricing_model` is `stairstep` , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/getting-started) is enabled. - `pricing_type` (optional, enumerated string) Pricing type for the tier. Possible enum values: - `per_unit` Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2). - `flat_fee` Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep** pricing model, `pricing_type` will be set to `flat_fee` by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier. - `package` Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20). - `package_size` (optional, integer) Package size for the tier when pricing type is `package`. Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000. ## 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