POST /customers/{customer-id}/import_for_items

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Possible values:

• "all-disabled"

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

skip all actions to be done on the events

Possible values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

skip only emails

Possible values:

• "all-disabled"

Parameters for discounts

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 in Chargebee. Also, If the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned false.

The percentage of the original amount that should be deducted from it.

The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.

The value of the discount. The format of this value depends on the kind of currency.

The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.

The time at which the subscription was activated. A subscription is "activated" when its status changes from any other, to either active or non_renewing.

The following conditions must be satisfied when passing this parameter:

• When status is active, non_renewing, or paused, activated_at must be on or after trial_end or started_at. Additionally, activated_at must be on or before current_term_start.
• When status is in_trial, activated_at must precede trial_start

Note:

This parameter should not be provided when passing status as future or cancelled.

Set as true if you want an invoice to be created for the subscription.

• The invoice will be created for the subscription only if it has an active or non_renewing status.
• The period of the invoice is from current_term_start to current_term_end.
• The invoice will not be generated if the subscription amount is zero dollars (for that period) and 'Hide Zero Value Line Items' option is enabled in site settings.

Default value: false

A customer-facing note added to all invoices associated with this subscription. This note is one among all the notes displayed on the invoice PDF.

Parameters for subscription_items

The price/per unit price of the item. When not provided, the value set for the item price is used. This is only applicable when the pricing_model of the item price is flat_fee or per_unit. Also, it is only allowed when price overriding is enabled for the site. The value depends on the type of currency. If changes_scheduled_at is in the past and a unit_price 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.

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.

When price overriding 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 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 is enabled.

The unique identifier of the item price.

The quantity of the item purchased

The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.

The service period of the item in days from the day of charge.

The date/time when the trial period of the item ends. Applies to plan-items and----when enabled----addon-items as well.

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 for the plan-item price is used.

For addon-item prices:
If addon billing cycles 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 is used. Further, if that value is not provided, then the value set for the addon-item price is used.

List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.

A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

Defines Net D for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.

• 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.
• 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 is considered. .

The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately.

Start of the current billing period of the subscription. This is required when the subscription status is paused. When the status is active or non_renewing, it defaults to the current time.

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property. * 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.

Possible values:

• "on"
• "off"

Parameters for contract_term

Id that uniquely identifies the contract term in the site.

The start date of the contract term

The amount raised for the contract term till the time of importing the subscription excluding tax. This amount is added to the total_contract_value_before_tax

Default value: 0

Action to be taken when the contract term completes. * evergreen - Contract term completes and the subscription renews. * renew -

• Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
• The action_at_term_end for the new contract term is set to renew. * 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.
• The action_at_term_end for the new contract term is set to cancel. * cancel - Contract term completes and subscription is canceled.

Possible values:

• "renew_once"
• "evergreen"
• "cancel"
• "renew"

Default value: "renew"

The date when the contract term was created.

The amount raised for the contract term till the time of importing the subscription. This amount is added to the total_contract_value

Default value: 0

The number of days before 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

Default value: 0

The number of billing cycles of the subscription that the contract term is for.

Id of the payment source to be attached to this subscription.

Parameters for shipping_address

The first name of the contact.

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

The name of the city.

The address verification status. * partially_valid - The address is valid for taxability but has not been validated for shipping. * invalid - Address is invalid. * not_validated - Address is not yet validated. * valid - Address was validated successfully.

Possible values:

• "partially_valid"
• "valid"
• "not_validated"
• "invalid"

Default value: "not_validated"

Address line 2

Address line 1

The email address.

The last name of the contact.

The company name.

Address line 3

The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. 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).

Zip or postal code. The number of characters is validated according to the rules specified here.

The phone number.

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

Note : If you enter an invalid country code, the system will return an error.

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom -- Northern Ireland) is available as an option.

Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Subscriptions > Subscription Cancellation. Must be passed if set as mandatory in the app. The codes are case-sensitive.

End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.

Note:

For subscription status: non_renewing, active, and paused, current_term_end is required.

.

When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the paused state, it is the date/time when the subscription was paused.

Purchase order number for this subscription.

A set of key-value pairs stored as additional information for the subscription. [Learn more](./#meta_data).

Specifies the IDs of to be marked as exhausted. This parameter accepts a list of IDs, which must correspond to coupons with a duration_type of one_time. Ensure that the IDs included in this parameter do not match any IDs provided in the coupon_ids parameter.

Current state of the subscription. * future - The subscription is scheduled to start at a future date. * active - The subscription is active and will be charged for automatically based on the items in it. * cancelled - The subscription has been canceled and is no longer in service. * transferred - The subscription has been transferred to another business entity within the organization. * in_trial - The subscription is in trial. * non_renewing - The subscription will be canceled at the end of the current term. * paused - The subscription is paused. The subscription will not renew while in this state.

Possible values:

• "active"
• "future"
• "in_trial"
• "non_renewing"
• "paused"
• "cancelled"
• "transferred"

Set to false to override for this subscription, the site-level setting 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.

Time at which the subscription was started. Is null for futuresubscriptions as it is yet to be started.

The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan-item price is used.

Start of the trial period for the subscription. When not passed, it is assumed to be current time. When passed for a future subscription, it implies that the subscription goes into in_trial when it starts.

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/update 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 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 is enabled for the site .

Parameters for transaction

The reference number for this transaction. For example, check number in case of check payment_method. This parameter should be passed only if the invoice is created for current term.

The payment transaction amount. This parameter should be passed only if the invoice is created for current term.

The payment method of this transaction. This parameter should be passed only if the invoice is created for current term. * cash - Cash * alipay - Alipay * sofort - Sofort * direct_debit - Direct Debit * netbanking_emandates - netbanking_emandates * klarna_pay_now - Klarna Pay Now * paypal_express_checkout - Paypal Express Checkout * automated_bank_transfer - Automated Bank Transfer * venmo - Venmo * bancontact - Bancontact * custom - Custom * upi - upi * unionpay - Unionpay * apple_pay - Apple Pay * wechat_pay - WeChat Pay * card - Card * boleto - boleto * pay_to - PayTo * ideal - IDEAL * check - Check * sepa_instant_transfer - Sepa Instant Transfer * sepa_credit - SEPA Credit * ach_credit - ACH Credit * faster_payments - Faster Payments * bank_transfer - Bank Transfer * chargeback - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a refund. * dotpay - Dotpay * amazon_payments - Amazon Payments * google_pay - Google Pay * other - Payment Methods other than the above types * giropay - giropay

Possible values:

• "check"
• "other"
• "cash"
• "bank_transfer"
• "custom"

The date of occurence of the transaction. This parameter should be passed only if the invoice is created for current term.

Parameters for item_tiers

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 is enabled.

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 is enabled.

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.

The overridden price of the tier. The value depends on the type of currency.

The highest value in the quantity tier.

The id of the item price for which the tier price is being overridden.

The lowest value in the quantity tier.

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 is enabled.

Time at which subscription was cancelled or is set to be cancelled.

For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.

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.

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.

Parameters for charged_items

Timestamp indicating when this charge item_price was last charged for this subscription.

A unique ID for your system to identify the item price.