chargebee 2.31.0 → 2.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +34 -13
- package/LICENSE +1 -1
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +20 -15
- package/package.json +1 -1
- package/types/core.d.ts +2 -2
- package/types/index.d.ts +1 -0
- package/types/resources/CreditNote.d.ts +9 -9
- package/types/resources/CreditNoteEstimate.d.ts +27 -19
- package/types/resources/Entitlement.d.ts +102 -5
- package/types/resources/Estimate.d.ts +25 -15
- package/types/resources/Event.d.ts +3 -1
- package/types/resources/GatewayErrorDetail.d.ts +76 -0
- package/types/resources/HostedPage.d.ts +7 -0
- package/types/resources/ImpactedSubscription.d.ts +7 -7
- package/types/resources/Invoice.d.ts +2 -2
- package/types/resources/InvoiceEstimate.d.ts +3 -1
- package/types/resources/ItemEntitlement.d.ts +50 -12
- package/types/resources/ItemPrice.d.ts +21 -3
- package/types/resources/Order.d.ts +85 -4
- package/types/resources/PaymentIntent.d.ts +13 -5
- package/types/resources/PaymentVoucher.d.ts +3 -3
- package/types/resources/PortalSession.d.ts +5 -5
- package/types/resources/Purchase.d.ts +7 -7
- package/types/resources/Quote.d.ts +1 -1
- package/types/resources/QuoteLineGroup.d.ts +1 -1
- package/types/resources/QuotedCharge.d.ts +12 -12
- package/types/resources/QuotedSubscription.d.ts +27 -20
- package/types/resources/Subscription.d.ts +7 -0
- package/types/resources/Transaction.d.ts +80 -2
- package/types/resources/Usage.d.ts +2 -2
|
@@ -38,7 +38,7 @@ declare module 'chargebee' {
|
|
|
38
38
|
payment_source_id?:string;
|
|
39
39
|
|
|
40
40
|
/**
|
|
41
|
-
* @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
|
|
41
|
+
* @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
|
|
42
42
|
|
|
43
43
|
*/
|
|
44
44
|
|
|
@@ -52,7 +52,7 @@ declare module 'chargebee' {
|
|
|
52
52
|
reference_number?:string;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
* @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.
|
|
55
|
+
* @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.
|
|
56
56
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
@@ -307,6 +307,11 @@ declare module 'chargebee' {
|
|
|
307
307
|
|
|
308
308
|
linked_payments?:Transaction.LinkedPayment[];
|
|
309
309
|
|
|
310
|
+
/**
|
|
311
|
+
* @description Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about [gateway error references](gateway_error_references)
|
|
312
|
+
|
|
313
|
+
*/
|
|
314
|
+
|
|
310
315
|
error_detail?:Transaction.GatewayErrorDetail;
|
|
311
316
|
}
|
|
312
317
|
export namespace Transaction {
|
|
@@ -835,23 +840,96 @@ The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status) is yet to b
|
|
|
835
840
|
date?:number;
|
|
836
841
|
}
|
|
837
842
|
export interface GatewayErrorDetail {
|
|
843
|
+
/**
|
|
844
|
+
* @description This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway
|
|
845
|
+
|
|
846
|
+
*/
|
|
847
|
+
|
|
838
848
|
request_id?:string;
|
|
839
849
|
|
|
850
|
+
/**
|
|
851
|
+
* @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
|
|
852
|
+
|
|
853
|
+
*/
|
|
854
|
+
|
|
840
855
|
error_category?:string;
|
|
841
856
|
|
|
857
|
+
/**
|
|
858
|
+
* @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
|
|
859
|
+
|
|
860
|
+
*/
|
|
861
|
+
|
|
842
862
|
error_code?:string;
|
|
843
863
|
|
|
864
|
+
/**
|
|
865
|
+
* @description A message provided by the gateway that describes the nature of the error encountered
|
|
866
|
+
|
|
867
|
+
*/
|
|
868
|
+
|
|
844
869
|
error_message?:string;
|
|
845
870
|
|
|
871
|
+
/**
|
|
872
|
+
* @description When a transaction is declined, this code is provided by the gateway to specify the reason for the decline
|
|
873
|
+
|
|
874
|
+
*/
|
|
875
|
+
|
|
846
876
|
decline_code?:string;
|
|
847
877
|
|
|
878
|
+
/**
|
|
879
|
+
* @description This message gives a descriptive explanation of the reason for the transaction's decline
|
|
880
|
+
|
|
881
|
+
*/
|
|
882
|
+
|
|
848
883
|
decline_message?:string;
|
|
849
884
|
|
|
885
|
+
/**
|
|
886
|
+
* @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
|
|
887
|
+
|
|
888
|
+
*/
|
|
889
|
+
|
|
850
890
|
network_error_code?:string;
|
|
851
891
|
|
|
892
|
+
/**
|
|
893
|
+
* @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
|
|
894
|
+
|
|
895
|
+
*/
|
|
896
|
+
|
|
897
|
+
network_error_message?:string;
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* @description This parameter indicates which specific data field or attribute in the request caused the error
|
|
901
|
+
|
|
902
|
+
*/
|
|
903
|
+
|
|
852
904
|
error_field?:string;
|
|
853
905
|
|
|
906
|
+
/**
|
|
907
|
+
* @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
|
|
908
|
+
|
|
909
|
+
*/
|
|
910
|
+
|
|
854
911
|
recommendation_code?:string;
|
|
912
|
+
|
|
913
|
+
/**
|
|
914
|
+
* @description This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue
|
|
915
|
+
|
|
916
|
+
*/
|
|
917
|
+
|
|
918
|
+
recommendation_message?:string;
|
|
919
|
+
|
|
920
|
+
/**
|
|
921
|
+
* @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
|
|
922
|
+
|
|
923
|
+
*/
|
|
924
|
+
|
|
925
|
+
processor_error_code?:string;
|
|
926
|
+
|
|
927
|
+
/**
|
|
928
|
+
* @description This message describes the specific error that the payment processor encountered
|
|
929
|
+
|
|
930
|
+
*/
|
|
931
|
+
|
|
932
|
+
processor_error_message?:string;
|
|
855
933
|
}
|
|
856
934
|
}
|
|
857
935
|
}
|
|
@@ -124,7 +124,7 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
|
|
|
124
124
|
|
|
125
125
|
*/
|
|
126
126
|
|
|
127
|
-
pdf(input
|
|
127
|
+
pdf(input:PdfInputParam):ChargebeeRequest<PdfResponse>;
|
|
128
128
|
}
|
|
129
129
|
export interface CreateResponse {
|
|
130
130
|
usage:Usage;
|
|
@@ -288,7 +288,7 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
|
|
|
288
288
|
|
|
289
289
|
*/
|
|
290
290
|
|
|
291
|
-
invoice
|
|
291
|
+
invoice:{id:string};
|
|
292
292
|
}
|
|
293
293
|
|
|
294
294
|
}
|