chargebee 2.24.0 → 2.25.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 +4 -0
- package/lib/chargebee.js +1 -1
- package/package.json +2 -1
- package/types/core.d.ts +80 -0
- package/types/index.d.ts +92 -0
- package/types/resources/Address.d.ts +58 -0
- package/types/resources/AdvanceInvoiceSchedule.d.ts +26 -0
- package/types/resources/AttachedItem.d.ts +84 -0
- package/types/resources/Card.d.ts +88 -0
- package/types/resources/Comment.d.ts +52 -0
- package/types/resources/Contact.d.ts +15 -0
- package/types/resources/ContractTerm.d.ts +18 -0
- package/types/resources/Coupon.d.ts +150 -0
- package/types/resources/CouponCode.d.ts +25 -0
- package/types/resources/CouponSet.d.ts +75 -0
- package/types/resources/CreditNote.d.ts +337 -0
- package/types/resources/CreditNoteEstimate.d.ts +96 -0
- package/types/resources/Customer.d.ts +440 -0
- package/types/resources/DifferentialPrice.d.ts +88 -0
- package/types/resources/Discount.d.ts +23 -0
- package/types/resources/Download.d.ts +9 -0
- package/types/resources/EntitlementOverride.d.ts +37 -0
- package/types/resources/Estimate.d.ts +214 -0
- package/types/resources/Event.d.ts +42 -0
- package/types/resources/Export.d.ts +182 -0
- package/types/resources/Feature.d.ts +90 -0
- package/types/resources/Gift.d.ts +97 -0
- package/types/resources/Hierarchy.d.ts +11 -0
- package/types/resources/HostedPage.d.ts +242 -0
- package/types/resources/ImpactedItem.d.ts +17 -0
- package/types/resources/ImpactedSubscription.d.ts +17 -0
- package/types/resources/InAppSubscription.d.ts +52 -0
- package/types/resources/Invoice.d.ts +590 -0
- package/types/resources/InvoiceEstimate.d.ts +96 -0
- package/types/resources/Item.d.ts +118 -0
- package/types/resources/ItemEntitlement.d.ts +55 -0
- package/types/resources/ItemFamily.d.ts +59 -0
- package/types/resources/ItemPrice.d.ts +195 -0
- package/types/resources/Media.d.ts +10 -0
- package/types/resources/NonSubscription.d.ts +23 -0
- package/types/resources/Order.d.ts +305 -0
- package/types/resources/PaymentIntent.d.ts +71 -0
- package/types/resources/PaymentReferenceNumber.d.ts +10 -0
- package/types/resources/PaymentSource.d.ts +264 -0
- package/types/resources/PaymentVoucher.d.ts +74 -0
- package/types/resources/PortalSession.d.ts +57 -0
- package/types/resources/PromotionalCredit.d.ts +86 -0
- package/types/resources/Purchase.d.ts +46 -0
- package/types/resources/Quote.d.ts +388 -0
- package/types/resources/QuoteLineGroup.d.ts +83 -0
- package/types/resources/QuotedCharge.d.ts +57 -0
- package/types/resources/QuotedSubscription.d.ts +82 -0
- package/types/resources/ResourceMigration.d.ts +27 -0
- package/types/resources/SiteMigrationDetail.d.ts +31 -0
- package/types/resources/Subscription.d.ts +619 -0
- package/types/resources/SubscriptionEntitlement.d.ts +41 -0
- package/types/resources/SubscriptionEstimate.d.ts +49 -0
- package/types/resources/TaxWithheld.d.ts +13 -0
- package/types/resources/ThirdPartyPaymentMethod.d.ts +10 -0
- package/types/resources/TimeMachine.d.ts +38 -0
- package/types/resources/Token.d.ts +50 -0
- package/types/resources/Transaction.d.ts +170 -0
- package/types/resources/UnbilledCharge.d.ts +91 -0
- package/types/resources/Usage.d.ts +76 -0
- package/types/resources/VirtualBankAccount.d.ts +75 -0
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
declare module 'chargebee' {
|
|
2
|
+
export interface Estimate {
|
|
3
|
+
|
|
4
|
+
created_at:number;
|
|
5
|
+
subscription_estimate?:SubscriptionEstimate;
|
|
6
|
+
subscription_estimates?:SubscriptionEstimate[];
|
|
7
|
+
invoice_estimate?:InvoiceEstimate;
|
|
8
|
+
invoice_estimates?:InvoiceEstimate[];
|
|
9
|
+
next_invoice_estimate?:InvoiceEstimate;
|
|
10
|
+
credit_note_estimates?:CreditNoteEstimate[];
|
|
11
|
+
unbilled_charge_estimates?:UnbilledCharge[];
|
|
12
|
+
}
|
|
13
|
+
export namespace Estimate {
|
|
14
|
+
export class EstimateResource {
|
|
15
|
+
renewal_estimate(subscription_id:string, input?:RenewalEstimateInputParam):ChargebeeRequest<RenewalEstimateResponse>;
|
|
16
|
+
create_sub_item_estimate(input?:CreateSubItemEstimateInputParam):ChargebeeRequest<CreateSubItemEstimateResponse>;
|
|
17
|
+
cancel_subscription_for_items(subscription_id:string, input?:CancelSubscriptionForItemsInputParam):ChargebeeRequest<CancelSubscriptionForItemsResponse>;
|
|
18
|
+
resume_subscription(subscription_id:string, input?:ResumeSubscriptionInputParam):ChargebeeRequest<ResumeSubscriptionResponse>;
|
|
19
|
+
create_invoice_for_items(input?:CreateInvoiceForItemsInputParam):ChargebeeRequest<CreateInvoiceForItemsResponse>;
|
|
20
|
+
gift_subscription_for_items(input?:GiftSubscriptionForItemsInputParam):ChargebeeRequest<GiftSubscriptionForItemsResponse>;
|
|
21
|
+
update_subscription_for_items(input?:UpdateSubscriptionForItemsInputParam):ChargebeeRequest<UpdateSubscriptionForItemsResponse>;
|
|
22
|
+
upcoming_invoices_estimate(customer_id:string):ChargebeeRequest<UpcomingInvoicesEstimateResponse>;
|
|
23
|
+
regenerate_invoice_estimate(subscription_id:string, input?:RegenerateInvoiceEstimateInputParam):ChargebeeRequest<RegenerateInvoiceEstimateResponse>;
|
|
24
|
+
create_sub_item_for_customer_estimate(customer_id:string, input?:CreateSubItemForCustomerEstimateInputParam):ChargebeeRequest<CreateSubItemForCustomerEstimateResponse>;
|
|
25
|
+
change_term_end(subscription_id:string, input:ChangeTermEndInputParam):ChargebeeRequest<ChangeTermEndResponse>;
|
|
26
|
+
pause_subscription(subscription_id:string, input?:PauseSubscriptionInputParam):ChargebeeRequest<PauseSubscriptionResponse>;
|
|
27
|
+
advance_invoice_estimate(subscription_id:string, input?:AdvanceInvoiceEstimateInputParam):ChargebeeRequest<AdvanceInvoiceEstimateResponse>;
|
|
28
|
+
}
|
|
29
|
+
export interface RenewalEstimateResponse {
|
|
30
|
+
estimate:Estimate;
|
|
31
|
+
}
|
|
32
|
+
export interface RenewalEstimateInputParam {
|
|
33
|
+
|
|
34
|
+
include_delayed_charges?:boolean;
|
|
35
|
+
use_existing_balances?:boolean;
|
|
36
|
+
ignore_scheduled_cancellation?:boolean;
|
|
37
|
+
ignore_scheduled_changes?:boolean;
|
|
38
|
+
}
|
|
39
|
+
export interface CreateSubItemEstimateResponse {
|
|
40
|
+
estimate:Estimate;
|
|
41
|
+
}
|
|
42
|
+
export interface CreateSubItemEstimateInputParam {
|
|
43
|
+
|
|
44
|
+
billing_cycles?:number;
|
|
45
|
+
mandatory_items_to_remove?:string[];
|
|
46
|
+
terms_to_charge?:number;
|
|
47
|
+
billing_alignment_mode?:BillingAlignmentMode;
|
|
48
|
+
coupon_ids?:string[];
|
|
49
|
+
invoice_immediately?:boolean;
|
|
50
|
+
invoice_date?:number;
|
|
51
|
+
client_profile_id?:string;
|
|
52
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
53
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
54
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
55
|
+
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};
|
|
56
|
+
contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
|
|
57
|
+
subscription_items?:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
58
|
+
discounts?:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
59
|
+
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}[];
|
|
60
|
+
}
|
|
61
|
+
export interface CancelSubscriptionForItemsResponse {
|
|
62
|
+
estimate:Estimate;
|
|
63
|
+
}
|
|
64
|
+
export interface CancelSubscriptionForItemsInputParam {
|
|
65
|
+
|
|
66
|
+
end_of_term?:boolean;
|
|
67
|
+
cancel_at?:number;
|
|
68
|
+
credit_option_for_current_term_charges?:CreditOptionForCurrentTermCharges;
|
|
69
|
+
unbilled_charges_option?:UnbilledChargesOption;
|
|
70
|
+
account_receivables_handling?:AccountReceivablesHandling;
|
|
71
|
+
refundable_credits_handling?:RefundableCreditsHandling;
|
|
72
|
+
contract_term_cancel_option?:ContractTermCancelOption;
|
|
73
|
+
invoice_date?:number;
|
|
74
|
+
cancel_reason_code?:string;
|
|
75
|
+
subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
76
|
+
}
|
|
77
|
+
export interface ResumeSubscriptionResponse {
|
|
78
|
+
estimate:Estimate;
|
|
79
|
+
}
|
|
80
|
+
export interface ResumeSubscriptionInputParam {
|
|
81
|
+
|
|
82
|
+
resume_option?:ResumeOption;
|
|
83
|
+
charges_handling?:ChargesHandling;
|
|
84
|
+
subscription?:{resume_date?:number};
|
|
85
|
+
}
|
|
86
|
+
export interface CreateInvoiceForItemsResponse {
|
|
87
|
+
estimate:Estimate;
|
|
88
|
+
}
|
|
89
|
+
export interface CreateInvoiceForItemsInputParam {
|
|
90
|
+
|
|
91
|
+
currency_code?:string;
|
|
92
|
+
invoice_note?:string;
|
|
93
|
+
remove_general_note?:boolean;
|
|
94
|
+
coupon_ids?:string[];
|
|
95
|
+
authorization_transaction_id?:string;
|
|
96
|
+
payment_source_id?:string;
|
|
97
|
+
auto_collection?:AutoCollection;
|
|
98
|
+
invoice_date?:number;
|
|
99
|
+
invoice?:{customer_id?:string,po_number?:string,subscription_id?:string};
|
|
100
|
+
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};
|
|
101
|
+
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}[];
|
|
102
|
+
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}[];
|
|
103
|
+
charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,date_from?:number,date_to?:number,description?:string,hsn_code?:string,tax_profile_id?:string,taxable?:boolean,taxjar_product_code?:string}[];
|
|
104
|
+
notes_to_remove?:{entity_id?:string,entity_type?:EntityType}[];
|
|
105
|
+
discounts?:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
106
|
+
}
|
|
107
|
+
export interface GiftSubscriptionForItemsResponse {
|
|
108
|
+
estimate:Estimate;
|
|
109
|
+
}
|
|
110
|
+
export interface GiftSubscriptionForItemsInputParam {
|
|
111
|
+
|
|
112
|
+
coupon_ids?:string[];
|
|
113
|
+
gift?:{auto_claim?:boolean,claim_expiry_date?:number,no_expiry?:boolean,scheduled_at?:number};
|
|
114
|
+
gifter?:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
|
|
115
|
+
gift_receiver?:{customer_id:string,email:string,first_name:string,last_name:string};
|
|
116
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'sofort' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'card',reference_id?:string};
|
|
117
|
+
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};
|
|
118
|
+
subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string}[];
|
|
119
|
+
}
|
|
120
|
+
export interface UpdateSubscriptionForItemsResponse {
|
|
121
|
+
estimate:Estimate;
|
|
122
|
+
}
|
|
123
|
+
export interface UpdateSubscriptionForItemsInputParam {
|
|
124
|
+
|
|
125
|
+
mandatory_items_to_remove?:string[];
|
|
126
|
+
replace_items_list?:boolean;
|
|
127
|
+
invoice_date?:number;
|
|
128
|
+
billing_cycles?:number;
|
|
129
|
+
terms_to_charge?:number;
|
|
130
|
+
reactivate_from?:number;
|
|
131
|
+
billing_alignment_mode?:BillingAlignmentMode;
|
|
132
|
+
coupon_ids?:string[];
|
|
133
|
+
replace_coupon_list?:boolean;
|
|
134
|
+
prorate?:boolean;
|
|
135
|
+
end_of_term?:boolean;
|
|
136
|
+
force_term_reset?:boolean;
|
|
137
|
+
reactivate?:boolean;
|
|
138
|
+
include_delayed_charges?:boolean;
|
|
139
|
+
use_existing_balances?:boolean;
|
|
140
|
+
invoice_immediately?:boolean;
|
|
141
|
+
subscription?:{auto_collection?:AutoCollection,free_period?:number,free_period_unit?:FreePeriodUnit,id:string,offline_payment_method?:OfflinePaymentMethod,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
142
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
143
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
144
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
145
|
+
subscription_items?:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
146
|
+
discounts?:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
147
|
+
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}[];
|
|
148
|
+
}
|
|
149
|
+
export interface UpcomingInvoicesEstimateResponse {
|
|
150
|
+
estimate:Estimate;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
export interface RegenerateInvoiceEstimateResponse {
|
|
154
|
+
estimate:Estimate;
|
|
155
|
+
}
|
|
156
|
+
export interface RegenerateInvoiceEstimateInputParam {
|
|
157
|
+
|
|
158
|
+
date_from?:number;
|
|
159
|
+
date_to?:number;
|
|
160
|
+
prorate?:boolean;
|
|
161
|
+
invoice_immediately?:boolean;
|
|
162
|
+
}
|
|
163
|
+
export interface CreateSubItemForCustomerEstimateResponse {
|
|
164
|
+
estimate:Estimate;
|
|
165
|
+
}
|
|
166
|
+
export interface CreateSubItemForCustomerEstimateInputParam {
|
|
167
|
+
|
|
168
|
+
use_existing_balances?:boolean;
|
|
169
|
+
invoice_immediately?:boolean;
|
|
170
|
+
billing_cycles?:number;
|
|
171
|
+
mandatory_items_to_remove?:string[];
|
|
172
|
+
terms_to_charge?:number;
|
|
173
|
+
billing_alignment_mode?:BillingAlignmentMode;
|
|
174
|
+
invoice_date?:number;
|
|
175
|
+
coupon_ids?:string[];
|
|
176
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
177
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
178
|
+
contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
|
|
179
|
+
subscription_items?:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
180
|
+
discounts?:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
181
|
+
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}[];
|
|
182
|
+
}
|
|
183
|
+
export interface ChangeTermEndResponse {
|
|
184
|
+
estimate:Estimate;
|
|
185
|
+
}
|
|
186
|
+
export interface ChangeTermEndInputParam {
|
|
187
|
+
|
|
188
|
+
term_ends_at:number;
|
|
189
|
+
prorate?:boolean;
|
|
190
|
+
invoice_immediately?:boolean;
|
|
191
|
+
}
|
|
192
|
+
export interface PauseSubscriptionResponse {
|
|
193
|
+
estimate:Estimate;
|
|
194
|
+
}
|
|
195
|
+
export interface PauseSubscriptionInputParam {
|
|
196
|
+
|
|
197
|
+
pause_option?:PauseOption;
|
|
198
|
+
unbilled_charges_handling?:UnbilledChargesHandling;
|
|
199
|
+
subscription?:{pause_date?:number,resume_date?:number,skip_billing_cycles?:number};
|
|
200
|
+
}
|
|
201
|
+
export interface AdvanceInvoiceEstimateResponse {
|
|
202
|
+
estimate:Estimate;
|
|
203
|
+
}
|
|
204
|
+
export interface AdvanceInvoiceEstimateInputParam {
|
|
205
|
+
|
|
206
|
+
terms_to_charge?:number;
|
|
207
|
+
invoice_immediately?:boolean;
|
|
208
|
+
schedule_type?:ScheduleType;
|
|
209
|
+
fixed_interval_schedule?:{days_before_renewal?:number,end_date?:number,end_schedule_on?:EndScheduleOn,number_of_occurrences?:number};
|
|
210
|
+
specific_dates_schedule?:{date?:number,terms_to_charge?:number}[];
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
}
|
|
214
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
declare module 'chargebee' {
|
|
2
|
+
export interface Event {
|
|
3
|
+
|
|
4
|
+
id:string;
|
|
5
|
+
occurred_at:number;
|
|
6
|
+
source:Source;
|
|
7
|
+
user?:string;
|
|
8
|
+
event_type?:EventType;
|
|
9
|
+
api_version?:ApiVersion;
|
|
10
|
+
content:object;
|
|
11
|
+
webhooks?:Event.Webhook[];
|
|
12
|
+
}
|
|
13
|
+
export namespace Event {
|
|
14
|
+
export class EventResource {
|
|
15
|
+
list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
|
|
16
|
+
retrieve(event_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
17
|
+
}
|
|
18
|
+
export interface ListResponse {
|
|
19
|
+
list:{event:Event}[];
|
|
20
|
+
next_offset?:string;
|
|
21
|
+
}
|
|
22
|
+
export interface ListInputParam {
|
|
23
|
+
[key: string]: string | number | object | boolean;
|
|
24
|
+
limit?:number;
|
|
25
|
+
offset?:string;
|
|
26
|
+
id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
27
|
+
webhook_status?:{in?:string,is?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped',is_not?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped',not_in?:string};
|
|
28
|
+
event_type?:{in?:string,is?:'subscription_pause_scheduled' | 'order_delivered' | '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_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_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' | 'plan_deleted' | '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' | 'addon_deleted' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'addon_updated' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'addon_created' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'plan_created' | 'entitlement_overrides_updated' | 'plan_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' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided',is_not?:'subscription_pause_scheduled' | 'order_delivered' | '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_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_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' | 'plan_deleted' | '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' | 'addon_deleted' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'addon_updated' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'addon_created' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'plan_created' | 'entitlement_overrides_updated' | 'plan_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' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided',not_in?:string};
|
|
29
|
+
source?:{in?:string,is?:'admin_console' | 'system' | 'scheduled_job' | 'js_api' | 'bulk_operation' | 'hosted_page' | 'migration' | 'api' | 'none' | 'portal' | 'external_service',is_not?:'admin_console' | 'system' | 'scheduled_job' | 'js_api' | 'bulk_operation' | 'hosted_page' | 'migration' | 'api' | 'none' | 'portal' | 'external_service',not_in?:string};
|
|
30
|
+
occurred_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
31
|
+
sort_by?:{asc?:'occurred_at',desc?:'occurred_at'};
|
|
32
|
+
}
|
|
33
|
+
export interface RetrieveResponse {
|
|
34
|
+
event:Event;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export interface Webhook {
|
|
38
|
+
id?:string;
|
|
39
|
+
webhook_status?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped';
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
declare module 'chargebee' {
|
|
2
|
+
export interface Export {
|
|
3
|
+
|
|
4
|
+
id:string;
|
|
5
|
+
operation_type:string;
|
|
6
|
+
mime_type:'zip' | 'pdf';
|
|
7
|
+
status:'in_process' | 'completed' | 'failed';
|
|
8
|
+
created_at:number;
|
|
9
|
+
download?:Export.Download;
|
|
10
|
+
}
|
|
11
|
+
export namespace Export {
|
|
12
|
+
export class ExportResource {
|
|
13
|
+
customers(input?:CustomersInputParam):ChargebeeRequest<CustomersResponse>;
|
|
14
|
+
attached_items(input?:AttachedItemsInputParam):ChargebeeRequest<AttachedItemsResponse>;
|
|
15
|
+
transactions(input?:TransactionsInputParam):ChargebeeRequest<TransactionsResponse>;
|
|
16
|
+
differential_prices(input?:DifferentialPricesInputParam):ChargebeeRequest<DifferentialPricesResponse>;
|
|
17
|
+
item_families(input?:ItemFamiliesInputParam):ChargebeeRequest<ItemFamiliesResponse>;
|
|
18
|
+
invoices(input?:InvoicesInputParam):ChargebeeRequest<InvoicesResponse>;
|
|
19
|
+
retrieve(export_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
20
|
+
items(input?:ItemsInputParam):ChargebeeRequest<ItemsResponse>;
|
|
21
|
+
deferred_revenue(input:DeferredRevenueInputParam):ChargebeeRequest<DeferredRevenueResponse>;
|
|
22
|
+
revenue_recognition(input:RevenueRecognitionInputParam):ChargebeeRequest<RevenueRecognitionResponse>;
|
|
23
|
+
credit_notes(input?:CreditNotesInputParam):ChargebeeRequest<CreditNotesResponse>;
|
|
24
|
+
coupons(input?:CouponsInputParam):ChargebeeRequest<CouponsResponse>;
|
|
25
|
+
orders(input?:OrdersInputParam):ChargebeeRequest<OrdersResponse>;
|
|
26
|
+
item_prices(input?:ItemPricesInputParam):ChargebeeRequest<ItemPricesResponse>;
|
|
27
|
+
subscriptions(input?:SubscriptionsInputParam):ChargebeeRequest<SubscriptionsResponse>;
|
|
28
|
+
}
|
|
29
|
+
export interface CustomersResponse {
|
|
30
|
+
export:Export;
|
|
31
|
+
}
|
|
32
|
+
export interface CustomersInputParam {
|
|
33
|
+
|
|
34
|
+
export_type?:ExportType;
|
|
35
|
+
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
36
|
+
customer?:{auto_close_invoices?:{is?:'true' | 'false'},auto_collection?:{in?:string,is?:'off' | 'on',is_not?:'off' | 'on',not_in?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},company?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},email?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},first_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},last_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},phone?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},taxability?:{in?:string,is?:'taxable' | 'exempt',is_not?:'taxable' | 'exempt',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
37
|
+
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}};
|
|
38
|
+
}
|
|
39
|
+
export interface AttachedItemsResponse {
|
|
40
|
+
export:Export;
|
|
41
|
+
}
|
|
42
|
+
export interface AttachedItemsInputParam {
|
|
43
|
+
|
|
44
|
+
item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
|
|
45
|
+
attached_item?:{charge_on_event?:{in?:string,is?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',is_not?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},type?:{in?:string,is?:'optional' | 'mandatory' | 'recommended',is_not?:'optional' | 'mandatory' | 'recommended',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
46
|
+
}
|
|
47
|
+
export interface TransactionsResponse {
|
|
48
|
+
export:Export;
|
|
49
|
+
}
|
|
50
|
+
export interface TransactionsInputParam {
|
|
51
|
+
|
|
52
|
+
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' | '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' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | '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' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay',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' | 'chargeback' | 'wechat_pay' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | '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}};
|
|
53
|
+
}
|
|
54
|
+
export interface DifferentialPricesResponse {
|
|
55
|
+
export:Export;
|
|
56
|
+
}
|
|
57
|
+
export interface DifferentialPricesInputParam {
|
|
58
|
+
|
|
59
|
+
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
60
|
+
differential_price?:{id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string}};
|
|
61
|
+
}
|
|
62
|
+
export interface ItemFamiliesResponse {
|
|
63
|
+
export:Export;
|
|
64
|
+
}
|
|
65
|
+
export interface ItemFamiliesInputParam {
|
|
66
|
+
|
|
67
|
+
item_family?:{id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{is?:string,is_not?:string,starts_with?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
68
|
+
}
|
|
69
|
+
export interface InvoicesResponse {
|
|
70
|
+
export:Export;
|
|
71
|
+
}
|
|
72
|
+
export interface InvoicesInputParam {
|
|
73
|
+
|
|
74
|
+
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
75
|
+
invoice?:{amount_adjusted?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_due?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},credits_applied?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},dunning_status?:{in?:string,is?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_not?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_present?:'true' | 'false',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},paid_at?:{after?:string,before?:string,between?:string,on?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},recurring?:{is?:'true' | 'false'},status?:{in?:string,is?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',is_not?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
76
|
+
}
|
|
77
|
+
export interface RetrieveResponse {
|
|
78
|
+
export:Export;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
export interface ItemsResponse {
|
|
82
|
+
export:Export;
|
|
83
|
+
}
|
|
84
|
+
export interface ItemsInputParam {
|
|
85
|
+
|
|
86
|
+
item?:{channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},enabled_for_checkout?:{is?:'true' | 'false'},enabled_in_portal?:{is?:'true' | 'false'},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},is_giftable?:{is?:'true' | 'false'},item_applicability?:{in?:string,is?:'all' | 'restricted',is_not?:'all' | 'restricted',not_in?:string},item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},metered?:{is?:'true' | 'false'},name?:{is?:string,is_not?:string,starts_with?:string},status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string},type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string},usage_calculation?:{in?:string,is?:'max_usage' | 'sum_of_usages' | 'last_usage',is_not?:'max_usage' | 'sum_of_usages' | 'last_usage',not_in?:string}};
|
|
87
|
+
}
|
|
88
|
+
export interface DeferredRevenueResponse {
|
|
89
|
+
export:Export;
|
|
90
|
+
}
|
|
91
|
+
export interface DeferredRevenueInputParam {
|
|
92
|
+
|
|
93
|
+
report_by:ReportBy;
|
|
94
|
+
currency_code?:string;
|
|
95
|
+
report_from_month:number;
|
|
96
|
+
report_from_year:number;
|
|
97
|
+
report_to_month:number;
|
|
98
|
+
report_to_year:number;
|
|
99
|
+
include_discounts?:boolean;
|
|
100
|
+
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
101
|
+
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
102
|
+
item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
103
|
+
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
104
|
+
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
105
|
+
invoice?:{amount_adjusted?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_due?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},credits_applied?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},date?:{after?:string,before?:string,between?:string,on?:string},dunning_status?:{in?:string,is?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_not?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_present?:'true' | 'false',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},paid_at?:{after?:string,before?:string,between?:string,on?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},recurring?:{is?:'true' | 'false'},status?:{in?:string,is?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',is_not?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',not_in?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
106
|
+
subscription?:{activated_at?:{after?:string,before?:string,between?:string,is_present?:'true' | 'false',on?:string},auto_close_invoices?:{is?:'true' | 'false'},cancel_reason?:{in?:string,is?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_not?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_present?:'true' | 'false',not_in?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},has_scheduled_changes?:{is?:'true' | 'false'},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},next_billing_at?:{after?:string,before?:string,between?:string,on?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},remaining_billing_cycles?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,is_present?:'true' | 'false',lt?:string,lte?:string},status?:{in?:string,is?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
107
|
+
customer?:{auto_close_invoices?:{is?:'true' | 'false'},auto_collection?:{in?:string,is?:'off' | 'on',is_not?:'off' | 'on',not_in?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},company?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},email?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},first_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},last_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},phone?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},taxability?:{in?:string,is?:'taxable' | 'exempt',is_not?:'taxable' | 'exempt',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
108
|
+
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}};
|
|
109
|
+
}
|
|
110
|
+
export interface RevenueRecognitionResponse {
|
|
111
|
+
export:Export;
|
|
112
|
+
}
|
|
113
|
+
export interface RevenueRecognitionInputParam {
|
|
114
|
+
|
|
115
|
+
report_by:ReportBy;
|
|
116
|
+
currency_code?:string;
|
|
117
|
+
report_from_month:number;
|
|
118
|
+
report_from_year:number;
|
|
119
|
+
report_to_month:number;
|
|
120
|
+
report_to_year:number;
|
|
121
|
+
include_discounts?:boolean;
|
|
122
|
+
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
123
|
+
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
124
|
+
item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
125
|
+
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
126
|
+
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
127
|
+
invoice?:{amount_adjusted?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_due?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},credits_applied?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},date?:{after?:string,before?:string,between?:string,on?:string},dunning_status?:{in?:string,is?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_not?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_present?:'true' | 'false',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},paid_at?:{after?:string,before?:string,between?:string,on?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},recurring?:{is?:'true' | 'false'},status?:{in?:string,is?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',is_not?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',not_in?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
128
|
+
subscription?:{activated_at?:{after?:string,before?:string,between?:string,is_present?:'true' | 'false',on?:string},auto_close_invoices?:{is?:'true' | 'false'},cancel_reason?:{in?:string,is?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_not?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_present?:'true' | 'false',not_in?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},has_scheduled_changes?:{is?:'true' | 'false'},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},next_billing_at?:{after?:string,before?:string,between?:string,on?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},remaining_billing_cycles?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,is_present?:'true' | 'false',lt?:string,lte?:string},status?:{in?:string,is?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
129
|
+
customer?:{auto_close_invoices?:{is?:'true' | 'false'},auto_collection?:{in?:string,is?:'off' | 'on',is_not?:'off' | 'on',not_in?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},company?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},email?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},first_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},last_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},phone?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},taxability?:{in?:string,is?:'taxable' | 'exempt',is_not?:'taxable' | 'exempt',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
130
|
+
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}};
|
|
131
|
+
}
|
|
132
|
+
export interface CreditNotesResponse {
|
|
133
|
+
export:Export;
|
|
134
|
+
}
|
|
135
|
+
export interface CreditNotesInputParam {
|
|
136
|
+
|
|
137
|
+
credit_note?:{amount_allocated?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_available?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_refunded?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},create_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},reason_code?:{in?:string,is?:'other' | 'product_unsatisfactory' | 'subscription_pause' | 'order_cancellation' | 'service_unsatisfactory' | 'subscription_cancellation' | 'chargeback' | 'order_change' | 'write_off' | 'waiver' | 'subscription_change' | 'fraudulent',is_not?:'other' | 'product_unsatisfactory' | 'subscription_pause' | 'order_cancellation' | 'service_unsatisfactory' | 'subscription_cancellation' | 'chargeback' | 'order_change' | 'write_off' | 'waiver' | 'subscription_change' | 'fraudulent',not_in?:string},reference_invoice_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},status?:{in?:string,is?:'refund_due' | 'adjusted' | 'refunded' | 'voided',is_not?:'refund_due' | 'adjusted' | 'refunded' | 'voided',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},type?:{in?:string,is?:'adjustment' | 'refundable',is_not?:'adjustment' | 'refundable',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string},voided_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
138
|
+
}
|
|
139
|
+
export interface CouponsResponse {
|
|
140
|
+
export:Export;
|
|
141
|
+
}
|
|
142
|
+
export interface CouponsInputParam {
|
|
143
|
+
|
|
144
|
+
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
145
|
+
coupon?:{apply_on?:{in?:string,is?:'invoice_amount' | 'each_specified_item',is_not?:'invoice_amount' | 'each_specified_item',not_in?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},discount_type?:{in?:string,is?:'fixed_amount' | 'percentage',is_not?:'fixed_amount' | 'percentage',not_in?:string},duration_type?:{in?:string,is?:'limited_period' | 'one_time' | 'forever',is_not?:'limited_period' | 'one_time' | 'forever',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},status?:{in?:string,is?:'archived' | 'expired' | 'deleted' | 'active',is_not?:'archived' | 'expired' | 'deleted' | 'active',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
146
|
+
}
|
|
147
|
+
export interface OrdersResponse {
|
|
148
|
+
export:Export;
|
|
149
|
+
}
|
|
150
|
+
export interface OrdersInputParam {
|
|
151
|
+
|
|
152
|
+
total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
|
|
153
|
+
order?:{amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},delivered_at?:{after?:string,before?:string,between?:string,on?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},is_resent?:{is?:'true' | 'false'},order_date?:{after?:string,before?:string,between?:string,on?:string},original_order_id?:{is?:string,is_not?:string,starts_with?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},refundable_credits?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},refundable_credits_issued?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},resent_status?:{in?:string,is?:'fully_resent' | 'partially_resent',is_not?:'fully_resent' | 'partially_resent',not_in?:string},shipped_at?:{after?:string,before?:string,between?:string,on?:string},shipping_date?:{after?:string,before?:string,between?:string,on?:string},status?:{in?:string,is?:'new' | 'partially_delivered' | 'queued' | 'delivered' | 'on_hold' | 'shipped' | 'processing' | 'cancelled' | 'voided' | 'complete' | 'awaiting_shipment' | 'returned',is_not?:'new' | 'partially_delivered' | 'queued' | 'delivered' | 'on_hold' | 'shipped' | 'processing' | 'cancelled' | 'voided' | 'complete' | 'awaiting_shipment' | 'returned',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
154
|
+
}
|
|
155
|
+
export interface ItemPricesResponse {
|
|
156
|
+
export:Export;
|
|
157
|
+
}
|
|
158
|
+
export interface ItemPricesInputParam {
|
|
159
|
+
|
|
160
|
+
item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
161
|
+
item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
|
|
162
|
+
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
163
|
+
item_price?:{channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},period_unit?:{in?:string,is?:'week' | 'month' | 'year' | 'day',is_not?:'week' | 'month' | 'year' | 'day',not_in?:string},pricing_model?:{in?:string,is?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',is_not?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',not_in?:string},status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string},trial_period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},trial_period_unit?:{in?:string,is?:'month' | 'day',is_not?:'month' | 'day',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
164
|
+
}
|
|
165
|
+
export interface SubscriptionsResponse {
|
|
166
|
+
export:Export;
|
|
167
|
+
}
|
|
168
|
+
export interface SubscriptionsInputParam {
|
|
169
|
+
|
|
170
|
+
export_type?:ExportType;
|
|
171
|
+
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
172
|
+
item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
173
|
+
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
174
|
+
subscription?:{activated_at?:{after?:string,before?:string,between?:string,is_present?:'true' | 'false',on?:string},auto_close_invoices?:{is?:'true' | 'false'},cancel_reason?:{in?:string,is?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_not?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_present?:'true' | 'false',not_in?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},has_scheduled_changes?:{is?:'true' | 'false'},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},next_billing_at?:{after?:string,before?:string,between?:string,on?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},remaining_billing_cycles?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,is_present?:'true' | 'false',lt?:string,lte?:string},status?:{in?:string,is?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
175
|
+
}
|
|
176
|
+
export interface Download {
|
|
177
|
+
download_url?:string;
|
|
178
|
+
valid_till?:number;
|
|
179
|
+
mime_type?:string;
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
declare module 'chargebee' {
|
|
2
|
+
export interface Feature {
|
|
3
|
+
|
|
4
|
+
id:string;
|
|
5
|
+
name:string;
|
|
6
|
+
description?:string;
|
|
7
|
+
status?:'archived' | 'draft' | 'active';
|
|
8
|
+
type?:'quantity' | 'custom' | 'range' | 'switch';
|
|
9
|
+
unit?:string;
|
|
10
|
+
resource_version?:number;
|
|
11
|
+
updated_at?:number;
|
|
12
|
+
created_at:number;
|
|
13
|
+
levels?:Feature.Level[];
|
|
14
|
+
}
|
|
15
|
+
export namespace Feature {
|
|
16
|
+
export class FeatureResource {
|
|
17
|
+
list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
|
|
18
|
+
create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
|
|
19
|
+
delete(feature_id:string):ChargebeeRequest<DeleteResponse>;
|
|
20
|
+
retrieve(feature_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
21
|
+
update(feature_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
|
|
22
|
+
archive(feature_id:string):ChargebeeRequest<ArchiveResponse>;
|
|
23
|
+
activate(feature_id:string):ChargebeeRequest<ActivateResponse>;
|
|
24
|
+
reactivate(feature_id:string):ChargebeeRequest<ReactivateResponse>;
|
|
25
|
+
}
|
|
26
|
+
export interface ListResponse {
|
|
27
|
+
list:{feature:Feature}[];
|
|
28
|
+
next_offset?:string;
|
|
29
|
+
}
|
|
30
|
+
export interface ListInputParam {
|
|
31
|
+
[key: string]: string | number | object | boolean;
|
|
32
|
+
limit?:number;
|
|
33
|
+
offset?:string;
|
|
34
|
+
name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
35
|
+
id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
36
|
+
status?:{in?:string,is?:'archived' | 'draft' | 'active',is_not?:'archived' | 'draft' | 'active',not_in?:string};
|
|
37
|
+
type?:{in?:string,is?:'quantity' | 'custom' | 'range' | 'switch',is_not?:'quantity' | 'custom' | 'range' | 'switch',not_in?:string};
|
|
38
|
+
}
|
|
39
|
+
export interface CreateResponse {
|
|
40
|
+
feature:Feature;
|
|
41
|
+
}
|
|
42
|
+
export interface CreateInputParam {
|
|
43
|
+
[key : string] : any;
|
|
44
|
+
id?:string;
|
|
45
|
+
name:string;
|
|
46
|
+
description?:string;
|
|
47
|
+
type?:'quantity' | 'custom' | 'range' | 'switch';
|
|
48
|
+
status?:'draft' | 'active';
|
|
49
|
+
unit?:string;
|
|
50
|
+
levels?:{is_unlimited?:boolean,level?:number,name?:string,value?:string}[];
|
|
51
|
+
}
|
|
52
|
+
export interface DeleteResponse {
|
|
53
|
+
feature:Feature;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export interface RetrieveResponse {
|
|
57
|
+
feature:Feature;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export interface UpdateResponse {
|
|
61
|
+
feature:Feature;
|
|
62
|
+
}
|
|
63
|
+
export interface UpdateInputParam {
|
|
64
|
+
[key : string] : any;
|
|
65
|
+
name?:string;
|
|
66
|
+
description?:string;
|
|
67
|
+
status?:'archived' | 'draft' | 'active';
|
|
68
|
+
unit?:string;
|
|
69
|
+
levels?:{is_unlimited?:boolean,level?:number,name?:string,value?:string}[];
|
|
70
|
+
}
|
|
71
|
+
export interface ArchiveResponse {
|
|
72
|
+
feature:Feature;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export interface ActivateResponse {
|
|
76
|
+
feature:Feature;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export interface ReactivateResponse {
|
|
80
|
+
feature:Feature;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export interface Level {
|
|
84
|
+
name?:string;
|
|
85
|
+
value?:string;
|
|
86
|
+
level?:number;
|
|
87
|
+
is_unlimited?:boolean;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|