chargebee 2.36.0 → 2.37.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 +25 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +61 -1
- package/package.json +1 -1
- package/types/core.d.ts +53 -50
- package/types/index.d.ts +5 -0
- package/types/resources/CreditNote.d.ts +7 -0
- package/types/resources/CreditNoteEstimate.d.ts +11 -15
- package/types/resources/Currency.d.ts +78 -0
- package/types/resources/Customer.d.ts +30 -30
- package/types/resources/Estimate.d.ts +47 -43
- package/types/resources/Invoice.d.ts +6 -0
- package/types/resources/PaymentIntent.d.ts +4 -4
- package/types/resources/Purchase.d.ts +1 -0
- package/types/resources/Quote.d.ts +38 -38
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,28 @@
|
|
|
1
|
+
### v2.37.0 (2024-07-03)
|
|
2
|
+
* * *
|
|
3
|
+
|
|
4
|
+
#### New resources:
|
|
5
|
+
* Currency has been added.
|
|
6
|
+
* PricingPageSession Transfer has been added.
|
|
7
|
+
|
|
8
|
+
#### New Enum
|
|
9
|
+
* cancel_option Enum has been added.
|
|
10
|
+
|
|
11
|
+
#### New Enum values:
|
|
12
|
+
* ONLINE_BANKING_POLAND has been added in PaymentMethod enum.
|
|
13
|
+
* ONLINE_BANKING_POLAND has been added in PaymentMethodType enum.
|
|
14
|
+
* ONLINE_BANKING_POLAND has been added in Type enum.
|
|
15
|
+
* DRAFT has been added in Ramp enum.
|
|
16
|
+
|
|
17
|
+
#### New Input parameters:
|
|
18
|
+
* cancel_option has been added to Estimate#CancelSubscriptionRequest, Estimate#CancelSubscriptionForItemsRequest.
|
|
19
|
+
* cancel_option has been added to Subscription#CancelForItemsRequest, Subscription#CancelRequest.
|
|
20
|
+
* statement_descriptor[descriptor] has been added to Purchase#ChargeRequest.
|
|
21
|
+
|
|
22
|
+
#### New Attributes:
|
|
23
|
+
* tax_origin has been added to Invoice.
|
|
24
|
+
* tax_origin has been added to CreditNote.
|
|
25
|
+
|
|
1
26
|
### v2.36.0 (2024-05-28)
|
|
2
27
|
* * *
|
|
3
28
|
|
package/lib/chargebee.js
CHANGED
|
@@ -2777,6 +2777,50 @@ var _endpoints = {
|
|
|
2777
2777
|
true
|
|
2778
2778
|
]
|
|
2779
2779
|
],
|
|
2780
|
+
"currency": [
|
|
2781
|
+
[
|
|
2782
|
+
"list",
|
|
2783
|
+
"GET",
|
|
2784
|
+
"/currencies",
|
|
2785
|
+
"/list",
|
|
2786
|
+
false
|
|
2787
|
+
],
|
|
2788
|
+
[
|
|
2789
|
+
"retrieve",
|
|
2790
|
+
"GET",
|
|
2791
|
+
"/currencies",
|
|
2792
|
+
null,
|
|
2793
|
+
true
|
|
2794
|
+
],
|
|
2795
|
+
[
|
|
2796
|
+
"create",
|
|
2797
|
+
"POST",
|
|
2798
|
+
"/currencies",
|
|
2799
|
+
null,
|
|
2800
|
+
false
|
|
2801
|
+
],
|
|
2802
|
+
[
|
|
2803
|
+
"update",
|
|
2804
|
+
"POST",
|
|
2805
|
+
"/currencies",
|
|
2806
|
+
null,
|
|
2807
|
+
true
|
|
2808
|
+
],
|
|
2809
|
+
[
|
|
2810
|
+
"add_schedule",
|
|
2811
|
+
"POST",
|
|
2812
|
+
"/currencies",
|
|
2813
|
+
"/add_schedule",
|
|
2814
|
+
true
|
|
2815
|
+
],
|
|
2816
|
+
[
|
|
2817
|
+
"remove_schedule",
|
|
2818
|
+
"POST",
|
|
2819
|
+
"/currencies",
|
|
2820
|
+
"/remove_schedule",
|
|
2821
|
+
true
|
|
2822
|
+
]
|
|
2823
|
+
],
|
|
2780
2824
|
"ramp": [
|
|
2781
2825
|
[
|
|
2782
2826
|
"create_for_subscription",
|
|
@@ -2846,6 +2890,22 @@ var _endpoints = {
|
|
|
2846
2890
|
false
|
|
2847
2891
|
]
|
|
2848
2892
|
],
|
|
2849
|
-
"installment_detail": []
|
|
2893
|
+
"installment_detail": [],
|
|
2894
|
+
"pricing_page_session": [
|
|
2895
|
+
[
|
|
2896
|
+
"create_for_new_subscription",
|
|
2897
|
+
"POST",
|
|
2898
|
+
"/pricing_page_sessions",
|
|
2899
|
+
"/create_for_new_subscription",
|
|
2900
|
+
false
|
|
2901
|
+
],
|
|
2902
|
+
[
|
|
2903
|
+
"create_for_existing_subscription",
|
|
2904
|
+
"POST",
|
|
2905
|
+
"/pricing_page_sessions",
|
|
2906
|
+
"/create_for_existing_subscription",
|
|
2907
|
+
false
|
|
2908
|
+
]
|
|
2909
|
+
]
|
|
2850
2910
|
};
|
|
2851
2911
|
module.exports = _endpoints;
|
package/package.json
CHANGED
package/types/core.d.ts
CHANGED
|
@@ -12,78 +12,81 @@ declare module 'chargebee' {
|
|
|
12
12
|
headers(headers : {[key : string] : string}): this;
|
|
13
13
|
}
|
|
14
14
|
type AccountHolderType = 'individual' | 'company'
|
|
15
|
-
type AccountReceivablesHandling = '
|
|
16
|
-
type AccountType = 'checking' | '
|
|
15
|
+
type AccountReceivablesHandling = 'no_action' | 'schedule_payment_collection' | 'write_off'
|
|
16
|
+
type AccountType = 'checking' | 'savings' | 'business_checking' | 'current'
|
|
17
17
|
type Action = 'upsert' | 'remove'
|
|
18
18
|
type ApiVersion = 'v1' | 'v2'
|
|
19
|
-
type ApplyOn = '
|
|
20
|
-
type AutoCollection = '
|
|
21
|
-
type AvalaraSaleType = '
|
|
19
|
+
type ApplyOn = 'invoice_amount' | 'specific_item_price'
|
|
20
|
+
type AutoCollection = 'on' | 'off'
|
|
21
|
+
type AvalaraSaleType = 'wholesale' | 'retail' | 'consumed' | 'vendor_use'
|
|
22
22
|
type BillingAlignmentMode = 'immediate' | 'delayed'
|
|
23
|
-
type BillingDateMode = '
|
|
24
|
-
type BillingDayOfWeekMode = '
|
|
25
|
-
type
|
|
26
|
-
type
|
|
23
|
+
type BillingDateMode = 'using_defaults' | 'manually_set'
|
|
24
|
+
type BillingDayOfWeekMode = 'using_defaults' | 'manually_set'
|
|
25
|
+
type CancelOption = 'immediately' | 'end_of_term' | 'specific_date' | 'end_of_billing_term'
|
|
26
|
+
type ChangeOption = 'immediately' | 'end_of_term' | 'specific_date'
|
|
27
|
+
type Channel = 'web' | 'app_store' | 'play_store'
|
|
27
28
|
type ChargeModel = 'full_charge' | 'prorate'
|
|
28
|
-
type ChargeOnEvent = 'subscription_creation' | '
|
|
29
|
-
type ChargeOnOption = '
|
|
30
|
-
type ChargesHandling = '
|
|
31
|
-
type ContractTermCancelOption = '
|
|
29
|
+
type ChargeOnEvent = 'subscription_creation' | 'subscription_trial_start' | 'plan_activation' | 'subscription_activation' | 'contract_termination' | 'on_demand'
|
|
30
|
+
type ChargeOnOption = 'immediately' | 'on_event'
|
|
31
|
+
type ChargesHandling = 'invoice_immediately' | 'add_to_unbilled_charges'
|
|
32
|
+
type ContractTermCancelOption = 'terminate_immediately' | 'end_of_contract_term'
|
|
32
33
|
type CreditOptionForCurrentTermCharges = 'none' | 'prorate' | 'full'
|
|
33
|
-
type CreditType = '
|
|
34
|
-
type CustomerType = '
|
|
35
|
-
type DedupeOption = '
|
|
34
|
+
type CreditType = 'loyalty_credits' | 'referral_rewards' | 'general'
|
|
35
|
+
type CustomerType = 'residential' | 'business' | 'senior_citizen' | 'industrial'
|
|
36
|
+
type DedupeOption = 'skip' | 'update_existing'
|
|
37
|
+
type DirectDebitScheme = 'ach' | 'bacs' | 'sepa_core' | 'autogiro' | 'becs' | 'becs_nz' | 'pad' | 'not_applicable'
|
|
36
38
|
type DispositionType = 'attachment' | 'inline'
|
|
37
|
-
type DunningType = '
|
|
38
|
-
type DurationType = '
|
|
39
|
+
type DunningType = 'auto_collect' | 'offline' | 'direct_debit'
|
|
40
|
+
type DurationType = 'one_time' | 'forever' | 'limited_period'
|
|
39
41
|
type EcheckType = 'web' | 'ppd' | 'ccd'
|
|
40
42
|
type EinvoicingMethod = 'automatic' | 'manual' | 'site_default'
|
|
41
43
|
type EndScheduleOn = 'after_number_of_intervals' | 'specific_date' | 'subscription_end'
|
|
42
|
-
type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | '
|
|
43
|
-
type EntityType = '
|
|
44
|
+
type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
|
|
45
|
+
type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant'
|
|
44
46
|
type EventName = 'cancellation_page_loaded'
|
|
45
|
-
type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'invoice_installments_created' | 'invoice_installment_updated' | 'installment_config_created' | 'installment_config_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'ramp_created' | 'ramp_deleted' | 'ramp_applied' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted'
|
|
47
|
+
type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'invoice_installments_created' | 'invoice_installment_updated' | 'installment_config_created' | 'installment_config_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'ramp_created' | 'ramp_deleted' | 'ramp_applied' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
|
|
46
48
|
type ExportType = 'data' | 'import_friendly_data'
|
|
47
|
-
type FreePeriodUnit = '
|
|
48
|
-
type FriendOfferType = '
|
|
49
|
-
type Gateway = '
|
|
49
|
+
type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
|
|
50
|
+
type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
|
|
51
|
+
type Gateway = 'chargebee' | 'chargebee_payments' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'adyen' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'gocardless' | 'not_applicable'
|
|
50
52
|
type HierarchyOperationType = 'complete_hierarchy' | 'subordinates' | 'path_to_root'
|
|
51
|
-
type InvoiceDunningHandling = '
|
|
52
|
-
type ItemType = '
|
|
53
|
+
type InvoiceDunningHandling = 'continue' | 'stop'
|
|
54
|
+
type ItemType = 'plan' | 'addon' | 'charge'
|
|
53
55
|
type Layout = 'in_app' | 'full_page'
|
|
54
|
-
type NotifyReferralSystem = '
|
|
55
|
-
type OfflinePaymentMethod = '
|
|
56
|
-
type OnEvent = 'subscription_creation' | '
|
|
56
|
+
type NotifyReferralSystem = 'none' | 'first_paid_conversion' | 'all_invoices'
|
|
57
|
+
type OfflinePaymentMethod = 'no_preference' | 'cash' | 'check' | 'bank_transfer' | 'ach_credit' | 'sepa_credit' | 'boleto' | 'us_automated_bank_transfer' | 'eu_automated_bank_transfer' | 'uk_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'custom'
|
|
58
|
+
type OnEvent = 'subscription_creation' | 'subscription_trial_start' | 'plan_activation' | 'subscription_activation' | 'contract_termination'
|
|
57
59
|
type Operation = 'create' | 'update' | 'delete'
|
|
58
60
|
type OperationType = 'add' | 'remove'
|
|
59
|
-
type PauseOption = '
|
|
60
|
-
type PaymentInitiator = '
|
|
61
|
-
type PaymentMethod = '
|
|
62
|
-
type PaymentMethodType = '
|
|
61
|
+
type PauseOption = 'immediately' | 'end_of_term' | 'specific_date' | 'billing_cycles'
|
|
62
|
+
type PaymentInitiator = 'customer' | 'merchant'
|
|
63
|
+
type PaymentMethod = 'cash' | 'check' | 'bank_transfer' | 'other' | 'custom' | 'chargeback' | 'card' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
|
|
64
|
+
type PaymentMethodType = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
|
|
63
65
|
type PaymentVoucherType = 'boleto'
|
|
64
|
-
type PeriodUnit = '
|
|
66
|
+
type PeriodUnit = 'day' | 'week' | 'month' | 'year'
|
|
65
67
|
type PriceType = 'tax_exclusive' | 'tax_inclusive'
|
|
66
|
-
type PricingModel = '
|
|
67
|
-
type ProrationType = '
|
|
68
|
-
type ReferralSystem = 'referral_candy' | '
|
|
69
|
-
type ReferrerRewardType = '
|
|
70
|
-
type RefundableCreditsHandling = '
|
|
71
|
-
type ReportBy = '
|
|
68
|
+
type PricingModel = 'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep'
|
|
69
|
+
type ProrationType = 'full_term' | 'partial_term' | 'none'
|
|
70
|
+
type ReferralSystem = 'referral_candy' | 'referral_saasquatch' | 'friendbuy'
|
|
71
|
+
type ReferrerRewardType = 'none' | 'referral_direct_reward' | 'custom_promotional_credit' | 'custom_revenue_percent_based'
|
|
72
|
+
type RefundableCreditsHandling = 'no_action' | 'schedule_refund'
|
|
73
|
+
type ReportBy = 'customer' | 'invoice' | 'product' | 'subscription'
|
|
72
74
|
type ResumeOption = 'immediately' | 'specific_date'
|
|
73
|
-
type Role = '
|
|
75
|
+
type Role = 'primary' | 'backup' | 'none'
|
|
74
76
|
type ScheduleType = 'immediate' | 'specific_dates' | 'fixed_intervals'
|
|
75
|
-
type Source = 'admin_console' | '
|
|
76
|
-
type TaxExemptReason = '
|
|
77
|
-
type TaxJurisType = '
|
|
77
|
+
type Source = 'admin_console' | 'api' | 'bulk_operation' | 'scheduled_job' | 'hosted_page' | 'portal' | 'system' | 'none' | 'js_api' | 'migration' | 'external_service'
|
|
78
|
+
type TaxExemptReason = 'tax_not_configured' | 'region_non_taxable' | 'export' | 'customer_exempt' | 'product_exempt' | 'zero_rated' | 'reverse_charge' | 'high_value_physical_goods' | 'zero_value_item' | 'tax_not_configured_external_provider'
|
|
79
|
+
type TaxJurisType = 'country' | 'federal' | 'state' | 'county' | 'city' | 'special' | 'unincorporated' | 'other'
|
|
78
80
|
type TaxOverrideReason = 'id_exempt' | 'customer_exempt' | 'export'
|
|
79
81
|
type Taxability = 'taxable' | 'exempt'
|
|
80
|
-
type TaxjarExemptionCategory = '
|
|
81
|
-
type TrialEndAction = '
|
|
82
|
-
type Type = '
|
|
83
|
-
type UnbilledChargesHandling = '
|
|
82
|
+
type TaxjarExemptionCategory = 'wholesale' | 'government' | 'other'
|
|
83
|
+
type TrialEndAction = 'site_default' | 'plan_default' | 'activate_subscription' | 'cancel_subscription'
|
|
84
|
+
type Type = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
|
|
85
|
+
type UnbilledChargesHandling = 'no_action' | 'invoice'
|
|
84
86
|
type UnbilledChargesOption = 'invoice' | 'delete'
|
|
85
|
-
type UnpaidInvoicesHandling = '
|
|
86
|
-
type ValidationStatus = '
|
|
87
|
+
type UnpaidInvoicesHandling = 'no_action' | 'schedule_payment_collection'
|
|
88
|
+
type ValidationStatus = 'not_validated' | 'valid' | 'partially_valid' | 'invalid'
|
|
87
89
|
type VoucherType = 'boleto'
|
|
90
|
+
type ChargeOn = 'immediately' | 'on_event'
|
|
88
91
|
|
|
89
92
|
}
|
package/types/index.d.ts
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
///<reference path='./resources/CouponSet.d.ts' />
|
|
14
14
|
///<reference path='./resources/CreditNote.d.ts' />
|
|
15
15
|
///<reference path='./resources/CreditNoteEstimate.d.ts' />
|
|
16
|
+
///<reference path='./resources/Currency.d.ts' />
|
|
16
17
|
///<reference path='./resources/Customer.d.ts' />
|
|
17
18
|
///<reference path='./resources/DifferentialPrice.d.ts' />
|
|
18
19
|
///<reference path='./resources/Discount.d.ts' />
|
|
@@ -49,6 +50,7 @@
|
|
|
49
50
|
///<reference path='./resources/PaymentVoucher.d.ts' />
|
|
50
51
|
///<reference path='./resources/PortalSession.d.ts' />
|
|
51
52
|
///<reference path='./resources/PriceVariant.d.ts' />
|
|
53
|
+
///<reference path='./resources/PricingPageSession.d.ts' />
|
|
52
54
|
///<reference path='./resources/PromotionalCredit.d.ts' />
|
|
53
55
|
///<reference path='./resources/Purchase.d.ts' />
|
|
54
56
|
///<reference path='./resources/Quote.d.ts' />
|
|
@@ -83,6 +85,7 @@ declare module 'chargebee' {
|
|
|
83
85
|
static coupon_code: CouponCode.CouponCodeResource;
|
|
84
86
|
static coupon_set: CouponSet.CouponSetResource;
|
|
85
87
|
static credit_note: CreditNote.CreditNoteResource;
|
|
88
|
+
static currency: Currency.CurrencyResource;
|
|
86
89
|
static customer: Customer.CustomerResource;
|
|
87
90
|
static differential_price: DifferentialPrice.DifferentialPriceResource;
|
|
88
91
|
static entitlement: Entitlement.EntitlementResource;
|
|
@@ -108,6 +111,7 @@ declare module 'chargebee' {
|
|
|
108
111
|
static payment_voucher: PaymentVoucher.PaymentVoucherResource;
|
|
109
112
|
static portal_session: PortalSession.PortalSessionResource;
|
|
110
113
|
static price_variant: PriceVariant.PriceVariantResource;
|
|
114
|
+
static pricing_page_session: PricingPageSession.PricingPageSessionResource;
|
|
111
115
|
static promotional_credit: PromotionalCredit.PromotionalCreditResource;
|
|
112
116
|
static purchase: Purchase.PurchaseResource;
|
|
113
117
|
static quote: Quote.QuoteResource;
|
|
@@ -116,6 +120,7 @@ declare module 'chargebee' {
|
|
|
116
120
|
static site_migration_detail: SiteMigrationDetail.SiteMigrationDetailResource;
|
|
117
121
|
static subscription: Subscription.SubscriptionResource;
|
|
118
122
|
static subscription_entitlement: SubscriptionEntitlement.SubscriptionEntitlementResource;
|
|
123
|
+
static tax_withheld: TaxWithheld.TaxWithheldResource;
|
|
119
124
|
static time_machine: TimeMachine.TimeMachineResource;
|
|
120
125
|
static token: Token.TokenResource;
|
|
121
126
|
static transaction: Transaction.TransactionResource;
|
|
@@ -327,6 +327,8 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
327
327
|
billing_address?:CreditNote.BillingAddress;
|
|
328
328
|
|
|
329
329
|
site_details_at_creation?:CreditNote.SiteDetailsAtCreation;
|
|
330
|
+
|
|
331
|
+
tax_origin?:CreditNote.TaxOrigin;
|
|
330
332
|
}
|
|
331
333
|
export namespace CreditNote {
|
|
332
334
|
export class CreditNoteResource {
|
|
@@ -1785,5 +1787,10 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
|
|
|
1785
1787
|
|
|
1786
1788
|
organization_address?:object;
|
|
1787
1789
|
}
|
|
1790
|
+
export interface TaxOrigin {
|
|
1791
|
+
country?:string;
|
|
1792
|
+
|
|
1793
|
+
registration_number?:string;
|
|
1794
|
+
}
|
|
1788
1795
|
}
|
|
1789
1796
|
}
|
|
@@ -18,10 +18,6 @@ declare module 'chargebee' {
|
|
|
18
18
|
|
|
19
19
|
amount_available:number;
|
|
20
20
|
|
|
21
|
-
round_off_amount?:number;
|
|
22
|
-
|
|
23
|
-
customer_id?:string;
|
|
24
|
-
|
|
25
21
|
line_items?:CreditNoteEstimate.LineItem[];
|
|
26
22
|
|
|
27
23
|
discounts?:CreditNoteEstimate.Discount[];
|
|
@@ -33,6 +29,10 @@ declare module 'chargebee' {
|
|
|
33
29
|
line_item_discounts?:CreditNoteEstimate.LineItemDiscount[];
|
|
34
30
|
|
|
35
31
|
line_item_tiers?:CreditNoteEstimate.LineItemTier[];
|
|
32
|
+
|
|
33
|
+
round_off_amount?:number;
|
|
34
|
+
|
|
35
|
+
customer_id?:string;
|
|
36
36
|
}
|
|
37
37
|
export namespace CreditNoteEstimate {
|
|
38
38
|
|
|
@@ -52,7 +52,7 @@ declare module 'chargebee' {
|
|
|
52
52
|
|
|
53
53
|
amount?:number;
|
|
54
54
|
|
|
55
|
-
pricing_model?:'
|
|
55
|
+
pricing_model?:'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep';
|
|
56
56
|
|
|
57
57
|
is_taxed:boolean;
|
|
58
58
|
|
|
@@ -69,7 +69,7 @@ declare module 'chargebee' {
|
|
|
69
69
|
discount_amount?:number;
|
|
70
70
|
|
|
71
71
|
item_level_discount_amount?:number;
|
|
72
|
-
|
|
72
|
+
|
|
73
73
|
usage_percentage?:string;
|
|
74
74
|
|
|
75
75
|
reference_line_item_id?:string;
|
|
@@ -78,9 +78,9 @@ declare module 'chargebee' {
|
|
|
78
78
|
|
|
79
79
|
entity_description?:string;
|
|
80
80
|
|
|
81
|
-
entity_type:'
|
|
81
|
+
entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon';
|
|
82
82
|
|
|
83
|
-
tax_exempt_reason?:'
|
|
83
|
+
tax_exempt_reason?:'tax_not_configured' | 'region_non_taxable' | 'export' | 'customer_exempt' | 'product_exempt' | 'zero_rated' | 'reverse_charge' | 'high_value_physical_goods' | 'zero_value_item' | 'tax_not_configured_external_provider';
|
|
84
84
|
|
|
85
85
|
entity_id?:string;
|
|
86
86
|
|
|
@@ -91,11 +91,7 @@ declare module 'chargebee' {
|
|
|
91
91
|
|
|
92
92
|
description?:string;
|
|
93
93
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
entity_type:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
|
|
97
|
-
|
|
98
|
-
discount_type?:'fixed_amount' | 'percentage';
|
|
94
|
+
entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
99
95
|
|
|
100
96
|
entity_id?:string;
|
|
101
97
|
|
|
@@ -129,7 +125,7 @@ declare module 'chargebee' {
|
|
|
129
125
|
|
|
130
126
|
tax_amount:number;
|
|
131
127
|
|
|
132
|
-
tax_juris_type?:'
|
|
128
|
+
tax_juris_type?:'country' | 'federal' | 'state' | 'county' | 'city' | 'special' | 'unincorporated' | 'other';
|
|
133
129
|
|
|
134
130
|
tax_juris_name?:string;
|
|
135
131
|
|
|
@@ -142,7 +138,7 @@ declare module 'chargebee' {
|
|
|
142
138
|
export interface LineItemDiscount {
|
|
143
139
|
line_item_id:string;
|
|
144
140
|
|
|
145
|
-
discount_type:'item_level_coupon' | '
|
|
141
|
+
discount_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
146
142
|
|
|
147
143
|
coupon_id?:string;
|
|
148
144
|
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
declare module 'chargebee' {
|
|
3
|
+
export interface Currency {
|
|
4
|
+
|
|
5
|
+
id?:string;
|
|
6
|
+
|
|
7
|
+
enabled:boolean;
|
|
8
|
+
|
|
9
|
+
forex_type?:'manual' | 'auto';
|
|
10
|
+
|
|
11
|
+
currency_code?:string;
|
|
12
|
+
|
|
13
|
+
is_base_currency?:boolean;
|
|
14
|
+
|
|
15
|
+
manual_exchange_rate?:string;
|
|
16
|
+
}
|
|
17
|
+
export namespace Currency {
|
|
18
|
+
export class CurrencyResource {
|
|
19
|
+
list():ChargebeeRequest<ListResponse>;
|
|
20
|
+
|
|
21
|
+
retrieve(site_currency_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
22
|
+
|
|
23
|
+
create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
|
|
24
|
+
|
|
25
|
+
update(site_currency_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
|
|
26
|
+
|
|
27
|
+
add_schedule(site_currency_id:string, input:AddScheduleInputParam):ChargebeeRequest<AddScheduleResponse>;
|
|
28
|
+
|
|
29
|
+
remove_schedule(site_currency_id:string):ChargebeeRequest<RemoveScheduleResponse>;
|
|
30
|
+
}
|
|
31
|
+
export interface ListResponse {
|
|
32
|
+
currency:Currency;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export interface RetrieveResponse {
|
|
36
|
+
currency:Currency;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface CreateResponse {
|
|
40
|
+
currency:Currency;
|
|
41
|
+
}
|
|
42
|
+
export interface CreateInputParam {
|
|
43
|
+
|
|
44
|
+
currency_code:string;
|
|
45
|
+
|
|
46
|
+
forex_type:'manual' | 'auto';
|
|
47
|
+
|
|
48
|
+
manual_exchange_rate?:string;
|
|
49
|
+
}
|
|
50
|
+
export interface UpdateResponse {
|
|
51
|
+
currency:Currency;
|
|
52
|
+
}
|
|
53
|
+
export interface UpdateInputParam {
|
|
54
|
+
|
|
55
|
+
forex_type:'manual' | 'auto';
|
|
56
|
+
|
|
57
|
+
manual_exchange_rate?:string;
|
|
58
|
+
}
|
|
59
|
+
export interface AddScheduleResponse {
|
|
60
|
+
scheduled_at:number;
|
|
61
|
+
|
|
62
|
+
currency:Currency;
|
|
63
|
+
}
|
|
64
|
+
export interface AddScheduleInputParam {
|
|
65
|
+
|
|
66
|
+
manual_exchange_rate:string;
|
|
67
|
+
|
|
68
|
+
schedule_at:number;
|
|
69
|
+
}
|
|
70
|
+
export interface RemoveScheduleResponse {
|
|
71
|
+
scheduled_at:number;
|
|
72
|
+
|
|
73
|
+
currency:Currency;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
}
|
|
78
|
+
}
|
|
@@ -213,15 +213,15 @@ declare module 'chargebee' {
|
|
|
213
213
|
}
|
|
214
214
|
export interface CreateInputParam {
|
|
215
215
|
[key : string] : any;
|
|
216
|
-
card?:
|
|
216
|
+
card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,tmp_token?:string};
|
|
217
217
|
|
|
218
|
-
bank_account?:
|
|
218
|
+
bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
|
|
219
219
|
|
|
220
|
-
payment_method?:
|
|
220
|
+
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
221
221
|
|
|
222
|
-
payment_intent?:
|
|
222
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
223
223
|
|
|
224
|
-
billing_address?:
|
|
224
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
225
225
|
|
|
226
226
|
entity_identifiers?:{id?:string,scheme?:string,standard?:string,value?:string}[];
|
|
227
227
|
|
|
@@ -321,7 +321,7 @@ declare module 'chargebee' {
|
|
|
321
321
|
|
|
322
322
|
*/
|
|
323
323
|
|
|
324
|
-
relationship?:{invoice_owner_id?:
|
|
324
|
+
relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
|
|
325
325
|
|
|
326
326
|
/**
|
|
327
327
|
* @description Indicates whether to include deleted objects in the list. The deleted objects have the attribute \`deleted\` as \`true\`.
|
|
@@ -402,17 +402,6 @@ declare module 'chargebee' {
|
|
|
402
402
|
|
|
403
403
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
404
404
|
|
|
405
|
-
/**
|
|
406
|
-
* @description The unique ID of the [business entity](/docs/api?prod_cat_ver=2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver=2#subscription_customer_id) of the customer.
|
|
407
|
-
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
|
|
408
|
-
**Note**
|
|
409
|
-
|
|
410
|
-
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
411
|
-
|
|
412
|
-
*/
|
|
413
|
-
|
|
414
|
-
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
415
|
-
|
|
416
405
|
/**
|
|
417
406
|
* @description The preferred offline payment method for the customer.
|
|
418
407
|
|
|
@@ -434,6 +423,17 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
434
423
|
|
|
435
424
|
channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string};
|
|
436
425
|
|
|
426
|
+
/**
|
|
427
|
+
* @description The unique ID of the [business entity](/docs/api?prod_cat_ver=2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver=2#subscription_customer_id) of the customer.
|
|
428
|
+
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
|
|
429
|
+
**Note**
|
|
430
|
+
|
|
431
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
432
|
+
|
|
433
|
+
*/
|
|
434
|
+
|
|
435
|
+
business_entity_id?:{is?:string};
|
|
436
|
+
|
|
437
437
|
sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
|
|
438
438
|
}
|
|
439
439
|
export interface RetrieveResponse {
|
|
@@ -504,7 +504,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
504
504
|
}
|
|
505
505
|
export interface UpdatePaymentMethodInputParam {
|
|
506
506
|
|
|
507
|
-
payment_method:
|
|
507
|
+
payment_method:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type:Type};
|
|
508
508
|
}
|
|
509
509
|
export interface UpdateBillingInfoResponse {
|
|
510
510
|
customer:Customer;
|
|
@@ -513,7 +513,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
513
513
|
}
|
|
514
514
|
export interface UpdateBillingInfoInputParam {
|
|
515
515
|
|
|
516
|
-
billing_address?:
|
|
516
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
517
517
|
|
|
518
518
|
entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
|
|
519
519
|
|
|
@@ -574,7 +574,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
574
574
|
}
|
|
575
575
|
export interface AddContactInputParam {
|
|
576
576
|
|
|
577
|
-
contact:
|
|
577
|
+
contact:{email:string,enabled?:boolean,first_name?:string,id?:string,label?:string,last_name?:string,phone?:string,send_account_email?:boolean,send_billing_email?:boolean};
|
|
578
578
|
}
|
|
579
579
|
export interface UpdateContactResponse {
|
|
580
580
|
customer:Customer;
|
|
@@ -583,7 +583,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
583
583
|
}
|
|
584
584
|
export interface UpdateContactInputParam {
|
|
585
585
|
|
|
586
|
-
contact:
|
|
586
|
+
contact:{email?:string,enabled?:boolean,first_name?:string,id:string,label?:string,last_name?:string,phone?:string,send_account_email?:boolean,send_billing_email?:boolean};
|
|
587
587
|
}
|
|
588
588
|
export interface DeleteContactResponse {
|
|
589
589
|
customer:Customer;
|
|
@@ -592,7 +592,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
592
592
|
}
|
|
593
593
|
export interface DeleteContactInputParam {
|
|
594
594
|
|
|
595
|
-
contact:
|
|
595
|
+
contact:{id:string};
|
|
596
596
|
}
|
|
597
597
|
export interface AddPromotionalCreditsResponse {
|
|
598
598
|
customer:Customer;
|
|
@@ -646,7 +646,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
646
646
|
}
|
|
647
647
|
export interface RecordExcessPaymentInputParam {
|
|
648
648
|
|
|
649
|
-
transaction:
|
|
649
|
+
transaction:{amount:number,currency_code?:string,custom_payment_method_id?:string,date:number,payment_method:PaymentMethod,reference_number?:string};
|
|
650
650
|
|
|
651
651
|
comment?:string;
|
|
652
652
|
}
|
|
@@ -657,11 +657,11 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
657
657
|
}
|
|
658
658
|
export interface CollectPaymentInputParam {
|
|
659
659
|
|
|
660
|
-
payment_method?:
|
|
660
|
+
payment_method?:{additional_information?:object,gateway_account_id?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
661
661
|
|
|
662
|
-
card?:
|
|
662
|
+
card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
|
|
663
663
|
|
|
664
|
-
payment_intent?:
|
|
664
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
665
665
|
|
|
666
666
|
invoice_allocations:{allocation_amount?:number,invoice_id:string}[];
|
|
667
667
|
|
|
@@ -732,9 +732,9 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
732
732
|
}
|
|
733
733
|
export interface RelationshipsInputParam {
|
|
734
734
|
|
|
735
|
-
parent_account_access?:
|
|
735
|
+
parent_account_access?:{portal_download_child_invoices?:'yes' | 'view_only' | 'no',portal_edit_child_subscriptions?:'yes' | 'view_only' | 'no',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
736
736
|
|
|
737
|
-
child_account_access?:
|
|
737
|
+
child_account_access?:{portal_download_invoices?:'yes' | 'view_only' | 'no',portal_edit_subscriptions?:'yes' | 'view_only',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
738
738
|
|
|
739
739
|
parent_id?:string;
|
|
740
740
|
|
|
@@ -760,9 +760,9 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
760
760
|
}
|
|
761
761
|
export interface UpdateHierarchySettingsInputParam {
|
|
762
762
|
|
|
763
|
-
parent_account_access?:
|
|
763
|
+
parent_account_access?:{portal_download_child_invoices?:'yes' | 'view_only' | 'no',portal_edit_child_subscriptions?:'yes' | 'view_only' | 'no',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
764
764
|
|
|
765
|
-
child_account_access?:
|
|
765
|
+
child_account_access?:{portal_download_invoices?:'yes' | 'view_only' | 'no',portal_edit_subscriptions?:'yes' | 'view_only',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
766
766
|
|
|
767
767
|
use_default_hierarchy_settings?:boolean;
|
|
768
768
|
}
|
|
@@ -63,15 +63,15 @@ declare module 'chargebee' {
|
|
|
63
63
|
}
|
|
64
64
|
export interface CreateSubscriptionInputParam {
|
|
65
65
|
|
|
66
|
-
subscription:
|
|
66
|
+
subscription:{contract_term_billing_cycle_on_renewal?:number,coupon?:string,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};
|
|
67
67
|
|
|
68
|
-
billing_address?:
|
|
68
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
69
69
|
|
|
70
|
-
shipping_address?:
|
|
70
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
71
71
|
|
|
72
|
-
customer?:
|
|
72
|
+
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};
|
|
73
73
|
|
|
74
|
-
contract_term?:
|
|
74
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
75
75
|
|
|
76
76
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
77
77
|
|
|
@@ -100,15 +100,15 @@ declare module 'chargebee' {
|
|
|
100
100
|
}
|
|
101
101
|
export interface CreateSubItemEstimateInputParam {
|
|
102
102
|
|
|
103
|
-
subscription?:
|
|
103
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
104
104
|
|
|
105
|
-
billing_address?:
|
|
105
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
106
106
|
|
|
107
|
-
shipping_address?:
|
|
107
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
108
108
|
|
|
109
|
-
customer?:
|
|
109
|
+
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};
|
|
110
110
|
|
|
111
|
-
contract_term?:
|
|
111
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
|
|
112
112
|
|
|
113
113
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
114
114
|
|
|
@@ -139,11 +139,11 @@ declare module 'chargebee' {
|
|
|
139
139
|
}
|
|
140
140
|
export interface CreateSubForCustomerEstimateInputParam {
|
|
141
141
|
|
|
142
|
-
subscription?:
|
|
142
|
+
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};
|
|
143
143
|
|
|
144
|
-
shipping_address?:
|
|
144
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
145
145
|
|
|
146
|
-
contract_term?:
|
|
146
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
147
147
|
|
|
148
148
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
149
149
|
|
|
@@ -178,13 +178,13 @@ declare module 'chargebee' {
|
|
|
178
178
|
}
|
|
179
179
|
export interface CreateSubItemForCustomerEstimateInputParam {
|
|
180
180
|
|
|
181
|
-
subscription?:
|
|
181
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
182
182
|
|
|
183
|
-
shipping_address?:
|
|
183
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
184
184
|
|
|
185
|
-
billing_address?:
|
|
185
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
186
186
|
|
|
187
|
-
contract_term?:
|
|
187
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
|
|
188
188
|
|
|
189
189
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
190
190
|
|
|
@@ -213,13 +213,13 @@ declare module 'chargebee' {
|
|
|
213
213
|
}
|
|
214
214
|
export interface UpdateSubscriptionInputParam {
|
|
215
215
|
|
|
216
|
-
subscription:
|
|
216
|
+
subscription:{auto_collection?:AutoCollection,coupon?:string,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};
|
|
217
217
|
|
|
218
|
-
billing_address?:
|
|
218
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
219
219
|
|
|
220
|
-
shipping_address?:
|
|
220
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
221
221
|
|
|
222
|
-
customer?:
|
|
222
|
+
customer?:{registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
223
223
|
|
|
224
224
|
addons?:{billing_cycles?:number,id?:string,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
225
225
|
|
|
@@ -266,13 +266,13 @@ declare module 'chargebee' {
|
|
|
266
266
|
}
|
|
267
267
|
export interface UpdateSubscriptionForItemsInputParam {
|
|
268
268
|
|
|
269
|
-
subscription:
|
|
269
|
+
subscription:{auto_collection?:AutoCollection,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
270
270
|
|
|
271
|
-
billing_address?:
|
|
271
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
272
272
|
|
|
273
|
-
shipping_address?:
|
|
273
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
274
274
|
|
|
275
|
-
customer?:
|
|
275
|
+
customer?:{registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
276
276
|
|
|
277
277
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
278
278
|
|
|
@@ -334,7 +334,7 @@ declare module 'chargebee' {
|
|
|
334
334
|
}
|
|
335
335
|
export interface AdvanceInvoiceEstimateInputParam {
|
|
336
336
|
|
|
337
|
-
fixed_interval_schedule?:
|
|
337
|
+
fixed_interval_schedule?:{days_before_renewal?:number,end_date?:number,end_schedule_on?:EndScheduleOn,number_of_occurrences?:number};
|
|
338
338
|
|
|
339
339
|
specific_dates_schedule?:{date?:number,terms_to_charge?:number}[];
|
|
340
340
|
|
|
@@ -377,6 +377,8 @@ declare module 'chargebee' {
|
|
|
377
377
|
}
|
|
378
378
|
export interface CancelSubscriptionInputParam {
|
|
379
379
|
|
|
380
|
+
cancel_option?:CancelOption;
|
|
381
|
+
|
|
380
382
|
end_of_term?:boolean;
|
|
381
383
|
|
|
382
384
|
cancel_at?:number;
|
|
@@ -402,6 +404,8 @@ declare module 'chargebee' {
|
|
|
402
404
|
}
|
|
403
405
|
export interface CancelSubscriptionForItemsInputParam {
|
|
404
406
|
|
|
407
|
+
cancel_option?:CancelOption;
|
|
408
|
+
|
|
405
409
|
end_of_term?:boolean;
|
|
406
410
|
|
|
407
411
|
cancel_at?:number;
|
|
@@ -427,7 +431,7 @@ declare module 'chargebee' {
|
|
|
427
431
|
}
|
|
428
432
|
export interface PauseSubscriptionInputParam {
|
|
429
433
|
|
|
430
|
-
subscription?:
|
|
434
|
+
subscription?:{pause_date?:number,resume_date?:number,skip_billing_cycles?:number};
|
|
431
435
|
|
|
432
436
|
pause_option?:PauseOption;
|
|
433
437
|
|
|
@@ -438,7 +442,7 @@ declare module 'chargebee' {
|
|
|
438
442
|
}
|
|
439
443
|
export interface ResumeSubscriptionInputParam {
|
|
440
444
|
|
|
441
|
-
subscription?:
|
|
445
|
+
subscription?:{resume_date?:number};
|
|
442
446
|
|
|
443
447
|
resume_option?:ResumeOption;
|
|
444
448
|
|
|
@@ -449,17 +453,17 @@ declare module 'chargebee' {
|
|
|
449
453
|
}
|
|
450
454
|
export interface GiftSubscriptionInputParam {
|
|
451
455
|
|
|
452
|
-
gift?:
|
|
456
|
+
gift?:{auto_claim?:boolean,claim_expiry_date?:number,no_expiry?:boolean,scheduled_at?:number};
|
|
453
457
|
|
|
454
|
-
gifter:
|
|
458
|
+
gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
|
|
455
459
|
|
|
456
|
-
gift_receiver:
|
|
460
|
+
gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
|
|
457
461
|
|
|
458
|
-
payment_intent?:
|
|
462
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
459
463
|
|
|
460
|
-
shipping_address?:
|
|
464
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
461
465
|
|
|
462
|
-
subscription:
|
|
466
|
+
subscription:{plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string};
|
|
463
467
|
|
|
464
468
|
addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
|
|
465
469
|
|
|
@@ -470,15 +474,15 @@ declare module 'chargebee' {
|
|
|
470
474
|
}
|
|
471
475
|
export interface GiftSubscriptionForItemsInputParam {
|
|
472
476
|
|
|
473
|
-
gift?:
|
|
477
|
+
gift?:{auto_claim?:boolean,claim_expiry_date?:number,no_expiry?:boolean,scheduled_at?:number};
|
|
474
478
|
|
|
475
|
-
gifter:
|
|
479
|
+
gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
|
|
476
480
|
|
|
477
|
-
gift_receiver:
|
|
481
|
+
gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
|
|
478
482
|
|
|
479
|
-
payment_intent?:
|
|
483
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
480
484
|
|
|
481
|
-
shipping_address?:
|
|
485
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
482
486
|
|
|
483
487
|
subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string}[];
|
|
484
488
|
|
|
@@ -489,9 +493,9 @@ declare module 'chargebee' {
|
|
|
489
493
|
}
|
|
490
494
|
export interface CreateInvoiceInputParam {
|
|
491
495
|
|
|
492
|
-
invoice?:
|
|
496
|
+
invoice?:{customer_id?:string,po_number?:string,subscription_id?:string};
|
|
493
497
|
|
|
494
|
-
shipping_address?:
|
|
498
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
495
499
|
|
|
496
500
|
addons?:{date_from?:number,date_to?:number,id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
497
501
|
|
|
@@ -524,9 +528,9 @@ declare module 'chargebee' {
|
|
|
524
528
|
}
|
|
525
529
|
export interface CreateInvoiceForItemsInputParam {
|
|
526
530
|
|
|
527
|
-
invoice?:
|
|
531
|
+
invoice?:{customer_id?:string,po_number?:string,subscription_id?:string};
|
|
528
532
|
|
|
529
|
-
shipping_address?:
|
|
533
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
530
534
|
|
|
531
535
|
item_prices?:{date_from?:number,date_to?:number,item_price_id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
532
536
|
|
|
@@ -474,6 +474,7 @@ In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](m
|
|
|
474
474
|
|
|
475
475
|
linked_taxes_withheld?:Invoice.LinkedTaxWithheld[];
|
|
476
476
|
site_details_at_creation?:Invoice.SiteDetailsAtCreation;
|
|
477
|
+
tax_origin?:Invoice.TaxOrigin;
|
|
477
478
|
}
|
|
478
479
|
export namespace Invoice {
|
|
479
480
|
export class InvoiceResource {
|
|
@@ -3254,5 +3255,10 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
|
|
|
3254
3255
|
timezone?: string;
|
|
3255
3256
|
organization_address?: object;
|
|
3256
3257
|
}
|
|
3258
|
+
export interface TaxOrigin {
|
|
3259
|
+
country?:string;
|
|
3260
|
+
|
|
3261
|
+
registration_number?:string;
|
|
3262
|
+
}
|
|
3257
3263
|
}
|
|
3258
3264
|
}
|
|
@@ -56,7 +56,7 @@ declare module 'chargebee' {
|
|
|
56
56
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
59
|
-
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';
|
|
59
|
+
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' | 'online_banking_poland';
|
|
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`.
|
|
@@ -226,7 +226,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
226
226
|
|
|
227
227
|
*/
|
|
228
228
|
|
|
229
|
-
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';
|
|
229
|
+
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' | 'online_banking_poland';
|
|
230
230
|
|
|
231
231
|
/**
|
|
232
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`.
|
|
@@ -273,7 +273,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
273
273
|
|
|
274
274
|
*/
|
|
275
275
|
|
|
276
|
-
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';
|
|
276
|
+
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' | 'online_banking_poland';
|
|
277
277
|
|
|
278
278
|
/**
|
|
279
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`.
|
|
@@ -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' | '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';
|
|
316
|
+
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' | 'online_banking_poland';
|
|
317
317
|
|
|
318
318
|
/**
|
|
319
319
|
* @description Reference of PaymentIntent at gateway
|
|
@@ -250,6 +250,7 @@ Discounts, both [manual discounts](discounts) and <coupons>, can be applie
|
|
|
250
250
|
*/
|
|
251
251
|
|
|
252
252
|
contract_terms:{action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen',cancellation_cutoff_period?:number,index:number}[];
|
|
253
|
+
statement_descriptor?:{descriptor?:string};
|
|
253
254
|
}
|
|
254
255
|
export interface EstimateResponse {
|
|
255
256
|
estimate:Estimate;
|
|
@@ -135,11 +135,11 @@ declare module 'chargebee' {
|
|
|
135
135
|
}
|
|
136
136
|
export interface CreateSubForCustomerQuoteInputParam {
|
|
137
137
|
|
|
138
|
-
subscription:
|
|
138
|
+
subscription:{contract_term_billing_cycle_on_renewal?:number,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,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
139
139
|
|
|
140
|
-
shipping_address?:
|
|
140
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
141
141
|
|
|
142
|
-
contract_term?:
|
|
142
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
143
143
|
|
|
144
144
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
145
145
|
|
|
@@ -168,11 +168,11 @@ declare module 'chargebee' {
|
|
|
168
168
|
}
|
|
169
169
|
export interface EditCreateSubForCustomerQuoteInputParam {
|
|
170
170
|
|
|
171
|
-
subscription:
|
|
171
|
+
subscription:{contract_term_billing_cycle_on_renewal?:number,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,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
172
172
|
|
|
173
|
-
shipping_address?:
|
|
173
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
174
174
|
|
|
175
|
-
contract_term?:
|
|
175
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
176
176
|
|
|
177
177
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
178
178
|
|
|
@@ -199,15 +199,15 @@ declare module 'chargebee' {
|
|
|
199
199
|
}
|
|
200
200
|
export interface UpdateSubscriptionQuoteInputParam {
|
|
201
201
|
|
|
202
|
-
subscription:
|
|
202
|
+
subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,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};
|
|
203
203
|
|
|
204
|
-
billing_address?:
|
|
204
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
205
205
|
|
|
206
|
-
shipping_address?:
|
|
206
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
207
207
|
|
|
208
|
-
customer?:
|
|
208
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
209
209
|
|
|
210
|
-
contract_term?:
|
|
210
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
|
|
211
211
|
|
|
212
212
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
213
213
|
|
|
@@ -250,15 +250,15 @@ declare module 'chargebee' {
|
|
|
250
250
|
}
|
|
251
251
|
export interface EditUpdateSubscriptionQuoteInputParam {
|
|
252
252
|
|
|
253
|
-
subscription?:
|
|
253
|
+
subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?: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};
|
|
254
254
|
|
|
255
|
-
billing_address?:
|
|
255
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
256
256
|
|
|
257
|
-
shipping_address?:
|
|
257
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
258
258
|
|
|
259
|
-
customer?:
|
|
259
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
260
260
|
|
|
261
|
-
contract_term?:
|
|
261
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
|
|
262
262
|
|
|
263
263
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
264
264
|
|
|
@@ -299,7 +299,7 @@ declare module 'chargebee' {
|
|
|
299
299
|
}
|
|
300
300
|
export interface CreateForOnetimeChargesInputParam {
|
|
301
301
|
|
|
302
|
-
shipping_address?:
|
|
302
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
303
303
|
|
|
304
304
|
addons?:{id?:string,quantity?:number,quantity_in_decimal?:string,service_period?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
305
305
|
|
|
@@ -330,7 +330,7 @@ declare module 'chargebee' {
|
|
|
330
330
|
}
|
|
331
331
|
export interface EditOneTimeQuoteInputParam {
|
|
332
332
|
|
|
333
|
-
shipping_address?:
|
|
333
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
334
334
|
|
|
335
335
|
addons?:{id?:string,quantity?:number,quantity_in_decimal?:string,service_period?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
336
336
|
|
|
@@ -357,11 +357,11 @@ declare module 'chargebee' {
|
|
|
357
357
|
}
|
|
358
358
|
export interface CreateSubItemsForCustomerQuoteInputParam {
|
|
359
359
|
|
|
360
|
-
subscription?:
|
|
360
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
361
361
|
|
|
362
|
-
shipping_address?:
|
|
362
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
363
363
|
|
|
364
|
-
contract_term?:
|
|
364
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
365
365
|
|
|
366
366
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
367
367
|
|
|
@@ -392,11 +392,11 @@ declare module 'chargebee' {
|
|
|
392
392
|
}
|
|
393
393
|
export interface EditCreateSubCustomerQuoteForItemsInputParam {
|
|
394
394
|
|
|
395
|
-
subscription?:
|
|
395
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
396
396
|
|
|
397
|
-
shipping_address?:
|
|
397
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
398
398
|
|
|
399
|
-
contract_term?:
|
|
399
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
400
400
|
|
|
401
401
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
402
402
|
|
|
@@ -425,15 +425,15 @@ declare module 'chargebee' {
|
|
|
425
425
|
}
|
|
426
426
|
export interface UpdateSubscriptionQuoteForItemsInputParam {
|
|
427
427
|
|
|
428
|
-
subscription:
|
|
428
|
+
subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
429
429
|
|
|
430
|
-
billing_address?:
|
|
430
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
431
431
|
|
|
432
|
-
shipping_address?:
|
|
432
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
433
433
|
|
|
434
|
-
customer?:
|
|
434
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
435
435
|
|
|
436
|
-
contract_term?:
|
|
436
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
|
|
437
437
|
|
|
438
438
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
439
439
|
|
|
@@ -478,15 +478,15 @@ declare module 'chargebee' {
|
|
|
478
478
|
}
|
|
479
479
|
export interface EditUpdateSubscriptionQuoteForItemsInputParam {
|
|
480
480
|
|
|
481
|
-
subscription?:
|
|
481
|
+
subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
482
482
|
|
|
483
|
-
billing_address?:
|
|
483
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
484
484
|
|
|
485
|
-
shipping_address?:
|
|
485
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
486
486
|
|
|
487
|
-
customer?:
|
|
487
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
488
488
|
|
|
489
|
-
contract_term?:
|
|
489
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
|
|
490
490
|
|
|
491
491
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
492
492
|
|
|
@@ -529,7 +529,7 @@ declare module 'chargebee' {
|
|
|
529
529
|
}
|
|
530
530
|
export interface CreateForChargeItemsAndChargesInputParam {
|
|
531
531
|
|
|
532
|
-
shipping_address?:
|
|
532
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
533
533
|
|
|
534
534
|
item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
535
535
|
|
|
@@ -564,7 +564,7 @@ declare module 'chargebee' {
|
|
|
564
564
|
}
|
|
565
565
|
export interface EditForChargeItemsAndChargesInputParam {
|
|
566
566
|
|
|
567
|
-
shipping_address?:
|
|
567
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
568
568
|
|
|
569
569
|
item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
570
570
|
|
|
@@ -701,7 +701,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
701
701
|
}
|
|
702
702
|
export interface ConvertInputParam {
|
|
703
703
|
|
|
704
|
-
subscription?:
|
|
704
|
+
subscription?:{auto_close_invoices?:boolean,auto_collection?:AutoCollection,id?:string,po_number?:string};
|
|
705
705
|
|
|
706
706
|
invoice_date?:number;
|
|
707
707
|
|
|
@@ -794,7 +794,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
794
794
|
|
|
795
795
|
entity_description?:string;
|
|
796
796
|
|
|
797
|
-
entity_type:'
|
|
797
|
+
entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon';
|
|
798
798
|
|
|
799
799
|
tax_exempt_reason?:'tax_not_configured' | 'region_non_taxable' | 'export' | 'customer_exempt' | 'product_exempt' | 'zero_rated' | 'reverse_charge' | 'high_value_physical_goods' | 'zero_value_item' | 'tax_not_configured_external_provider';
|
|
800
800
|
|