chargebee 2.33.1 → 2.34.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 +43 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +48 -0
- package/package.json +1 -1
- package/types/core.d.ts +5 -5
- package/types/index.d.ts +6 -0
- package/types/resources/Attribute.d.ts +9 -0
- package/types/resources/Customer.d.ts +2 -2
- package/types/resources/Estimate.d.ts +304 -1
- package/types/resources/Export.d.ts +1 -1
- package/types/resources/Gift.d.ts +87 -1
- package/types/resources/ImpactedItemPrice.d.ts +22 -0
- package/types/resources/Installment.d.ts +121 -0
- package/types/resources/InstallmentConfig.d.ts +162 -0
- package/types/resources/Invoice.d.ts +200 -1
- package/types/resources/ItemPrice.d.ts +0 -7
- package/types/resources/PaymentIntent.d.ts +4 -4
- package/types/resources/PaymentSource.d.ts +2 -2
- package/types/resources/Purchase.d.ts +91 -5
- package/types/resources/Subscription.d.ts +1252 -209
- package/types/resources/Transaction.d.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,46 @@
|
|
|
1
|
+
### v2.34.0 (2024-03-20)
|
|
2
|
+
* * *
|
|
3
|
+
|
|
4
|
+
#### New resources:
|
|
5
|
+
* Attribute has been added.
|
|
6
|
+
* ImpactedItemPrice has been added.
|
|
7
|
+
* InstallmentConfig has been added.
|
|
8
|
+
* Installment has been added.
|
|
9
|
+
|
|
10
|
+
#### Removed attributes:
|
|
11
|
+
* product_id has been removed from ItemPrice resource.
|
|
12
|
+
|
|
13
|
+
#### New Enum values:
|
|
14
|
+
* klarna_pay_now has been added to TypeEnum in Customer resource.
|
|
15
|
+
* klarna_pay_now has been added to PaymentMethodEnum.
|
|
16
|
+
* klarna_pay_now has been added to PaymentMethodTypeEnum enum.
|
|
17
|
+
* klarna_pay_now has been added to TypeEnum.
|
|
18
|
+
* price_variant has been added to EntityTypeEnum.
|
|
19
|
+
* price_variant_created has been added in EventType enum.
|
|
20
|
+
* price_variant_updated has been added in EventType enum.
|
|
21
|
+
* price_variant_deleted has been added in EventType enum.
|
|
22
|
+
|
|
23
|
+
#### Removed Enum values:
|
|
24
|
+
* product and variant have been removed from EntityTypeEnum.
|
|
25
|
+
|
|
26
|
+
#### New Input parameters:
|
|
27
|
+
* config_id has been added to Invoice#InstallmentsRequest.
|
|
28
|
+
* amount has been added to Invoice#InstallmentsRequest.
|
|
29
|
+
* payment_source_id has been added to Purchase#CreateRequest.
|
|
30
|
+
* installment_info[config_id] has been added to Purchase#CreateRequest.
|
|
31
|
+
* installment_info[amount] has been added to Purchase#CreateRequest.
|
|
32
|
+
* subscription_info[contract_term_billing_cycle_on_renewal] has been added to Purchase#CreateRequest.
|
|
33
|
+
* contract_terms[index] has been added to Purchase#CreateRequest.
|
|
34
|
+
* contract_terms[action_at_term_end] has been added to Purchase#CreateRequest.
|
|
35
|
+
* contract_terms[cancellation_cutoff_period] has been added to Purchase#CreateRequest.
|
|
36
|
+
* subscription_info[contract_term_billing_cycle_on_renewal] has been added to Purchase#EstimateRequest.
|
|
37
|
+
* contract_terms[index] has been added to Purchase#EstimateRequest.
|
|
38
|
+
* contract_terms[action_at_term_end] has been added to Purchase#EstimateRequest.
|
|
39
|
+
* contract_terms[cancellation_cutoff_period] has been added to Purchase#EstimateRequest.
|
|
40
|
+
|
|
41
|
+
#### Deprecated input parameters:
|
|
42
|
+
* product_created, product_updated, product_deleted, variant_created, variant_updated, variant_deleted has been deprecated in EventTypeEnum.
|
|
43
|
+
|
|
1
44
|
### v2.33.1 (2024-03-06)
|
|
2
45
|
* * *
|
|
3
46
|
* NonSubscription has been added.
|
package/lib/chargebee.js
CHANGED
|
@@ -908,6 +908,13 @@ var _endpoints = {
|
|
|
908
908
|
"/update_details",
|
|
909
909
|
true
|
|
910
910
|
],
|
|
911
|
+
[
|
|
912
|
+
"installments",
|
|
913
|
+
"POST",
|
|
914
|
+
"/invoices",
|
|
915
|
+
"/installments",
|
|
916
|
+
true
|
|
917
|
+
],
|
|
911
918
|
[
|
|
912
919
|
"resend_einvoice",
|
|
913
920
|
"POST",
|
|
@@ -2352,6 +2359,7 @@ var _endpoints = {
|
|
|
2352
2359
|
true
|
|
2353
2360
|
]
|
|
2354
2361
|
],
|
|
2362
|
+
"attribute": [],
|
|
2355
2363
|
"item_price": [
|
|
2356
2364
|
[
|
|
2357
2365
|
"create",
|
|
@@ -2537,6 +2545,7 @@ var _endpoints = {
|
|
|
2537
2545
|
],
|
|
2538
2546
|
"impacted_subscription": [],
|
|
2539
2547
|
"impacted_item": [],
|
|
2548
|
+
"impacted_item_price": [],
|
|
2540
2549
|
"subscription_entitlement": [
|
|
2541
2550
|
[
|
|
2542
2551
|
"subscription_entitlements_for_subscription",
|
|
@@ -2699,6 +2708,45 @@ var _endpoints = {
|
|
|
2699
2708
|
"/payment_vouchers",
|
|
2700
2709
|
true
|
|
2701
2710
|
]
|
|
2711
|
+
],
|
|
2712
|
+
"installment_config": [
|
|
2713
|
+
[
|
|
2714
|
+
"create",
|
|
2715
|
+
"POST",
|
|
2716
|
+
"/installment_configs",
|
|
2717
|
+
null,
|
|
2718
|
+
false
|
|
2719
|
+
],
|
|
2720
|
+
[
|
|
2721
|
+
"retrieve",
|
|
2722
|
+
"GET",
|
|
2723
|
+
"/installment_configs",
|
|
2724
|
+
null,
|
|
2725
|
+
true
|
|
2726
|
+
],
|
|
2727
|
+
[
|
|
2728
|
+
"delete",
|
|
2729
|
+
"POST",
|
|
2730
|
+
"/installment_configs",
|
|
2731
|
+
"/delete",
|
|
2732
|
+
true
|
|
2733
|
+
]
|
|
2734
|
+
],
|
|
2735
|
+
"installment": [
|
|
2736
|
+
[
|
|
2737
|
+
"retrieve",
|
|
2738
|
+
"GET",
|
|
2739
|
+
"/installments",
|
|
2740
|
+
null,
|
|
2741
|
+
true
|
|
2742
|
+
],
|
|
2743
|
+
[
|
|
2744
|
+
"list",
|
|
2745
|
+
"GET",
|
|
2746
|
+
"/installments",
|
|
2747
|
+
null,
|
|
2748
|
+
false
|
|
2749
|
+
]
|
|
2702
2750
|
]
|
|
2703
2751
|
};
|
|
2704
2752
|
module.exports = _endpoints;
|
package/package.json
CHANGED
package/types/core.d.ts
CHANGED
|
@@ -40,9 +40,9 @@ declare module 'chargebee' {
|
|
|
40
40
|
type EinvoicingMethod = 'automatic' | 'manual' | 'site_default'
|
|
41
41
|
type EndScheduleOn = 'after_number_of_intervals' | 'specific_date' | 'subscription_end'
|
|
42
42
|
type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med2' | 'med1'
|
|
43
|
-
type EntityType = 'item' | 'product' | 'coupon' | 'addon' | 'item_price' | 'business_entity' | 'subscription' | 'item_family' | 'credit_note' | 'quote' | 'variant' | 'invoice' | 'plan' | 'transaction' | 'customer' | 'order'
|
|
43
|
+
type EntityType = 'item' | 'product' | 'coupon' | 'addon' | 'item_price' | 'business_entity' | 'subscription' | 'item_family' | 'credit_note' | 'quote' | 'variant' | 'invoice' | 'plan' | 'transaction' | 'customer' | 'order' | 'price_variant'
|
|
44
44
|
type EventName = 'cancellation_page_loaded'
|
|
45
|
-
type EventType = 'subscription_pause_scheduled' | 'order_delivered' | 'customer_business_entity_changed' | 'subscription_advance_invoice_schedule_added' | 'gift_expired' | 'tax_withheld_deleted' | 'coupon_codes_added' | 'unbilled_charges_deleted' | 'gift_cancelled' | 'coupon_updated' | 'order_cancelled' | 'coupon_deleted' | 'product_updated' | 'subscription_scheduled_changes_removed' | 'pending_invoice_created' | 'product_deleted' | 'entitlement_overrides_auto_removed' | 'unbilled_charges_created' | 'subscription_resumed' | 'subscription_business_entity_changed' | 'subscription_cancelled' | 'item_entitlements_removed' | 'business_entity_created' | 'payment_source_deleted' | 'quote_deleted' | 'invoice_updated' | 'coupon_set_updated' | 'differential_price_updated' | 'subscription_advance_invoice_schedule_removed' | 'entitlement_overrides_removed' | 'subscription_activated_with_backdating' | 'card_deleted' | 'order_ready_to_ship' | 'subscription_trial_end_reminder' | 'subscription_shipping_address_updated' | 'variant_updated' | 'voucher_create_failed' | 'gift_claimed' | 'business_entity_updated' | 'subscription_scheduled_resumption_removed' | 'payment_initiated' | 'feature_archived' | 'subscription_reactivated_with_backdating' | 'customer_deleted' | 'token_expired' | 'card_added' | 'coupon_created' | 'refund_initiated' | 'invoice_generated_with_backdating' | 'add_usages_reminder' | 'item_price_entitlements_updated' | 'item_price_deleted' | 'virtual_bank_account_deleted' | 'subscription_created' | 'voucher_created' | 'feature_activated' | 'subscription_entitlements_created' | 'payment_source_locally_deleted' | 'order_returned' | 'subscription_deleted' | 'invoice_generated' | 'voucher_expired' | 'authorization_succeeded' | 'payment_source_added' | 'gift_scheduled' | 'item_price_created' | 'subscription_changes_scheduled' | 'subscription_changed_with_backdating' | 'variant_created' | 'subscription_scheduled_cancellation_removed' | 'payment_refunded' | 'gift_unclaimed' | 'product_created' | 'differential_price_created' | 'virtual_bank_account_added' | 'payment_intent_created' | 'transaction_created' | 'credit_note_created_with_backdating' | 'contract_term_terminated' | 'item_family_updated' | 'order_created' | 'payment_succeeded' | 'subscription_canceled_with_backdating' | 'unbilled_charges_voided' | 'quote_created' | 'customer_moved_in' | 'coupon_set_deleted' | 'subscription_advance_invoice_schedule_updated' | 'attached_item_created' | 'customer_changed' | 'subscription_started' | 'item_deleted' | 'subscription_activated' | 'payment_source_expiring' | 'subscription_reactivated' | 'order_updated' | 'subscription_scheduled_pause_removed' | 'subscription_cancellation_reminder' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'entitlement_overrides_updated' | 'promotional_credits_added' | 'item_family_deleted' | 'subscription_resumption_scheduled' | 'feature_reactivated' | 'coupon_codes_deleted' | 'card_expired' | 'credit_note_updated' | 'promotional_credits_deducted' | 'payment_source_expired' | 'customer_moved_out' | 'subscription_paused' | 'order_ready_to_process' | 'feature_created' | 'hierarchy_created' | 'attached_item_deleted' | 'transaction_deleted' | 'credit_note_created' | 'item_updated' | 'item_created' | 'coupon_set_created' | 'transaction_updated' | 'payment_intent_updated' | 'variant_deleted' | 'mrr_updated' | 'order_resent' | 'unbilled_charges_invoiced' | 'tax_withheld_recorded' | 'item_price_updated' | 'differential_price_deleted' | 'coupon_codes_updated' | 'virtual_bank_account_updated' | 'contract_term_created' | 'subscription_changed' | 'contract_term_cancelled' | 'contract_term_renewed' | 'invoice_deleted' | 'payment_failed' | 'credit_note_deleted' | 'tax_withheld_refunded' | 'contract_term_completed' | 'item_price_entitlements_removed' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided' | 'plan_deleted' | 'addon_deleted' | 'addon_updated' | 'addon_created' | 'plan_created' | 'entitlement_overrides_updated' | 'plan_updated'
|
|
45
|
+
type EventType = 'subscription_pause_scheduled' | 'order_delivered' | 'customer_business_entity_changed' | 'subscription_advance_invoice_schedule_added' | 'gift_expired' | 'tax_withheld_deleted' | 'coupon_codes_added' | 'unbilled_charges_deleted' | 'gift_cancelled' | 'coupon_updated' | 'order_cancelled' | 'coupon_deleted' | 'product_updated' | 'subscription_scheduled_changes_removed' | 'pending_invoice_created' | 'product_deleted' | 'entitlement_overrides_auto_removed' | 'unbilled_charges_created' | 'subscription_resumed' | 'subscription_business_entity_changed' | 'subscription_cancelled' | 'item_entitlements_removed' | 'business_entity_created' | 'payment_source_deleted' | 'quote_deleted' | 'invoice_updated' | 'coupon_set_updated' | 'differential_price_updated' | 'subscription_advance_invoice_schedule_removed' | 'entitlement_overrides_removed' | 'subscription_activated_with_backdating' | 'card_deleted' | 'order_ready_to_ship' | 'subscription_trial_end_reminder' | 'subscription_shipping_address_updated' | 'variant_updated' | 'voucher_create_failed' | 'gift_claimed' | 'business_entity_updated' | 'subscription_scheduled_resumption_removed' | 'payment_initiated' | 'feature_archived' | 'subscription_reactivated_with_backdating' | 'customer_deleted' | 'token_expired' | 'card_added' | 'coupon_created' | 'refund_initiated' | 'invoice_generated_with_backdating' | 'add_usages_reminder' | 'item_price_entitlements_updated' | 'item_price_deleted' | 'virtual_bank_account_deleted' | 'subscription_created' | 'voucher_created' | 'feature_activated' | 'subscription_entitlements_created' | 'payment_source_locally_deleted' | 'order_returned' | 'subscription_deleted' | 'invoice_generated' | 'voucher_expired' | 'authorization_succeeded' | 'payment_source_added' | 'gift_scheduled' | 'item_price_created' | 'subscription_changes_scheduled' | 'subscription_changed_with_backdating' | 'variant_created' | 'subscription_scheduled_cancellation_removed' | 'payment_refunded' | 'gift_unclaimed' | 'product_created' | 'differential_price_created' | 'virtual_bank_account_added' | 'payment_intent_created' | 'transaction_created' | 'credit_note_created_with_backdating' | 'contract_term_terminated' | 'item_family_updated' | 'order_created' | 'payment_succeeded' | 'subscription_canceled_with_backdating' | 'unbilled_charges_voided' | 'quote_created' | 'customer_moved_in' | 'coupon_set_deleted' | 'subscription_advance_invoice_schedule_updated' | 'attached_item_created' | 'customer_changed' | 'subscription_started' | 'item_deleted' | 'subscription_activated' | 'payment_source_expiring' | 'subscription_reactivated' | 'order_updated' | 'subscription_scheduled_pause_removed' | 'subscription_cancellation_reminder' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'entitlement_overrides_updated' | 'promotional_credits_added' | 'item_family_deleted' | 'subscription_resumption_scheduled' | 'feature_reactivated' | 'coupon_codes_deleted' | 'card_expired' | 'credit_note_updated' | 'promotional_credits_deducted' | 'payment_source_expired' | 'customer_moved_out' | 'subscription_paused' | 'order_ready_to_process' | 'feature_created' | 'hierarchy_created' | 'attached_item_deleted' | 'transaction_deleted' | 'credit_note_created' | 'item_updated' | 'item_created' | 'coupon_set_created' | 'transaction_updated' | 'payment_intent_updated' | 'variant_deleted' | 'mrr_updated' | 'order_resent' | 'unbilled_charges_invoiced' | 'tax_withheld_recorded' | 'item_price_updated' | 'differential_price_deleted' | 'coupon_codes_updated' | 'virtual_bank_account_updated' | 'contract_term_created' | 'subscription_changed' | 'contract_term_cancelled' | 'contract_term_renewed' | 'invoice_deleted' | 'payment_failed' | 'credit_note_deleted' | 'tax_withheld_refunded' | 'contract_term_completed' | 'item_price_entitlements_removed' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided' | 'plan_deleted' | 'addon_deleted' | 'addon_updated' | 'addon_created' | 'plan_created' | 'entitlement_overrides_updated' | 'plan_updated' | 'price_variant_deleted' | 'price_variant_updated' | 'price_variant_created'
|
|
46
46
|
type ExportType = 'data' | 'import_friendly_data'
|
|
47
47
|
type FreePeriodUnit = 'week' | 'month' | 'year' | 'day'
|
|
48
48
|
type FriendOfferType = 'coupon_code' | 'coupon' | 'none'
|
|
@@ -58,8 +58,8 @@ declare module 'chargebee' {
|
|
|
58
58
|
type OperationType = 'add' | 'remove'
|
|
59
59
|
type PauseOption = 'end_of_term' | 'billing_cycles' | 'immediately' | 'specific_date'
|
|
60
60
|
type PaymentInitiator = 'merchant' | 'customer'
|
|
61
|
-
type PaymentMethod = 'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
|
|
62
|
-
type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
|
|
61
|
+
type PaymentMethod = 'other' | 'netbanking_emandates' | 'klarna_pay_now' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
|
|
62
|
+
type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
|
|
63
63
|
type PaymentVoucherType = 'boleto'
|
|
64
64
|
type PeriodUnit = 'week' | 'month' | 'year' | 'day'
|
|
65
65
|
type PriceType = 'tax_exclusive' | 'tax_inclusive'
|
|
@@ -79,7 +79,7 @@ declare module 'chargebee' {
|
|
|
79
79
|
type Taxability = 'taxable' | 'exempt'
|
|
80
80
|
type TaxjarExemptionCategory = 'other' | 'wholesale' | 'government'
|
|
81
81
|
type TrialEndAction = 'activate_subscription' | 'plan_default' | 'cancel_subscription' | 'site_default'
|
|
82
|
-
type Type = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
|
|
82
|
+
type Type = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
|
|
83
83
|
type UnbilledChargesHandling = 'invoice' | 'no_action'
|
|
84
84
|
type UnbilledChargesOption = 'invoice' | 'delete'
|
|
85
85
|
type UnpaidInvoicesHandling = 'schedule_payment_collection' | 'no_action'
|
package/types/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
///<reference path='./resources/Address.d.ts' />
|
|
2
2
|
///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
|
|
3
3
|
///<reference path='./resources/AttachedItem.d.ts' />
|
|
4
|
+
///<reference path='./resources/Attribute.d.ts' />
|
|
4
5
|
///<reference path='./resources/Card.d.ts' />
|
|
5
6
|
///<reference path='./resources/Comment.d.ts' />
|
|
6
7
|
///<reference path='./resources/Contact.d.ts' />
|
|
@@ -25,8 +26,11 @@
|
|
|
25
26
|
///<reference path='./resources/Hierarchy.d.ts' />
|
|
26
27
|
///<reference path='./resources/HostedPage.d.ts' />
|
|
27
28
|
///<reference path='./resources/ImpactedItem.d.ts' />
|
|
29
|
+
///<reference path='./resources/ImpactedItemPrice.d.ts' />
|
|
28
30
|
///<reference path='./resources/ImpactedSubscription.d.ts' />
|
|
29
31
|
///<reference path='./resources/InAppSubscription.d.ts' />
|
|
32
|
+
///<reference path='./resources/Installment.d.ts' />
|
|
33
|
+
///<reference path='./resources/InstallmentConfig.d.ts' />
|
|
30
34
|
///<reference path='./resources/Invoice.d.ts' />
|
|
31
35
|
///<reference path='./resources/InvoiceEstimate.d.ts' />
|
|
32
36
|
///<reference path='./resources/Item.d.ts' />
|
|
@@ -83,6 +87,8 @@ declare module 'chargebee' {
|
|
|
83
87
|
static gift: Gift.GiftResource;
|
|
84
88
|
static hosted_page: HostedPage.HostedPageResource;
|
|
85
89
|
static in_app_subscription: InAppSubscription.InAppSubscriptionResource;
|
|
90
|
+
static installment: Installment.InstallmentResource;
|
|
91
|
+
static installment_config: InstallmentConfig.InstallmentConfigResource;
|
|
86
92
|
static invoice: Invoice.InvoiceResource;
|
|
87
93
|
static item: Item.ItemResource;
|
|
88
94
|
static item_entitlement: ItemEntitlement.ItemEntitlementResource;
|
|
@@ -1049,7 +1049,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
1049
1049
|
|
|
1050
1050
|
*/
|
|
1051
1051
|
|
|
1052
|
-
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,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',reference_id?:string};
|
|
1052
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
|
|
1053
1053
|
|
|
1054
1054
|
/**
|
|
1055
1055
|
* @description Parameters for billing_address
|
|
@@ -1694,7 +1694,7 @@ It is possible to set a value for this flag even when E-Invoicing is disabled. H
|
|
|
1694
1694
|
|
|
1695
1695
|
*/
|
|
1696
1696
|
|
|
1697
|
-
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,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',reference_id?:string};
|
|
1697
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
|
|
1698
1698
|
|
|
1699
1699
|
/**
|
|
1700
1700
|
* @description Parameters for invoice_allocations
|
|
@@ -246,6 +246,117 @@ In the response,
|
|
|
246
246
|
|
|
247
247
|
create_invoice_for_items(input:CreateInvoiceForItemsInputParam):ChargebeeRequest<CreateInvoiceForItemsResponse>;
|
|
248
248
|
}
|
|
249
|
+
export interface CreateSubscriptionResponse {
|
|
250
|
+
estimate:Estimate;
|
|
251
|
+
}
|
|
252
|
+
export interface CreateSubscriptionInputParam {
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* @description Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
|
|
256
|
+
|
|
257
|
+
*/
|
|
258
|
+
|
|
259
|
+
billing_cycles?:number;
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* @description List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
|
|
263
|
+
|
|
264
|
+
*/
|
|
265
|
+
|
|
266
|
+
mandatory_addons_to_remove?:string[];
|
|
267
|
+
|
|
268
|
+
/**
|
|
269
|
+
* @description The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
|
|
270
|
+
|
|
271
|
+
*/
|
|
272
|
+
|
|
273
|
+
terms_to_charge?:number;
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* @description 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. \* 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.
|
|
277
|
+
|
|
278
|
+
*/
|
|
279
|
+
|
|
280
|
+
billing_alignment_mode?:BillingAlignmentMode;
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* @description List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
|
|
284
|
+
|
|
285
|
+
*/
|
|
286
|
+
|
|
287
|
+
coupon_ids?:string[];
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* @description 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).
|
|
291
|
+
**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. .
|
|
292
|
+
|
|
293
|
+
*/
|
|
294
|
+
|
|
295
|
+
invoice_immediately?:boolean;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* @description The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date. `taxes` and `line_item_taxes` are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
|
|
299
|
+
|
|
300
|
+
*/
|
|
301
|
+
|
|
302
|
+
invoice_date?:number;
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* @description Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration.
|
|
306
|
+
|
|
307
|
+
*/
|
|
308
|
+
|
|
309
|
+
client_profile_id?:string;
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* @description Parameters for subscription
|
|
313
|
+
|
|
314
|
+
*/
|
|
315
|
+
|
|
316
|
+
subscription:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* @description Parameters for billing_address
|
|
320
|
+
|
|
321
|
+
*/
|
|
322
|
+
|
|
323
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
324
|
+
|
|
325
|
+
/**
|
|
326
|
+
* @description Parameters for shipping_address
|
|
327
|
+
|
|
328
|
+
*/
|
|
329
|
+
|
|
330
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
331
|
+
|
|
332
|
+
/**
|
|
333
|
+
* @description Parameters for customer
|
|
334
|
+
|
|
335
|
+
*/
|
|
336
|
+
|
|
337
|
+
customer?:{customer_type?:CustomerType,entity_code?:EntityCode,exempt_number?:string,exemption_details?:any[],registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* @description Parameters for contract_term
|
|
341
|
+
|
|
342
|
+
*/
|
|
343
|
+
|
|
344
|
+
contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
|
|
345
|
+
|
|
346
|
+
/**
|
|
347
|
+
* @description Parameters for addons
|
|
348
|
+
|
|
349
|
+
*/
|
|
350
|
+
|
|
351
|
+
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
352
|
+
|
|
353
|
+
/**
|
|
354
|
+
* @description Parameters for event_based_addons
|
|
355
|
+
|
|
356
|
+
*/
|
|
357
|
+
|
|
358
|
+
event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
359
|
+
}
|
|
249
360
|
export interface CreateSubItemEstimateResponse {
|
|
250
361
|
estimate:Estimate;
|
|
251
362
|
}
|
|
@@ -364,6 +475,102 @@ In the response,
|
|
|
364
475
|
|
|
365
476
|
item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
366
477
|
}
|
|
478
|
+
export interface CreateSubForCustomerEstimateResponse {
|
|
479
|
+
estimate:Estimate;
|
|
480
|
+
}
|
|
481
|
+
export interface CreateSubForCustomerEstimateInputParam {
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
485
|
+
|
|
486
|
+
*/
|
|
487
|
+
|
|
488
|
+
use_existing_balances?:boolean;
|
|
489
|
+
|
|
490
|
+
/**
|
|
491
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
492
|
+
|
|
493
|
+
*/
|
|
494
|
+
|
|
495
|
+
invoice_immediately?:boolean;
|
|
496
|
+
|
|
497
|
+
/**
|
|
498
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
499
|
+
|
|
500
|
+
*/
|
|
501
|
+
|
|
502
|
+
billing_cycles?:number;
|
|
503
|
+
|
|
504
|
+
/**
|
|
505
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
506
|
+
|
|
507
|
+
*/
|
|
508
|
+
|
|
509
|
+
mandatory_addons_to_remove?:string[];
|
|
510
|
+
|
|
511
|
+
/**
|
|
512
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
513
|
+
|
|
514
|
+
*/
|
|
515
|
+
|
|
516
|
+
terms_to_charge?:number;
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
520
|
+
|
|
521
|
+
*/
|
|
522
|
+
|
|
523
|
+
billing_alignment_mode?:'immediate' | 'delayed';
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
527
|
+
|
|
528
|
+
*/
|
|
529
|
+
|
|
530
|
+
invoice_date?:number;
|
|
531
|
+
|
|
532
|
+
/**
|
|
533
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
534
|
+
|
|
535
|
+
*/
|
|
536
|
+
|
|
537
|
+
coupon_ids?:string[];
|
|
538
|
+
|
|
539
|
+
/**
|
|
540
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
541
|
+
|
|
542
|
+
*/
|
|
543
|
+
|
|
544
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
548
|
+
|
|
549
|
+
*/
|
|
550
|
+
|
|
551
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
555
|
+
|
|
556
|
+
*/
|
|
557
|
+
|
|
558
|
+
contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
562
|
+
|
|
563
|
+
*/
|
|
564
|
+
|
|
565
|
+
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* @description Create a subscription for the existing estimate of a customer.
|
|
569
|
+
|
|
570
|
+
*/
|
|
571
|
+
|
|
572
|
+
event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
573
|
+
}
|
|
367
574
|
export interface CreateSubItemForCustomerEstimateResponse {
|
|
368
575
|
estimate:Estimate;
|
|
369
576
|
}
|
|
@@ -874,6 +1081,102 @@ In the response,
|
|
|
874
1081
|
|
|
875
1082
|
invoice_immediately?:boolean;
|
|
876
1083
|
}
|
|
1084
|
+
export interface CancelSubscriptionResponse {
|
|
1085
|
+
estimate:Estimate;
|
|
1086
|
+
}
|
|
1087
|
+
export interface CancelSubscriptionInputParam {
|
|
1088
|
+
|
|
1089
|
+
/**
|
|
1090
|
+
* @description Set this to `true` if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription `status` changes to `non_renewing`.
|
|
1091
|
+
|
|
1092
|
+
*/
|
|
1093
|
+
|
|
1094
|
+
end_of_term?:boolean;
|
|
1095
|
+
|
|
1096
|
+
/**
|
|
1097
|
+
* @description Specify the date/time at which you want to cancel the subscription. This parameter should not be provided when `end_of_term` is passed as `true`. `cancel_at` can be set to a value in the past. This is called backdating. Use backdating when the subscription has been canceled already but its billing has been delayed. The following prerequisites must be met to allow backdating:
|
|
1098
|
+
|
|
1099
|
+
* Backdating must be enabled for subscription cancellation.
|
|
1100
|
+
* The current day of the month does not exceed the limit set in Chargebee for backdating subscription cancellation. This limit is typically the day of the month by which the accounting for the previous month must be closed.
|
|
1101
|
+
* The date is on or after `current_term_start`.
|
|
1102
|
+
* The date is on or after the last date/time any of the following changes were made:
|
|
1103
|
+
* Changes in the recurring items or their prices.
|
|
1104
|
+
* Addition of non-recurring items.
|
|
1105
|
+
* 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 subscription's plan is 2 months and today is 14th April, `changes_scheduled_at` cannot be earlier than 14th February.
|
|
1106
|
+
.
|
|
1107
|
+
|
|
1108
|
+
*/
|
|
1109
|
+
|
|
1110
|
+
cancel_at?:number;
|
|
1111
|
+
|
|
1112
|
+
/**
|
|
1113
|
+
* @description For immediate cancellation (`end_of_term` = `false`), specify how to provide credits for current term charges. When not provided, the [site default](https://www.chargebee.com/docs/cancellations.html#configure-subscription-cancellation) is considered. \* none - No credits notes are created. \* full - Credits are issues for the full value of the current term charges. \* prorate - Prorated credits are issued.
|
|
1114
|
+
|
|
1115
|
+
*/
|
|
1116
|
+
|
|
1117
|
+
credit_option_for_current_term_charges?:CreditOptionForCurrentTermCharges;
|
|
1118
|
+
|
|
1119
|
+
/**
|
|
1120
|
+
* @description For immediate cancellation (`end_of_term` = `false`), specify how to handle any unbilled charges. When not provided, the [site default](https://www.chargebee.com/docs/cancellations.html#configure-subscription-cancellation) is considered. \* invoice - An invoice is generated immediately with the unbilled charges. \* delete - The unbilled charges are deleted.
|
|
1121
|
+
|
|
1122
|
+
*/
|
|
1123
|
+
|
|
1124
|
+
unbilled_charges_option?:UnbilledChargesOption;
|
|
1125
|
+
|
|
1126
|
+
/**
|
|
1127
|
+
* @description Applicable when the subscription has past due invoices. Specify this if you want to close the due invoices of the subscription. If specified as schedule_payment_collection/write_off, the due invoices of the subscription will be qualified for the selected operation after the remaining refundable credits and excess payments are applied. **Note:** The payment collection attempt will be asynchronous. Not applicable when 'end_of_term' is true. \* no_action - No action is taken. \* write_off - The amount due in the invoices will be written-off. Credit notes created due to write-off will not be sent in the response. \* schedule_payment_collection - An automatic charge for the due amount of the past invoices will be attempted on the payment method available, if customer's auto-collection property is 'ON'.
|
|
1128
|
+
|
|
1129
|
+
*/
|
|
1130
|
+
|
|
1131
|
+
account_receivables_handling?:AccountReceivablesHandling;
|
|
1132
|
+
|
|
1133
|
+
/**
|
|
1134
|
+
* @description Applicable when the customer has remaining refundable credits(issued against online payments). If specified as schedule_refund, the refund will be initiated for these credits after they are applied against the subscription's past due invoices if any. **Note:** The refunds initiated will be asynchronous. Not applicable when 'end_of_term' is true. \* schedule_refund - Initiates refund of the remaining credits. \* no_action - No action is taken.
|
|
1135
|
+
|
|
1136
|
+
*/
|
|
1137
|
+
|
|
1138
|
+
refundable_credits_handling?:RefundableCreditsHandling;
|
|
1139
|
+
|
|
1140
|
+
/**
|
|
1141
|
+
* @description Cancels the current contract term.
|
|
1142
|
+
|
|
1143
|
+
* `terminate_immediately` immediately does the following:
|
|
1144
|
+
* sets the contract term [`status`](contract_terms#contract_term_status) to `terminated`.
|
|
1145
|
+
* Cancels the subscription.
|
|
1146
|
+
* Collects any [termination fee](contract_terms#termintation_fee).
|
|
1147
|
+
* `end_of_contract_term` Sets the [`contract_term[action_at_term_end]`](contract_terms#contract_term_action_at_term_end) to `cancel`. In other words, the contract term is not renewed and the subscription is canceled at the end of the contract term.
|
|
1148
|
+
. \* terminate_immediately - Terminate immediately \* end_of_contract_term - End of contract term
|
|
1149
|
+
|
|
1150
|
+
*/
|
|
1151
|
+
|
|
1152
|
+
contract_term_cancel_option?:ContractTermCancelOption;
|
|
1153
|
+
|
|
1154
|
+
/**
|
|
1155
|
+
* @description 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 `true`, and if the site is configured to set invoice dates to 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:
|
|
1156
|
+
|
|
1157
|
+
* `invoice_date` must be in the past.
|
|
1158
|
+
* `invoice_date` is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
|
|
1159
|
+
* It is not earlier than `cancel_at`.
|
|
1160
|
+
.
|
|
1161
|
+
|
|
1162
|
+
*/
|
|
1163
|
+
|
|
1164
|
+
invoice_date?:number;
|
|
1165
|
+
|
|
1166
|
+
/**
|
|
1167
|
+
* @description 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.
|
|
1168
|
+
|
|
1169
|
+
*/
|
|
1170
|
+
|
|
1171
|
+
cancel_reason_code?:string;
|
|
1172
|
+
|
|
1173
|
+
/**
|
|
1174
|
+
* @description Parameters for event_based_addons
|
|
1175
|
+
|
|
1176
|
+
*/
|
|
1177
|
+
|
|
1178
|
+
event_based_addons?:{id?:string,quantity?:number,service_period_in_days?:number,unit_price?:number}[];
|
|
1179
|
+
}
|
|
877
1180
|
export interface CancelSubscriptionForItemsResponse {
|
|
878
1181
|
estimate:Estimate;
|
|
879
1182
|
}
|
|
@@ -1075,7 +1378,7 @@ If `no_action` is chosen, charges are added to the resumption invoice.
|
|
|
1075
1378
|
|
|
1076
1379
|
*/
|
|
1077
1380
|
|
|
1078
|
-
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,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',reference_id?:string};
|
|
1381
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
|
|
1079
1382
|
|
|
1080
1383
|
/**
|
|
1081
1384
|
* @description Parameters for shipping_address
|
|
@@ -592,7 +592,7 @@ Payment owner of an invoice.
|
|
|
592
592
|
|
|
593
593
|
*/
|
|
594
594
|
|
|
595
|
-
transaction?:{amount?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_capturable?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},gateway?:{in?:string,is?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',not_in?:string},gateway_account_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id_at_gateway?:{is?:string,is_not?:string,starts_with?:string},payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',not_in?:string},payment_source_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},reference_number?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},status?:{in?:string,is?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',is_not?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},type?:{in?:string,is?:'authorization' | 'payment_reversal' | 'payment' | 'refund',is_not?:'authorization' | 'payment_reversal' | 'payment' | 'refund',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
595
|
+
transaction?:{amount?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_capturable?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},gateway?:{in?:string,is?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',not_in?:string},gateway_account_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id_at_gateway?:{is?:string,is_not?:string,starts_with?:string},payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'klarna_pay_now' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',not_in?:string},payment_source_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},reference_number?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},status?:{in?:string,is?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',is_not?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},type?:{in?:string,is?:'authorization' | 'payment_reversal' | 'payment' | 'refund',is_not?:'authorization' | 'payment_reversal' | 'payment' | 'refund',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
596
596
|
}
|
|
597
597
|
export interface OrdersResponse {
|
|
598
598
|
export:Export;
|