chargebee 2.28.0 → 2.30.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/.github/ISSUE_TEMPLATE/bug_report.yml +81 -0
- package/.github/ISSUE_TEMPLATE/config.yml +6 -0
- package/.github/ISSUE_TEMPLATE/feature_request.yml +34 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +8 -0
- package/.github/workflows/greeting.yml +47 -0
- package/CHANGELOG.md +59 -0
- package/SECURITY.md +8 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +0 -14
- package/package.json +1 -1
- package/types/core.d.ts +4 -4
- package/types/resources/AttachedItem.d.ts +88 -88
- package/types/resources/Card.d.ts +68 -68
- package/types/resources/Comment.d.ts +50 -44
- package/types/resources/Coupon.d.ts +242 -207
- package/types/resources/CouponSet.d.ts +72 -68
- package/types/resources/CreditNote.d.ts +612 -236
- package/types/resources/Customer.d.ts +655 -513
- package/types/resources/DifferentialPrice.d.ts +99 -74
- package/types/resources/EntitlementOverride.d.ts +27 -12
- package/types/resources/Estimate.d.ts +450 -450
- package/types/resources/Event.d.ts +30 -12
- package/types/resources/Export.d.ts +200 -200
- package/types/resources/Feature.d.ts +66 -35
- package/types/resources/Gift.d.ts +54 -44
- package/types/resources/HostedPage.d.ts +381 -381
- package/types/resources/InAppSubscription.d.ts +94 -90
- package/types/resources/Invoice.d.ts +1242 -660
- package/types/resources/Item.d.ts +148 -142
- package/types/resources/ItemEntitlement.d.ts +36 -36
- package/types/resources/ItemFamily.d.ts +45 -45
- package/types/resources/ItemPrice.d.ts +317 -273
- package/types/resources/PaymentIntent.d.ts +60 -60
- package/types/resources/PaymentReferenceNumber.d.ts +1 -1
- package/types/resources/PaymentVoucher.d.ts +74 -59
- package/types/resources/PortalSession.d.ts +45 -20
- package/types/resources/PromotionalCredit.d.ts +68 -68
- package/types/resources/Purchase.d.ts +3 -3
- package/types/resources/Quote.d.ts +655 -366
- package/types/resources/QuoteLineGroup.d.ts +245 -0
- package/types/resources/QuotedCharge.d.ts +170 -0
- package/types/resources/QuotedSubscription.d.ts +219 -0
- package/types/resources/SiteMigrationDetail.d.ts +7 -7
- package/types/resources/Subscription.d.ts +1219 -932
- package/types/resources/SubscriptionEntitlement.d.ts +33 -12
- package/types/resources/ThirdPartyPaymentMethod.d.ts +1 -1
- package/types/resources/TimeMachine.d.ts +15 -15
- package/types/resources/Token.d.ts +0 -116
- package/types/resources/Transaction.d.ts +229 -112
- package/types/resources/UnbilledCharge.d.ts +112 -67
- package/types/resources/Usage.d.ts +46 -47
- package/types/resources/VirtualBankAccount.d.ts +66 -66
- package/types/resources/Media.d.ts +0 -33
- package/types/resources/NonSubscription.d.ts +0 -65
|
@@ -56,7 +56,7 @@ declare module 'chargebee' {
|
|
|
56
56
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
59
|
-
payment_method_type?:'giropay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'sofort' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'card';
|
|
59
|
+
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card';
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
62
|
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
@@ -133,20 +133,6 @@ declare module 'chargebee' {
|
|
|
133
133
|
}
|
|
134
134
|
export namespace PaymentIntent {
|
|
135
135
|
export class PaymentIntentResource {
|
|
136
|
-
/**
|
|
137
|
-
* @description Retrieves the PaymentIntent resource.
|
|
138
|
-
|
|
139
|
-
*/
|
|
140
|
-
|
|
141
|
-
retrieve(payment_intent_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
142
|
-
|
|
143
|
-
/**
|
|
144
|
-
* @description Updating properties on a PaymentIntent object. All the subsequent 3DS transaction attempts will have the updated values.
|
|
145
|
-
|
|
146
|
-
*/
|
|
147
|
-
|
|
148
|
-
update(payment_intent_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
|
|
149
|
-
|
|
150
136
|
/**
|
|
151
137
|
* @description Creates a PaymentIntent object. This is to be used with Chargebee.js API to complete the 3DS flow for new or stored cards.
|
|
152
138
|
|
|
@@ -163,57 +149,20 @@ If multiple [business entities](/docs/api/advanced-features#mbe) are created for
|
|
|
163
149
|
*/
|
|
164
150
|
|
|
165
151
|
create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
|
|
166
|
-
}
|
|
167
|
-
export interface RetrieveResponse {
|
|
168
|
-
payment_intent:PaymentIntent;
|
|
169
|
-
}
|
|
170
|
-
|
|
171
|
-
export interface UpdateResponse {
|
|
172
|
-
payment_intent:PaymentIntent;
|
|
173
|
-
}
|
|
174
|
-
export interface UpdateInputParam {
|
|
175
|
-
|
|
176
|
-
/**
|
|
177
|
-
* @description Amount(in cents) to be authorized for 3DS flow.
|
|
178
|
-
|
|
179
|
-
*/
|
|
180
|
-
|
|
181
|
-
amount?:number;
|
|
182
|
-
|
|
183
|
-
/**
|
|
184
|
-
* @description The currency code (ISO 4217 format) of the amount used in transaction.
|
|
185
|
-
|
|
186
|
-
*/
|
|
187
|
-
|
|
188
|
-
currency_code?:string;
|
|
189
|
-
|
|
190
|
-
/**
|
|
191
|
-
* @description The gateway account used for performing the 3DS flow.
|
|
192
|
-
|
|
193
|
-
*/
|
|
194
|
-
|
|
195
|
-
gateway_account_id?:string;
|
|
196
|
-
|
|
197
|
-
/**
|
|
198
|
-
* @description The payment method of this intent. \* google_pay - google_pay \* apple_pay - apple_pay \* ideal - ideal \* bancontact - bancontact \* netbanking_emandates - netbanking_emandates \* direct_debit - direct_debit \* card - card \* dotpay - dotpay \* giropay - giropay \* upi - upi \* sofort - sofort \* paypal_express_checkout - paypal_express_checkout
|
|
199
|
-
|
|
200
|
-
*/
|
|
201
|
-
|
|
202
|
-
payment_method_type?:'giropay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'sofort' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'card';
|
|
203
152
|
|
|
204
153
|
/**
|
|
205
|
-
* @description
|
|
154
|
+
* @description Updating properties on a PaymentIntent object. All the subsequent 3DS transaction attempts will have the updated values.
|
|
206
155
|
|
|
207
156
|
*/
|
|
208
|
-
|
|
209
|
-
|
|
157
|
+
|
|
158
|
+
update(payment_intent_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
|
|
210
159
|
|
|
211
160
|
/**
|
|
212
|
-
* @description
|
|
161
|
+
* @description Retrieves the PaymentIntent resource.
|
|
213
162
|
|
|
214
163
|
*/
|
|
215
|
-
|
|
216
|
-
|
|
164
|
+
|
|
165
|
+
retrieve(payment_intent_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
217
166
|
}
|
|
218
167
|
export interface CreateResponse {
|
|
219
168
|
payment_intent:PaymentIntent;
|
|
@@ -277,7 +226,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
277
226
|
|
|
278
227
|
*/
|
|
279
228
|
|
|
280
|
-
payment_method_type?:'giropay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'sofort' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'card';
|
|
229
|
+
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card';
|
|
281
230
|
|
|
282
231
|
/**
|
|
283
232
|
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
@@ -293,6 +242,57 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
293
242
|
|
|
294
243
|
failure_url?:string;
|
|
295
244
|
}
|
|
245
|
+
export interface UpdateResponse {
|
|
246
|
+
payment_intent:PaymentIntent;
|
|
247
|
+
}
|
|
248
|
+
export interface UpdateInputParam {
|
|
249
|
+
|
|
250
|
+
/**
|
|
251
|
+
* @description Amount(in cents) to be authorized for 3DS flow.
|
|
252
|
+
|
|
253
|
+
*/
|
|
254
|
+
|
|
255
|
+
amount?:number;
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* @description The currency code (ISO 4217 format) of the amount used in transaction.
|
|
259
|
+
|
|
260
|
+
*/
|
|
261
|
+
|
|
262
|
+
currency_code?:string;
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* @description The gateway account used for performing the 3DS flow.
|
|
266
|
+
|
|
267
|
+
*/
|
|
268
|
+
|
|
269
|
+
gateway_account_id?:string;
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* @description The payment method of this intent. \* google_pay - google_pay \* boleto - boleto \* apple_pay - apple_pay \* ideal - ideal \* bancontact - bancontact \* netbanking_emandates - netbanking_emandates \* direct_debit - direct_debit \* card - card \* dotpay - dotpay \* giropay - giropay \* upi - upi \* sofort - sofort \* paypal_express_checkout - paypal_express_checkout
|
|
273
|
+
|
|
274
|
+
*/
|
|
275
|
+
|
|
276
|
+
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card';
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
280
|
+
|
|
281
|
+
*/
|
|
282
|
+
|
|
283
|
+
success_url?:string;
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* @description The URL the customer will be directed to when 3DS verification fails. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
287
|
+
|
|
288
|
+
*/
|
|
289
|
+
|
|
290
|
+
failure_url?:string;
|
|
291
|
+
}
|
|
292
|
+
export interface RetrieveResponse {
|
|
293
|
+
payment_intent:PaymentIntent;
|
|
294
|
+
}
|
|
295
|
+
|
|
296
296
|
export interface PaymentAttempt {
|
|
297
297
|
/**
|
|
298
298
|
* @description Identifier for PaymentIntent's active payment attempt.
|
|
@@ -313,7 +313,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
313
313
|
|
|
314
314
|
*/
|
|
315
315
|
|
|
316
|
-
payment_method_type?:'giropay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'sofort' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'card';
|
|
316
|
+
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card';
|
|
317
317
|
|
|
318
318
|
/**
|
|
319
319
|
* @description Reference of PaymentIntent at gateway
|
|
@@ -14,7 +14,7 @@ declare module 'chargebee' {
|
|
|
14
14
|
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
|
-
type:'frn' | 'kid' | 'fik' | 'ocr';
|
|
17
|
+
type:'frn' | 'kid' | 'fik' | 'swiss_reference' | 'ocr';
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
20
|
* @description A number is generated based on the configuration type of the PRN during the invoice creation process.
|
|
@@ -74,7 +74,7 @@ declare module 'chargebee' {
|
|
|
74
74
|
|
|
75
75
|
/**
|
|
76
76
|
* @description The gateway through which this payment voucher was created.
|
|
77
|
-
**Note** : Note: Currently, `stripe` is the only supported gateway through which you can create the payment voucher. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro 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. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account 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. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway.
|
|
77
|
+
**Note** : Note: Currently, `stripe` is the only supported gateway through which you can create the payment voucher. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* paypal_payflow_pro - PayPal Payflow Pro 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. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account 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. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway.
|
|
78
78
|
|
|
79
79
|
*/
|
|
80
80
|
|
|
@@ -146,78 +146,70 @@ declare module 'chargebee' {
|
|
|
146
146
|
export namespace PaymentVoucher {
|
|
147
147
|
export class PaymentVoucherResource {
|
|
148
148
|
/**
|
|
149
|
-
* @description
|
|
149
|
+
* @description Creates a voucher type payment source. If you create this voucher type payment source using customer details, like tax ID, you can then generate a voucher with that payment source.
|
|
150
150
|
|
|
151
151
|
*/
|
|
152
152
|
|
|
153
|
-
|
|
153
|
+
create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
|
|
154
154
|
|
|
155
155
|
/**
|
|
156
|
-
* @description Retrieves
|
|
156
|
+
* @description Retrieves a voucher using the unique `payment_voucher_id`.
|
|
157
157
|
|
|
158
158
|
*/
|
|
159
159
|
|
|
160
|
-
|
|
160
|
+
retrieve(payment_voucher_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
161
161
|
|
|
162
162
|
/**
|
|
163
|
-
* @description Retrieves
|
|
163
|
+
* @description Retrieves vouchers for an invoice in reverse chronological order.
|
|
164
164
|
|
|
165
165
|
*/
|
|
166
166
|
|
|
167
|
-
|
|
167
|
+
payment_vouchers_for_invoice(invoice_id:string, input?:Payment_vouchersForInvoiceInputParam):ChargebeeRequest<Payment_vouchersForInvoiceResponse>;
|
|
168
168
|
|
|
169
169
|
/**
|
|
170
|
-
* @description
|
|
170
|
+
* @description Retrieves vouchers for a customer in reverse chronological order.
|
|
171
171
|
|
|
172
172
|
*/
|
|
173
173
|
|
|
174
|
-
|
|
174
|
+
payment_vouchers_for_customer(customer_id:string, input?:Payment_vouchersForCustomerInputParam):ChargebeeRequest<Payment_vouchersForCustomerResponse>;
|
|
175
175
|
}
|
|
176
|
-
export interface
|
|
176
|
+
export interface CreateResponse {
|
|
177
|
+
payment_voucher:PaymentVoucher;
|
|
178
|
+
}
|
|
179
|
+
export interface CreateInputParam {
|
|
180
|
+
|
|
177
181
|
/**
|
|
178
|
-
* @description
|
|
182
|
+
* @description The unique identifier of the customer for whom you want to create the voucher.
|
|
179
183
|
|
|
180
184
|
*/
|
|
181
185
|
|
|
182
|
-
|
|
186
|
+
customer_id:string;
|
|
183
187
|
|
|
184
188
|
/**
|
|
185
|
-
* @description
|
|
189
|
+
* @description The identifier of the payment source used for generating the voucher.
|
|
186
190
|
|
|
187
191
|
*/
|
|
188
192
|
|
|
189
|
-
|
|
190
|
-
}
|
|
191
|
-
export interface Payment_vouchersForCustomerInputParam {
|
|
192
|
-
[key : string]: any;
|
|
193
|
-
/**
|
|
194
|
-
* @description The number of resources to be returned.
|
|
195
|
-
|
|
196
|
-
*/
|
|
197
|
-
|
|
198
|
-
limit?:number;
|
|
193
|
+
payment_source_id?:string;
|
|
199
194
|
|
|
200
195
|
/**
|
|
201
|
-
* @description
|
|
196
|
+
* @description Parameters for voucher_payment_source
|
|
202
197
|
|
|
203
198
|
*/
|
|
204
|
-
|
|
205
|
-
offset?:string;
|
|
206
199
|
|
|
207
|
-
|
|
208
|
-
* @description Current status of Payment Voucher.
|
|
209
|
-
|
|
210
|
-
*/
|
|
211
|
-
|
|
212
|
-
status?:{in?:string,is?:'consumed' | 'expired' | 'failure' | 'active',is_not?:'consumed' | 'expired' | 'failure' | 'active',not_in?:string};
|
|
200
|
+
voucher_payment_source?:{voucher_type:VoucherType};
|
|
213
201
|
|
|
214
202
|
/**
|
|
215
|
-
* @description
|
|
203
|
+
* @description Parameters for `invoice_allocations`
|
|
216
204
|
|
|
217
205
|
*/
|
|
218
|
-
|
|
219
|
-
|
|
206
|
+
|
|
207
|
+
invoice_allocations?:{invoice_id:string}[];
|
|
208
|
+
}
|
|
209
|
+
export interface RetrieveResponse {
|
|
210
|
+
payment_voucher:PaymentVoucher;
|
|
220
211
|
}
|
|
212
|
+
|
|
221
213
|
export interface Payment_vouchersForInvoiceResponse {
|
|
222
214
|
/**
|
|
223
215
|
* @description Retrieves vouchers for an invoice in reverse chronological order.
|
|
@@ -236,21 +228,21 @@ declare module 'chargebee' {
|
|
|
236
228
|
export interface Payment_vouchersForInvoiceInputParam {
|
|
237
229
|
[key : string]: any;
|
|
238
230
|
/**
|
|
239
|
-
* @description
|
|
231
|
+
* @description Retrieves vouchers for an invoice in reverse chronological order.
|
|
240
232
|
|
|
241
233
|
*/
|
|
242
234
|
|
|
243
235
|
limit?:number;
|
|
244
236
|
|
|
245
237
|
/**
|
|
246
|
-
* @description
|
|
238
|
+
* @description Retrieves vouchers for an invoice in reverse chronological order.
|
|
247
239
|
|
|
248
240
|
*/
|
|
249
241
|
|
|
250
242
|
offset?:string;
|
|
251
243
|
|
|
252
244
|
/**
|
|
253
|
-
* @description
|
|
245
|
+
* @description Retrieves vouchers for an invoice in reverse chronological order.
|
|
254
246
|
|
|
255
247
|
*/
|
|
256
248
|
|
|
@@ -263,49 +255,72 @@ declare module 'chargebee' {
|
|
|
263
255
|
|
|
264
256
|
sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
|
|
265
257
|
}
|
|
266
|
-
export interface
|
|
267
|
-
payment_voucher:PaymentVoucher;
|
|
268
|
-
}
|
|
269
|
-
|
|
270
|
-
export interface CreateResponse {
|
|
271
|
-
payment_voucher:PaymentVoucher;
|
|
272
|
-
}
|
|
273
|
-
export interface CreateInputParam {
|
|
274
|
-
|
|
258
|
+
export interface Payment_vouchersForCustomerResponse {
|
|
275
259
|
/**
|
|
276
|
-
* @description
|
|
260
|
+
* @description Retrieves vouchers for a customer in reverse chronological order.
|
|
277
261
|
|
|
278
262
|
*/
|
|
279
263
|
|
|
280
|
-
|
|
264
|
+
list:{payment_voucher:PaymentVoucher}[];
|
|
281
265
|
|
|
282
266
|
/**
|
|
283
|
-
* @description
|
|
267
|
+
* @description Retrieves vouchers for a customer in reverse chronological order.
|
|
284
268
|
|
|
285
269
|
*/
|
|
286
270
|
|
|
287
|
-
|
|
288
|
-
|
|
271
|
+
next_offset?:string;
|
|
272
|
+
}
|
|
273
|
+
export interface Payment_vouchersForCustomerInputParam {
|
|
274
|
+
[key : string]: any;
|
|
289
275
|
/**
|
|
290
|
-
* @description
|
|
276
|
+
* @description Retrieves vouchers for a customer in reverse chronological order.
|
|
291
277
|
|
|
292
278
|
*/
|
|
279
|
+
|
|
280
|
+
limit?:number;
|
|
293
281
|
|
|
294
|
-
|
|
282
|
+
/**
|
|
283
|
+
* @description Retrieves vouchers for a customer in reverse chronological order.
|
|
284
|
+
|
|
285
|
+
*/
|
|
286
|
+
|
|
287
|
+
offset?:string;
|
|
295
288
|
|
|
296
289
|
/**
|
|
297
|
-
* @description
|
|
290
|
+
* @description Retrieves vouchers for a customer in reverse chronological order.
|
|
298
291
|
|
|
299
292
|
*/
|
|
293
|
+
|
|
294
|
+
status?:{in?:string,is?:'consumed' | 'expired' | 'failure' | 'active',is_not?:'consumed' | 'expired' | 'failure' | 'active',not_in?:string};
|
|
300
295
|
|
|
301
|
-
|
|
296
|
+
/**
|
|
297
|
+
* @description Retrieves vouchers for a customer in reverse chronological order.
|
|
298
|
+
|
|
299
|
+
*/
|
|
300
|
+
|
|
301
|
+
sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
|
|
302
302
|
}
|
|
303
303
|
export interface InvoicePaymentVoucher {
|
|
304
|
-
|
|
304
|
+
/**
|
|
305
|
+
* @description Identifier for the invoice.
|
|
306
|
+
|
|
307
|
+
*/
|
|
308
|
+
|
|
309
|
+
invoice_id:string;
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* @description Uniquely identifies the payment voucher.
|
|
313
|
+
|
|
314
|
+
*/
|
|
315
|
+
|
|
316
|
+
txn_id:string;
|
|
305
317
|
|
|
306
|
-
|
|
318
|
+
/**
|
|
319
|
+
* @description Timestamp at which the transaction is applied.
|
|
320
|
+
|
|
321
|
+
*/
|
|
307
322
|
|
|
308
|
-
applied_at
|
|
323
|
+
applied_at:number;
|
|
309
324
|
}
|
|
310
325
|
}
|
|
311
326
|
}
|
|
@@ -103,18 +103,11 @@ declare module 'chargebee' {
|
|
|
103
103
|
create(input?:CreateInputParam):ChargebeeRequest<CreateResponse>;
|
|
104
104
|
|
|
105
105
|
/**
|
|
106
|
-
* @description
|
|
107
|
-
|
|
108
|
-
* **auth_session_id** - this should be sent as part of the endpoint.
|
|
109
|
-
* **auth_session_token** - this should be sent as value for the input parameter **token**.
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
**Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.
|
|
106
|
+
* @description This API retrieves a portal session using `portal_session_id` as a path parameter.
|
|
114
107
|
|
|
115
108
|
*/
|
|
116
109
|
|
|
117
|
-
|
|
110
|
+
retrieve(portal_session_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
118
111
|
|
|
119
112
|
/**
|
|
120
113
|
* @description Logs out the portal session. Typically this should be called when customers logout of your application.
|
|
@@ -130,11 +123,18 @@ If this API is called for a Portal Session that currently is in :
|
|
|
130
123
|
logout(portal_session_id:string):ChargebeeRequest<LogoutResponse>;
|
|
131
124
|
|
|
132
125
|
/**
|
|
133
|
-
* @description
|
|
126
|
+
* @description When an user is sent back to your return URL with session details, you should validate that information by calling this API. The details passed to the **return_url** should be sent as below:
|
|
127
|
+
|
|
128
|
+
* **auth_session_id** - this should be sent as part of the endpoint.
|
|
129
|
+
* **auth_session_token** - this should be sent as value for the input parameter **token**.
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
**Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.
|
|
134
134
|
|
|
135
135
|
*/
|
|
136
136
|
|
|
137
|
-
|
|
137
|
+
activate(portal_session_id:string, input:ActivateInputParam):ChargebeeRequest<ActivateResponse>;
|
|
138
138
|
}
|
|
139
139
|
export interface CreateResponse {
|
|
140
140
|
portal_session:PortalSession;
|
|
@@ -164,6 +164,14 @@ If this API is called for a Portal Session that currently is in :
|
|
|
164
164
|
|
|
165
165
|
customer?:{id:string};
|
|
166
166
|
}
|
|
167
|
+
export interface RetrieveResponse {
|
|
168
|
+
portal_session:PortalSession;
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
export interface LogoutResponse {
|
|
172
|
+
portal_session:PortalSession;
|
|
173
|
+
}
|
|
174
|
+
|
|
167
175
|
export interface ActivateResponse {
|
|
168
176
|
portal_session:PortalSession;
|
|
169
177
|
}
|
|
@@ -176,23 +184,40 @@ If this API is called for a Portal Session that currently is in :
|
|
|
176
184
|
|
|
177
185
|
token:string;
|
|
178
186
|
}
|
|
179
|
-
export interface LogoutResponse {
|
|
180
|
-
portal_session:PortalSession;
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
export interface RetrieveResponse {
|
|
184
|
-
portal_session:PortalSession;
|
|
185
|
-
}
|
|
186
|
-
|
|
187
187
|
export interface LinkedCustomer {
|
|
188
|
-
|
|
188
|
+
/**
|
|
189
|
+
* @description Identifier of the customer.
|
|
190
|
+
|
|
191
|
+
*/
|
|
192
|
+
|
|
193
|
+
customer_id:string;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* @description Email of the customer. Configured email notifications will be sent to this email.
|
|
197
|
+
|
|
198
|
+
*/
|
|
189
199
|
|
|
190
200
|
email?:string;
|
|
191
201
|
|
|
202
|
+
/**
|
|
203
|
+
* @description The customer has billing address.
|
|
204
|
+
|
|
205
|
+
*/
|
|
206
|
+
|
|
192
207
|
has_billing_address?:boolean;
|
|
193
208
|
|
|
209
|
+
/**
|
|
210
|
+
* @description The customer has payment method.
|
|
211
|
+
|
|
212
|
+
*/
|
|
213
|
+
|
|
194
214
|
has_payment_method?:boolean;
|
|
195
215
|
|
|
216
|
+
/**
|
|
217
|
+
* @description The customer has atleast one active subscription.
|
|
218
|
+
|
|
219
|
+
*/
|
|
220
|
+
|
|
196
221
|
has_active_subscription?:boolean;
|
|
197
222
|
}
|
|
198
223
|
}
|