chargebee 2.32.0 → 2.33.0

package/types/resources/QuotedCharge.d.ts

@@ -96,7 +96,7 @@ declare module 'chargebee' {
 
           */
        
-      item_price_id?:string;
+      item_price_id:string;
        
          /**
           * @description Item price quantity
@@ -139,14 +139,14 @@ declare module 'chargebee' {
 
           */
        
-      item_price_id?:string;
+      item_price_id:string;
        
          /**
           * @description The lowest value in the quantity tier.
 
           */
        
-      starting_unit?:number;
+      starting_unit:number;
        
          /**
           * @description The highest value in the quantity tier.
@@ -160,7 +160,7 @@ declare module 'chargebee' {
 
           */
        
-      price?:number;
+      price:number;
        
          /**
           * @description The decimal representation of the 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](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
@@ -188,7 +188,7 @@ declare module 'chargebee' {
 
           */
        
-      index?:number;
+      index:number;
     }
     export interface Coupon {  
          /**
@@ -196,7 +196,7 @@ declare module 'chargebee' {
 
           */
        
-      coupon_id?:string;
+      coupon_id:string;
     }
     export interface Discount {  
          /**
@@ -204,7 +204,7 @@ declare module 'chargebee' {
 
           */
        
-      id?:string;
+      id:string;
        
          /**
           * @description The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices?prod_cat_ver=2) and [hosted pages](/docs/api/hosted_pages?prod_cat_ver=2). This is auto-generated based on the `type`, `amount`, and `currency_code` of the discount. For example, it can be `10% off` or `10$ off`.
@@ -218,7 +218,7 @@ declare module 'chargebee' {
 
           */
        
-      type?:'fixed_amount' | 'percentage';
+      type:'fixed_amount' | 'percentage';
        
          /**
           * @description The percentage of the original amount that should be deducted from it. Only applicable when `discount.type` is percentage.
@@ -246,7 +246,7 @@ declare module 'chargebee' {
 
           */
        
-      apply_on?:'specific_item_price' | 'invoice_amount';
+      apply_on:'specific_item_price' | 'invoice_amount';
        
          /**
           * @description The [id of the item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when `apply_on` = `specific_item_price`.
@@ -260,7 +260,7 @@ declare module 'chargebee' {
 
           */
        
-      created_at?:number;
+      created_at:number;
        
          /**
           * @description Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.  
@@ -272,14 +272,14 @@ Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the pa
 
           */
        
-      coupon_id?:string;
+      coupon_id:string;
        
          /**
           * @description The index number of the subscription to which the item price is added. Provide a unique number between `0` and `4` (inclusive) for each subscription that is to be created.
 
           */
        
-      index?:number;
+      index:number;
     }
   }
 }

package/types/resources/QuotedSubscription.d.ts

@@ -133,7 +133,7 @@ declare module 'chargebee' {
 
           */
        
-      coupon_id?:string;
+      coupon_id:string;
     }
     export interface Discount {  
          /**
@@ -141,7 +141,7 @@ declare module 'chargebee' {
 
           */
        
-      id?:string;
+      id:string;
        
          /**
           * @description The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices?prod_cat_ver=2) and [hosted pages](/docs/api/hosted_pages?prod_cat_ver=2). This is auto-generated based on the `type`, `amount`, and `currency_code` of the discount. For example, it can be `10% off` or `10$ off`.
@@ -155,7 +155,7 @@ declare module 'chargebee' {
 
           */
        
-      type?:'fixed_amount' | 'percentage';
+      type:'fixed_amount' | 'percentage';
        
          /**
           * @description The percentage of the original amount that should be deducted from it. Only applicable when `discount.type` is percentage.
@@ -183,7 +183,7 @@ declare module 'chargebee' {
 
           */
        
-      duration_type?:'limited_period' | 'one_time' | 'forever';
+      duration_type:'limited_period' | 'one_time' | 'forever';
        
          /**
           * @description The duration of time for which the discount is attached to the subscription, in `period_units`. Applicable only when `duration_type` is `limited_period`.
@@ -204,14 +204,14 @@ declare module 'chargebee' {
 
           */
        
-      included_in_mrr?:boolean;
+      included_in_mrr:boolean;
        
          /**
           * @description The amount on the invoice to which the discount is applied. \* 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`.
 
           */
        
-      apply_on?:'specific_item_price' | 'invoice_amount';
+      apply_on:'specific_item_price' | 'invoice_amount';
        
          /**
           * @description The [id of the item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when `apply_on` = `specific_item_price`.
@@ -225,7 +225,7 @@ declare module 'chargebee' {
 
           */
        
-      created_at?:number;
+      created_at:number;
        
          /**
           * @description Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for `limited_period` duration type discount.
@@ -251,14 +251,14 @@ Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the pa
 
           */
        
-      coupon_id?:string;
+      coupon_id:string;
        
          /**
           * @description The index number of the subscription to which the item price is added. Provide a unique number between `0` and `4` (inclusive) for each subscription that is to be created.
 
           */
        
-      index?:number;
+      index:number;
     }
     export interface SubscriptionItem {  
          /**
@@ -266,14 +266,14 @@ Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the pa
 
           */
        
-      item_price_id?:string;
+      item_price_id:string;
        
          /**
           * @description The type of item. There must be one and only one item of type `plan` in this list. \* plan - Plan \* addon - Addon \* charge - Charge
 
           */
        
-      item_type?:'charge' | 'addon' | 'plan';
+      item_type:'charge' | 'addon' | 'plan';
        
          /**
           * @description The quantity of the item purchased
@@ -376,6 +376,13 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
           */
        
       charge_on_option?:'on_event' | 'immediately';
+       
+         /**
+          * @description null
+
+          */
+       
+      proration_type?:'partial_term' | 'full_term' | 'none';
     }
     export interface ItemTier {  
          /**
@@ -383,14 +390,14 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
 
           */
        
-      item_price_id?:string;
+      item_price_id:string;
        
          /**
           * @description The lowest value in the quantity tier.
 
           */
        
-      starting_unit?:number;
+      starting_unit:number;
        
          /**
           * @description The highest value in the quantity tier.
@@ -404,7 +411,7 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
 
           */
        
-      price?:number;
+      price:number;
        
          /**
           * @description The decimal representation of the 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](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
@@ -432,7 +439,7 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
 
           */
        
-      index?:number;
+      index:number;
     }
     export interface QuotedContractTerm {  
          /**
@@ -440,21 +447,21 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
 
           */
        
-      contract_start?:number;
+      contract_start:number;
        
          /**
           * @description The end date of the contract term
 
           */
        
-      contract_end?:number;
+      contract_end:number;
        
          /**
           * @description The number of billing cycles of the subscription that the contract term is for.
 
           */
        
-      billing_cycle?:number;
+      billing_cycle:number;
        
          /**
           * @description Action to be taken when the contract term completes. \* renew -
@@ -468,14 +475,14 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
 
           */
        
-      action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen';
+      action_at_term_end:'cancel' | 'renew_once' | 'renew' | 'evergreen';
        
          /**
           * @description The sum of the [totals](invoices#invoice_total) of all the invoices raised as part of the contract term. For `active` contract terms, this is a predicted value. The value depends on the [type of currency](./#handling_currency_units). If the subscription was [imported](#import_a_subscription) with the contract term, then this value includes the value passed for `total_amount_raised`.
 
           */
        
-      total_contract_value?:number;
+      total_contract_value:number;
        
          /**
           * @description The number of days before [`contract_end`](contract_terms#contract_term_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

package/types/resources/Subscription.d.ts

@@ -2794,6 +2794,13 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
           */
        
       charge_on_option?:'on_event' | 'immediately';
+       
+         /**
+          * @description null
+
+          */
+       
+      proration_type?:'partial_term' | 'full_term' | 'none';
     }
     export interface ItemTier {  
          /**

package/types/resources/Transaction.d.ts

@@ -38,7 +38,7 @@ declare module 'chargebee' {
     payment_source_id?:string;
     
     /**
-      * @description The payment method of this transaction \* unionpay - Unionpay \* upi - upi \* check - Check \* custom - Custom \* amazon_payments - Amazon Payments \* boleto - boleto \* direct_debit - Direct Debit \* apple_pay - Apple Pay \* wechat_pay - WeChat Pay \* bancontact - Bancontact \* bank_transfer - Bank Transfer \* paypal_express_checkout - Paypal Express Checkout \* other - Payment Methods other than the above types \* ach_credit - ACH Credit \* sepa_credit - SEPA Credit \* card - Card \* ideal - IDEAL \* chargeback - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund). \* google_pay - Google Pay \* netbanking_emandates - netbanking_emandates \* dotpay - Dotpay \* alipay - Alipay \* sofort - Sofort \* giropay - giropay \* cash - Cash
+      * @description The payment method of this transaction \* unionpay - Unionpay \* upi - upi \* check - Check \* custom - Custom \* amazon_payments - Amazon Payments \* boleto - boleto \* direct_debit - Direct Debit \* sepa_instant_transfer - Sepa Instant Transfer \* apple_pay - Apple Pay \* wechat_pay - WeChat Pay \* bancontact - Bancontact \* faster_payments - Faster Payments \* venmo - Venmo \* bank_transfer - Bank Transfer \* paypal_express_checkout - Paypal Express Checkout \* other - Payment Methods other than the above types \* ach_credit - ACH Credit \* sepa_credit - SEPA Credit \* card - Card \* ideal - IDEAL \* chargeback - Only applicable for a transaction of [type](transactions#transaction_type) = `refund`. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund). \* google_pay - Google Pay \* netbanking_emandates - netbanking_emandates \* pay_to - PayTo \* dotpay - Dotpay \* alipay - Alipay \* sofort - Sofort \* giropay - giropay \* cash - Cash
 
       */
     
@@ -52,7 +52,7 @@ declare module 'chargebee' {
     reference_number?:string;
     
     /**
-      * @description Gateway through which this transaction was done. Applicable only for 'Card' Payment Method \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* eway - eWAY Account is a payment gateway. \* amazon_payments - Amazon Payments is a payment service provider. \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* bank_of_america - Bank of America Gateway \* gocardless - GoCardless is a payment service provider. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* paypal_pro - PayPal Pro Account is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* mollie - Mollie is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
+      * @description Gateway through which this transaction was done. Applicable only for 'Card' Payment Method \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* pay_com - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* eway - eWAY Account is a payment gateway. \* amazon_payments - Amazon Payments is a payment service provider. \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* bank_of_america - Bank of America Gateway \* gocardless - GoCardless is a payment service provider. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* paypal_pro - PayPal Pro Account is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* mollie - Mollie is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
 
       */
     
@@ -307,6 +307,11 @@ declare module 'chargebee' {
     
     linked_payments?:Transaction.LinkedPayment[];
     
+    /**
+      * @description Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about [gateway error references](gateway_error_references)
+
+      */
+    
     error_detail?:Transaction.GatewayErrorDetail;
   }
   export namespace Transaction {
@@ -835,23 +840,96 @@ The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status) is yet to b
       date?:number;
     }
     export interface GatewayErrorDetail {  
+         /**
+          * @description This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway
+
+          */
+       
       request_id?:string;
        
+         /**
+          * @description This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more
+
+          */
+       
       error_category?:string;
        
+         /**
+          * @description A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services
+
+          */
+       
       error_code?:string;
        
+         /**
+          * @description A message provided by the gateway that describes the nature of the error encountered
+
+          */
+       
       error_message?:string;
        
+         /**
+          * @description When a transaction is declined, this code is provided by the gateway to specify the reason for the decline
+
+          */
+       
       decline_code?:string;
        
+         /**
+          * @description This message gives a descriptive explanation of the reason for the transaction's decline
+
+          */
+       
       decline_message?:string;
        
+         /**
+          * @description This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network's error-handling system
+
+          */
+       
       network_error_code?:string;
        
+         /**
+          * @description This the network related error message from the gateway, this is a detailed message provided by the payment network explaining the nature of the network error encountered
+
+          */
+       
+      network_error_message?:string;
+       
+         /**
+          * @description This parameter indicates which specific data field or attribute in the request caused the error
+
+          */
+       
       error_field?:string;
        
+         /**
+          * @description After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue
+
+          */
+       
       recommendation_code?:string;
+       
+         /**
+          * @description This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue
+
+          */
+       
+      recommendation_message?:string;
+       
+         /**
+          * @description This code is provided by the payment processor (the entity that handles the transaction between the bank accounts and the payment networks) and indicates errors that occur at this stage of the payment process
+
+          */
+       
+      processor_error_code?:string;
+       
+         /**
+          * @description This message describes the specific error that the payment processor encountered
+
+          */
+       
+      processor_error_message?:string;
     }
   }
 }

package/types/resources/Usage.d.ts

@@ -124,7 +124,7 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
 
         */
       
-      pdf(input?:PdfInputParam):ChargebeeRequest<PdfResponse>;
+      pdf(input:PdfInputParam):ChargebeeRequest<PdfResponse>;
     }
     export interface CreateResponse {  
        usage:Usage;
@@ -288,7 +288,7 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
 
         */
        
-      invoice?:{id:string};
+      invoice:{id:string};
     }
     
   }