chargebee 2.51.0 → 2.52.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 +27 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +14 -1
- package/package.json +1 -1
- package/types/core.d.ts +4 -4
- package/types/index.d.ts +2 -0
- package/types/resources/Address.d.ts +2 -194
- package/types/resources/AdvanceInvoiceSchedule.d.ts +5 -67
- package/types/resources/Attribute.d.ts +4 -1
- package/types/resources/BillingConfiguration.d.ts +21 -0
- package/types/resources/Brand.d.ts +12 -0
- package/types/resources/BusinessEntity.d.ts +8 -6
- package/types/resources/BusinessEntityTransfer.d.ts +10 -7
- package/types/resources/Card.d.ts +11 -311
- package/types/resources/Comment.d.ts +7 -124
- package/types/resources/Contact.d.ts +2 -44
- package/types/resources/ContractTerm.d.ts +4 -72
- package/types/resources/Coupon.d.ts +0 -37
- package/types/resources/CouponCode.d.ts +67 -35
- package/types/resources/CouponSet.d.ts +12 -121
- package/types/resources/CreditNote.d.ts +0 -6
- package/types/resources/Currency.d.ts +8 -5
- package/types/resources/Customer.d.ts +90 -89
- package/types/resources/Discount.d.ts +2 -89
- package/types/resources/Download.d.ts +2 -14
- package/types/resources/Entitlement.d.ts +15 -103
- package/types/resources/EntitlementOverride.d.ts +4 -89
- package/types/resources/Estimate.d.ts +2 -10
- package/types/resources/Event.d.ts +23 -108
- package/types/resources/Export.d.ts +116 -432
- package/types/resources/Feature.d.ts +17 -319
- package/types/resources/GatewayErrorDetail.d.ts +6 -48
- package/types/resources/Gift.d.ts +34 -294
- package/types/resources/Hierarchy.d.ts +4 -24
- package/types/resources/ImpactedItem.d.ts +4 -36
- package/types/resources/ImpactedItemPrice.d.ts +5 -2
- package/types/resources/ImpactedSubscription.d.ts +3 -30
- package/types/resources/InAppSubscription.d.ts +13 -355
- package/types/resources/Invoice.d.ts +2 -16
- package/types/resources/InvoiceEstimate.d.ts +1 -1
- package/types/resources/Item.d.ts +0 -7
- package/types/resources/ItemEntitlement.d.ts +15 -155
- package/types/resources/NonSubscription.d.ts +9 -6
- package/types/resources/PaymentIntent.d.ts +9 -255
- package/types/resources/PaymentReferenceNumber.d.ts +3 -20
- package/types/resources/PaymentSource.d.ts +2 -2
- package/types/resources/PaymentVoucher.d.ts +20 -203
- package/types/resources/PortalSession.d.ts +4 -146
- package/types/resources/PromotionalCredit.d.ts +10 -215
- package/types/resources/Purchase.d.ts +3 -1
- package/types/resources/Quote.d.ts +19 -1
- package/types/resources/QuotedRamp.d.ts +11 -16
- package/types/resources/RecordedPurchase.d.ts +2 -0
- package/types/resources/ResourceMigration.d.ts +2 -54
- package/types/resources/SiteMigrationDetail.d.ts +13 -55
- package/types/resources/Subscription.d.ts +11 -9
- package/types/resources/SubscriptionEntitlement.d.ts +6 -106
- package/types/resources/SubscriptionEstimate.d.ts +14 -11
- package/types/resources/TaxWithheld.d.ts +14 -26
- package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -19
- package/types/resources/TimeMachine.d.ts +3 -64
- package/types/resources/Token.d.ts +3 -60
- package/types/resources/Transaction.d.ts +2 -2
- package/types/resources/Usage.d.ts +21 -165
|
@@ -1,160 +1,56 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface Export {
|
|
4
5
|
|
|
5
|
-
/**
|
|
6
|
-
* @description A unique identifier to identify the export
|
|
7
6
|
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
7
|
id:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description Describes the type of export
|
|
14
8
|
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
9
|
operation_type:string;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description Describes the mime type of download file \* pdf - PDF \* zip - ZIP
|
|
21
10
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
mime_type:'zip' | 'pdf';
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description Current status of the export operation \* completed - Completed \* failed - Failed \* in_process - In Process
|
|
11
|
+
mime_type:'pdf' | 'zip';
|
|
28
12
|
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
13
|
status:'in_process' | 'completed' | 'failed';
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* @description Export created time
|
|
35
14
|
|
|
36
|
-
*/
|
|
37
|
-
|
|
38
15
|
created_at:number;
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* @description Returns the download_url for the export. The download URL is valid upto a specific date.
|
|
42
16
|
|
|
43
|
-
*/
|
|
44
|
-
|
|
45
17
|
download?:Export.Download;
|
|
18
|
+
|
|
46
19
|
}
|
|
47
20
|
export namespace Export {
|
|
48
21
|
export class ExportResource {
|
|
49
|
-
/**
|
|
50
|
-
* @description This API gets the status of the export job initiated by the Exports API. If the export job is completed, the downloads resource will also be obtained in the API response. The returned URL in the downloads resource is secure and can be downloaded. The URL expires after 4 hours. Please note that this is a public URL, and can be downloaded by anyone with whom it's shared.
|
|
51
|
-
|
|
52
|
-
**Note:** In case the export is in Failed or In-process state, then the downloads resource will not be available.
|
|
53
|
-
|
|
54
|
-
*/
|
|
55
|
-
|
|
56
22
|
retrieve(export_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
57
23
|
|
|
58
|
-
/**
|
|
59
|
-
* @description This API triggers export for the revenue recognition report.
|
|
60
|
-
|
|
61
|
-
**Note:** This API call is asynchronous. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion** function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
|
|
62
|
-
|
|
63
|
-
*/
|
|
64
|
-
|
|
65
24
|
revenue_recognition(input:RevenueRecognitionInputParam):ChargebeeRequest<RevenueRecognitionResponse>;
|
|
66
25
|
|
|
67
|
-
/**
|
|
68
|
-
* @description This API triggers export for the Deferred Revenue Report.
|
|
69
|
-
|
|
70
|
-
**Note:** This API call is asynchronous. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion** function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
|
|
71
|
-
|
|
72
|
-
*/
|
|
73
|
-
|
|
74
26
|
deferred_revenue(input:DeferredRevenueInputParam):ChargebeeRequest<DeferredRevenueResponse>;
|
|
75
27
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
28
|
+
plans(input?:PlansInputParam):ChargebeeRequest<PlansResponse>;
|
|
29
|
+
|
|
30
|
+
addons(input?:AddonsInputParam):ChargebeeRequest<AddonsResponse>;
|
|
31
|
+
|
|
81
32
|
coupons(input?:CouponsInputParam):ChargebeeRequest<CouponsResponse>;
|
|
82
33
|
|
|
83
|
-
/**
|
|
84
|
-
* @description This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.
|
|
85
|
-
|
|
86
|
-
*/
|
|
87
|
-
|
|
88
34
|
customers(input?:CustomersInputParam):ChargebeeRequest<CustomersResponse>;
|
|
89
35
|
|
|
90
|
-
/**
|
|
91
|
-
* @description This API triggers export of subscription data. The exported zip file contains CSV files with subscription-related data.
|
|
92
|
-
|
|
93
|
-
*/
|
|
94
|
-
|
|
95
36
|
subscriptions(input?:SubscriptionsInputParam):ChargebeeRequest<SubscriptionsResponse>;
|
|
96
37
|
|
|
97
|
-
/**
|
|
98
|
-
* @description This API triggers export of invoice data. The exported zip file contains CSV files with invoice-related data.
|
|
99
|
-
|
|
100
|
-
*/
|
|
101
|
-
|
|
102
38
|
invoices(input?:InvoicesInputParam):ChargebeeRequest<InvoicesResponse>;
|
|
103
39
|
|
|
104
|
-
/**
|
|
105
|
-
* @description This API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.
|
|
106
|
-
|
|
107
|
-
*/
|
|
108
|
-
|
|
109
40
|
credit_notes(input?:CreditNotesInputParam):ChargebeeRequest<CreditNotesResponse>;
|
|
110
41
|
|
|
111
|
-
/**
|
|
112
|
-
* @description This API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.
|
|
113
|
-
|
|
114
|
-
*/
|
|
115
|
-
|
|
116
42
|
transactions(input?:TransactionsInputParam):ChargebeeRequest<TransactionsResponse>;
|
|
117
43
|
|
|
118
|
-
/**
|
|
119
|
-
* @description This API triggers export of order data. The exported zip file contains CSV files with order-related data.
|
|
120
|
-
|
|
121
|
-
*/
|
|
122
|
-
|
|
123
44
|
orders(input?:OrdersInputParam):ChargebeeRequest<OrdersResponse>;
|
|
124
45
|
|
|
125
|
-
/**
|
|
126
|
-
* @description This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.
|
|
127
|
-
|
|
128
|
-
*/
|
|
129
|
-
|
|
130
46
|
item_families(input?:ItemFamiliesInputParam):ChargebeeRequest<ItemFamiliesResponse>;
|
|
131
47
|
|
|
132
|
-
/**
|
|
133
|
-
* @description This API triggers export of item data. The exported zip file contains CSV files with item-related data.
|
|
134
|
-
|
|
135
|
-
*/
|
|
136
|
-
|
|
137
48
|
items(input?:ItemsInputParam):ChargebeeRequest<ItemsResponse>;
|
|
138
49
|
|
|
139
|
-
/**
|
|
140
|
-
* @description This API triggers export of item price data. The exported zip file contains CSV files with item price-related data.
|
|
141
|
-
|
|
142
|
-
*/
|
|
143
|
-
|
|
144
50
|
item_prices(input?:ItemPricesInputParam):ChargebeeRequest<ItemPricesResponse>;
|
|
145
51
|
|
|
146
|
-
/**
|
|
147
|
-
* @description This API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.
|
|
148
|
-
|
|
149
|
-
*/
|
|
150
|
-
|
|
151
52
|
attached_items(input?:AttachedItemsInputParam):ChargebeeRequest<AttachedItemsResponse>;
|
|
152
53
|
|
|
153
|
-
/**
|
|
154
|
-
* @description This API triggers export of differential price data. The exported zip file contains CSV files with differential price-related data.
|
|
155
|
-
|
|
156
|
-
*/
|
|
157
|
-
|
|
158
54
|
differential_prices(input?:DifferentialPricesInputParam):ChargebeeRequest<DifferentialPricesResponse>;
|
|
159
55
|
|
|
160
56
|
price_variants(input?:PriceVariantsInputParam):ChargebeeRequest<PriceVariantsResponse>;
|
|
@@ -168,469 +64,285 @@ declare module 'chargebee' {
|
|
|
168
64
|
}
|
|
169
65
|
export interface RevenueRecognitionInputParam {
|
|
170
66
|
|
|
171
|
-
|
|
172
|
-
* @description Determines the scope of the report. Returns the report based on the value specified. \* subscription - Subscription \* invoice - Invoice \* product - Product (Includes Plan, Addon and Adhoc) \* customer - Customer
|
|
173
|
-
|
|
174
|
-
*/
|
|
67
|
+
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?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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' | 'exhausted' | 'stopped' | 'success',is_not?:'in_progress' | 'exhausted' | 'stopped' | 'success',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?:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending',is_not?:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending',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}};
|
|
175
68
|
|
|
176
|
-
|
|
69
|
+
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?:'not_paid' | 'no_card' | 'fraud_review_failed' | 'non_compliant_eu_customer' | 'tax_calculation_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_customer',is_not?:'not_paid' | 'no_card' | 'fraud_review_failed' | 'non_compliant_eu_customer' | 'tax_calculation_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_customer',is_present?:'true' | 'false',not_in?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'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',is_not?:'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',not_in?:string},plan_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?: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?:'future' | 'in_trial' | 'active' | 'non_renewing' | 'paused' | 'cancelled' | 'transferred',is_not?:'future' | 'in_trial' | 'active' | 'non_renewing' | 'paused' | 'cancelled' | 'transferred',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
177
70
|
|
|
178
|
-
|
|
179
|
-
* @description Value must be in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.
|
|
180
|
-
|
|
181
|
-
*/
|
|
71
|
+
customer?:{auto_close_invoices?:{is?:'true' | 'false'},auto_collection?:{in?:string,is?:'on' | 'off',is_not?:'on' | 'off',not_in?:string},channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'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',is_not?:'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',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}};
|
|
182
72
|
|
|
183
|
-
|
|
73
|
+
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}};
|
|
184
74
|
|
|
185
|
-
|
|
186
|
-
* @description Obtains report data from the specified month, combined with the value specified for report_from_year. Values must be between 1 and 12, where 1 is January and 12 is December.
|
|
187
|
-
|
|
188
|
-
*/
|
|
75
|
+
report_by:ReportBy;
|
|
189
76
|
|
|
190
|
-
|
|
77
|
+
currency_code?:string;
|
|
191
78
|
|
|
192
|
-
|
|
193
|
-
* @description Obtains report data from the specified year, combined with the value specified for report_from_month.
|
|
194
|
-
|
|
195
|
-
*/
|
|
79
|
+
report_from_month:number;
|
|
196
80
|
|
|
197
81
|
report_from_year:number;
|
|
198
82
|
|
|
199
|
-
/**
|
|
200
|
-
* @description Obtains report data from the specified month, combined with the value specified for report_to_year. Values must be between 1 and 12, where 1 is January and 12 is December.
|
|
201
|
-
|
|
202
|
-
*/
|
|
203
|
-
|
|
204
83
|
report_to_month:number;
|
|
205
84
|
|
|
206
|
-
/**
|
|
207
|
-
* @description Obtains report data until the specified year, combined with the value specified for report_to_month.
|
|
208
|
-
|
|
209
|
-
*/
|
|
210
|
-
|
|
211
85
|
report_to_year:number;
|
|
212
86
|
|
|
213
|
-
/**
|
|
214
|
-
* @description Returns amount with discount in the report. If value specified is false, it returns amount without discount.
|
|
215
|
-
|
|
216
|
-
*/
|
|
217
|
-
|
|
218
87
|
include_discounts?:boolean;
|
|
219
88
|
|
|
220
89
|
/**
|
|
221
|
-
* @description
|
|
222
|
-
Payment owner of an invoice.
|
|
223
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
224
|
-
|
|
225
|
-
**Example →** *payment_owner\[is\] = "payment_customer"*
|
|
90
|
+
* @description Payment owner of an invoice
|
|
226
91
|
|
|
227
92
|
*/
|
|
228
93
|
|
|
229
94
|
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
230
95
|
|
|
231
96
|
/**
|
|
232
|
-
* @description
|
|
233
|
-
The plan item code.
|
|
234
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
235
|
-
|
|
236
|
-
**Example →** *item_id\[is\] = "silver"*
|
|
97
|
+
* @description The plan item code
|
|
237
98
|
|
|
238
99
|
*/
|
|
239
100
|
|
|
240
101
|
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
241
102
|
|
|
242
103
|
/**
|
|
243
|
-
* @description
|
|
244
|
-
The plan item price code.
|
|
245
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
246
|
-
|
|
247
|
-
**Example →** *item_price_id\[is\] = "silver-USD-monthly"*
|
|
104
|
+
* @description The plan item price code
|
|
248
105
|
|
|
249
106
|
*/
|
|
250
107
|
|
|
251
108
|
item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
252
109
|
|
|
253
110
|
/**
|
|
254
|
-
* @description
|
|
255
|
-
Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive.
|
|
256
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
257
|
-
|
|
258
|
-
**Example →** *cancel_reason_code\[is\] = "Not Paid"*
|
|
111
|
+
* @description Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation**. Must be passed if set as mandatory in the app. The codes are case-sensitive
|
|
259
112
|
|
|
260
113
|
*/
|
|
261
114
|
|
|
262
115
|
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
263
116
|
|
|
264
117
|
/**
|
|
265
|
-
* @description
|
|
266
|
-
The
|
|
267
|
-
**
|
|
118
|
+
* @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.
|
|
119
|
+
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.
|
|
120
|
+
**Note**
|
|
268
121
|
|
|
269
|
-
|
|
122
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
270
123
|
|
|
271
124
|
*/
|
|
272
125
|
|
|
273
126
|
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
274
|
-
|
|
275
|
-
/**
|
|
276
|
-
* @description Parameters for invoice
|
|
277
|
-
|
|
278
|
-
*/
|
|
279
|
-
|
|
280
|
-
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}};
|
|
281
|
-
|
|
282
|
-
/**
|
|
283
|
-
* @description Parameters for subscription
|
|
284
|
-
|
|
285
|
-
*/
|
|
286
|
-
|
|
287
|
-
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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
288
|
-
|
|
289
|
-
/**
|
|
290
|
-
* @description Parameters for customer
|
|
291
|
-
|
|
292
|
-
*/
|
|
293
|
-
|
|
294
|
-
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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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}};
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* @description Parameters for relationship
|
|
298
|
-
|
|
299
|
-
*/
|
|
300
|
-
|
|
301
|
-
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}};
|
|
302
127
|
}
|
|
303
128
|
export interface DeferredRevenueResponse {
|
|
304
129
|
export:Export;
|
|
305
130
|
}
|
|
306
131
|
export interface DeferredRevenueInputParam {
|
|
307
132
|
|
|
308
|
-
|
|
309
|
-
* @description Determines the scope of the report. Returns the report based on the value specified. \* subscription - Subscription \* invoice - Invoice \* product - Product (Includes Plan, Addon and Adhoc) \* customer - Customer
|
|
310
|
-
|
|
311
|
-
*/
|
|
133
|
+
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?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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' | 'exhausted' | 'stopped' | 'success',is_not?:'in_progress' | 'exhausted' | 'stopped' | 'success',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?:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending',is_not?:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending',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}};
|
|
312
134
|
|
|
313
|
-
|
|
135
|
+
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?:'not_paid' | 'no_card' | 'fraud_review_failed' | 'non_compliant_eu_customer' | 'tax_calculation_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_customer',is_not?:'not_paid' | 'no_card' | 'fraud_review_failed' | 'non_compliant_eu_customer' | 'tax_calculation_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_customer',is_present?:'true' | 'false',not_in?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'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',is_not?:'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',not_in?:string},plan_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?: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?:'future' | 'in_trial' | 'active' | 'non_renewing' | 'paused' | 'cancelled' | 'transferred',is_not?:'future' | 'in_trial' | 'active' | 'non_renewing' | 'paused' | 'cancelled' | 'transferred',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
314
136
|
|
|
315
|
-
|
|
316
|
-
* @description Value must be in ISO 4217 format. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.
|
|
317
|
-
|
|
318
|
-
*/
|
|
137
|
+
customer?:{auto_close_invoices?:{is?:'true' | 'false'},auto_collection?:{in?:string,is?:'on' | 'off',is_not?:'on' | 'off',not_in?:string},channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'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',is_not?:'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',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}};
|
|
319
138
|
|
|
320
|
-
|
|
139
|
+
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}};
|
|
321
140
|
|
|
322
|
-
|
|
323
|
-
* @description Obtains report data from the specified month, combined with the value specified for report_from_year.Values must be between 1 and 12, where 1 is January and 12 is December.
|
|
324
|
-
|
|
325
|
-
*/
|
|
141
|
+
report_by:ReportBy;
|
|
326
142
|
|
|
327
|
-
|
|
143
|
+
currency_code?:string;
|
|
328
144
|
|
|
329
|
-
|
|
330
|
-
* @description Obtains report data from the specified year, combined with the value specified for report_from_month.
|
|
331
|
-
|
|
332
|
-
*/
|
|
145
|
+
report_from_month:number;
|
|
333
146
|
|
|
334
147
|
report_from_year:number;
|
|
335
148
|
|
|
336
|
-
/**
|
|
337
|
-
* @description Obtains report data from the specified month, combined with the value specified for report_to_year.Values must be between 1 and 12, where 1 is January and 12 is December.
|
|
338
|
-
|
|
339
|
-
*/
|
|
340
|
-
|
|
341
149
|
report_to_month:number;
|
|
342
150
|
|
|
343
|
-
/**
|
|
344
|
-
* @description Obtains report data until the specified year, combined with the value specified for report_to_month.
|
|
345
|
-
|
|
346
|
-
*/
|
|
347
|
-
|
|
348
151
|
report_to_year:number;
|
|
349
152
|
|
|
350
|
-
/**
|
|
351
|
-
* @description Returns amount with discount in the report. If value specified is false, it returns amount without discount.
|
|
352
|
-
|
|
353
|
-
*/
|
|
354
|
-
|
|
355
153
|
include_discounts?:boolean;
|
|
356
154
|
|
|
357
155
|
/**
|
|
358
|
-
* @description
|
|
359
|
-
Payment owner of an invoice.
|
|
360
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
361
|
-
|
|
362
|
-
**Example →** *payment_owner\[is\] = "payment_customer"*
|
|
156
|
+
* @description Payment owner of an invoice
|
|
363
157
|
|
|
364
158
|
*/
|
|
365
159
|
|
|
366
160
|
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
367
161
|
|
|
368
162
|
/**
|
|
369
|
-
* @description
|
|
370
|
-
The plan item code.
|
|
371
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
372
|
-
|
|
373
|
-
**Example →** *item_id\[is\] = "silver"*
|
|
163
|
+
* @description The plan item code
|
|
374
164
|
|
|
375
165
|
*/
|
|
376
166
|
|
|
377
167
|
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
378
168
|
|
|
379
169
|
/**
|
|
380
|
-
* @description
|
|
381
|
-
The plan item price code.
|
|
382
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
383
|
-
|
|
384
|
-
**Example →** *item_price_id\[is\] = "silver-USD-monthly"*
|
|
170
|
+
* @description The plan item price code
|
|
385
171
|
|
|
386
172
|
*/
|
|
387
173
|
|
|
388
174
|
item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
389
175
|
|
|
390
176
|
/**
|
|
391
|
-
* @description
|
|
392
|
-
Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive.
|
|
393
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
394
|
-
|
|
395
|
-
**Example →** *cancel_reason_code\[is\] = "Not Paid"*
|
|
177
|
+
* @description Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation**. Must be passed if set as mandatory in the app. The codes are case-sensitive
|
|
396
178
|
|
|
397
179
|
*/
|
|
398
180
|
|
|
399
181
|
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
400
182
|
|
|
401
183
|
/**
|
|
402
|
-
* @description
|
|
403
|
-
The
|
|
404
|
-
**
|
|
184
|
+
* @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.
|
|
185
|
+
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.
|
|
186
|
+
**Note**
|
|
405
187
|
|
|
406
|
-
|
|
188
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
407
189
|
|
|
408
190
|
*/
|
|
409
191
|
|
|
410
192
|
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
193
|
+
}
|
|
194
|
+
export interface PlansResponse {
|
|
195
|
+
export:Export;
|
|
196
|
+
}
|
|
197
|
+
export interface PlansInputParam {
|
|
411
198
|
|
|
412
|
-
|
|
413
|
-
* @description Parameters for invoice
|
|
414
|
-
|
|
415
|
-
*/
|
|
416
|
-
|
|
417
|
-
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}};
|
|
199
|
+
plan?:{addon_applicability?:{in?:string,is?:'all' | 'restricted',is_not?:'all' | 'restricted',not_in?:string},channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string},giftable?:{is?:'true' | 'false'},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?:'day' | 'week' | 'month' | 'year',is_not?:'day' | 'week' | 'month' | 'year',not_in?:string},price?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},status?:{in?:string,is?:'active' | 'archived' | 'deleted',is_not?:'active' | 'archived' | 'deleted',not_in?:string},trial_period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,is_present?:'true' | 'false',lt?:string,lte?:string},trial_period_unit?:{in?:string,is?:'day' | 'month',is_not?:'day' | 'month',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
418
200
|
|
|
419
201
|
/**
|
|
420
|
-
* @description
|
|
202
|
+
* @description The currency code (ISO 4217 format) of the plan
|
|
421
203
|
|
|
422
204
|
*/
|
|
423
205
|
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
206
|
+
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
207
|
+
}
|
|
208
|
+
export interface AddonsResponse {
|
|
209
|
+
export:Export;
|
|
210
|
+
}
|
|
211
|
+
export interface AddonsInputParam {
|
|
430
212
|
|
|
431
|
-
|
|
213
|
+
addon?:{channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string},charge_type?:{in?:string,is?:'recurring' | 'non_recurring',is_not?:'recurring' | 'non_recurring',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},period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},period_unit?:{in?:string,is?:'day' | 'week' | 'month' | 'year' | 'not_applicable',is_not?:'day' | 'week' | 'month' | 'year' | 'not_applicable',not_in?:string},price?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},status?:{in?:string,is?:'active' | 'archived' | 'deleted',is_not?:'active' | 'archived' | 'deleted',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
432
214
|
|
|
433
215
|
/**
|
|
434
|
-
* @description
|
|
216
|
+
* @description The currency code (ISO 4217 format) of the addon
|
|
435
217
|
|
|
436
218
|
*/
|
|
437
219
|
|
|
438
|
-
|
|
220
|
+
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
439
221
|
}
|
|
440
222
|
export interface CouponsResponse {
|
|
441
223
|
export:Export;
|
|
442
224
|
}
|
|
443
225
|
export interface CouponsInputParam {
|
|
444
226
|
|
|
445
|
-
|
|
446
|
-
* @description optional, string filter
|
|
447
|
-
The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
|
|
448
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
449
|
-
|
|
450
|
-
**Example →** *currency_code\[is\] = "USD"*
|
|
451
|
-
|
|
452
|
-
*/
|
|
453
|
-
|
|
454
|
-
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
227
|
+
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' | 'offer_quantity',is_not?:'fixed_amount' | 'percentage' | 'offer_quantity',not_in?:string},duration_type?:{in?:string,is?:'one_time' | 'forever' | 'limited_period',is_not?:'one_time' | 'forever' | 'limited_period',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?:'active' | 'expired' | 'archived' | 'deleted' | 'future',is_not?:'active' | 'expired' | 'archived' | 'deleted' | 'future',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
455
228
|
|
|
456
229
|
/**
|
|
457
|
-
* @description
|
|
230
|
+
* @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
|
|
458
231
|
|
|
459
232
|
*/
|
|
460
233
|
|
|
461
|
-
|
|
234
|
+
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
462
235
|
}
|
|
463
236
|
export interface CustomersResponse {
|
|
464
237
|
export:Export;
|
|
465
238
|
}
|
|
466
239
|
export interface CustomersInputParam {
|
|
467
240
|
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
*/
|
|
241
|
+
customer?:{auto_close_invoices?:{is?:'true' | 'false'},auto_collection?:{in?:string,is?:'on' | 'off',is_not?:'on' | 'off',not_in?:string},channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'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',is_not?:'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',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}};
|
|
242
|
+
|
|
243
|
+
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}};
|
|
472
244
|
|
|
473
245
|
export_type?:ExportType;
|
|
474
246
|
|
|
475
247
|
/**
|
|
476
|
-
* @description
|
|
477
|
-
The
|
|
478
|
-
**
|
|
248
|
+
* @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.
|
|
249
|
+
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.
|
|
250
|
+
**Note**
|
|
479
251
|
|
|
480
|
-
|
|
252
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
481
253
|
|
|
482
254
|
*/
|
|
483
255
|
|
|
484
256
|
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
485
|
-
|
|
486
|
-
/**
|
|
487
|
-
* @description Parameters for customer
|
|
488
|
-
|
|
489
|
-
*/
|
|
490
|
-
|
|
491
|
-
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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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}};
|
|
492
|
-
|
|
493
|
-
/**
|
|
494
|
-
* @description Parameters for relationship
|
|
495
|
-
|
|
496
|
-
*/
|
|
497
|
-
|
|
498
|
-
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}};
|
|
499
257
|
}
|
|
500
258
|
export interface SubscriptionsResponse {
|
|
501
259
|
export:Export;
|
|
502
260
|
}
|
|
503
261
|
export interface SubscriptionsInputParam {
|
|
504
262
|
|
|
505
|
-
|
|
506
|
-
* @description Determines the format of the data. Returns the export type based on the selected value. \* data - Download your current data in CSV. \* import_friendly_data - Download import friendly data in CSV. This CSV can be used to perform [bulk operations](https://www.chargebee.com/docs/bulk-operations.html).
|
|
507
|
-
|
|
508
|
-
*/
|
|
263
|
+
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?:'not_paid' | 'no_card' | 'fraud_review_failed' | 'non_compliant_eu_customer' | 'tax_calculation_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_customer',is_not?:'not_paid' | 'no_card' | 'fraud_review_failed' | 'non_compliant_eu_customer' | 'tax_calculation_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_customer',is_present?:'true' | 'false',not_in?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'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',is_not?:'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',not_in?:string},plan_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?: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?:'future' | 'in_trial' | 'active' | 'non_renewing' | 'paused' | 'cancelled' | 'transferred',is_not?:'future' | 'in_trial' | 'active' | 'non_renewing' | 'paused' | 'cancelled' | 'transferred',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
509
264
|
|
|
510
265
|
export_type?:ExportType;
|
|
511
266
|
|
|
512
267
|
/**
|
|
513
|
-
* @description
|
|
514
|
-
The plan item code.
|
|
515
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
516
|
-
|
|
517
|
-
**Example →** *item_id\[is\] = "silver"*
|
|
268
|
+
* @description The plan item code
|
|
518
269
|
|
|
519
270
|
*/
|
|
520
271
|
|
|
521
272
|
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
522
273
|
|
|
523
274
|
/**
|
|
524
|
-
* @description
|
|
525
|
-
The plan item price code.
|
|
526
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
527
|
-
|
|
528
|
-
**Example →** *item_price_id\[is\] = "silver-USD-monthly"*
|
|
275
|
+
* @description The plan item price code
|
|
529
276
|
|
|
530
277
|
*/
|
|
531
278
|
|
|
532
279
|
item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
533
280
|
|
|
534
281
|
/**
|
|
535
|
-
* @description
|
|
536
|
-
Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive.
|
|
537
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
538
|
-
|
|
539
|
-
**Example →** *cancel_reason_code\[is\] = "Not Paid"*
|
|
282
|
+
* @description Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation**. Must be passed if set as mandatory in the app. The codes are case-sensitive
|
|
540
283
|
|
|
541
284
|
*/
|
|
542
285
|
|
|
543
286
|
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
544
|
-
|
|
545
|
-
/**
|
|
546
|
-
* @description Parameters for subscription
|
|
547
|
-
|
|
548
|
-
*/
|
|
549
|
-
|
|
550
|
-
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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
551
287
|
}
|
|
552
288
|
export interface InvoicesResponse {
|
|
553
289
|
export:Export;
|
|
554
290
|
}
|
|
555
291
|
export interface InvoicesInputParam {
|
|
556
292
|
|
|
557
|
-
|
|
558
|
-
* @description optional, string filter
|
|
559
|
-
Payment owner of an invoice.
|
|
560
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
561
|
-
|
|
562
|
-
**Example →** *payment_owner\[is\] = "payment_customer"*
|
|
563
|
-
|
|
564
|
-
*/
|
|
565
|
-
|
|
566
|
-
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
293
|
+
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?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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' | 'exhausted' | 'stopped' | 'success',is_not?:'in_progress' | 'exhausted' | 'stopped' | 'success',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?:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending',is_not?:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending',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}};
|
|
567
294
|
|
|
568
295
|
/**
|
|
569
|
-
* @description
|
|
296
|
+
* @description Payment owner of an invoice
|
|
570
297
|
|
|
571
298
|
*/
|
|
572
299
|
|
|
573
|
-
|
|
300
|
+
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
574
301
|
}
|
|
575
302
|
export interface CreditNotesResponse {
|
|
576
303
|
export:Export;
|
|
577
304
|
}
|
|
578
305
|
export interface CreditNotesInputParam {
|
|
579
306
|
|
|
580
|
-
|
|
581
|
-
* @description Parameters for credit_note
|
|
582
|
-
|
|
583
|
-
*/
|
|
584
|
-
|
|
585
|
-
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}};
|
|
307
|
+
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?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'write_off' | 'subscription_change' | 'subscription_cancellation' | 'subscription_pause' | 'chargeback' | 'product_unsatisfactory' | 'service_unsatisfactory' | 'order_change' | 'order_cancellation' | 'waiver' | 'other' | 'fraudulent',is_not?:'write_off' | 'subscription_change' | 'subscription_cancellation' | 'subscription_pause' | 'chargeback' | 'product_unsatisfactory' | 'service_unsatisfactory' | 'order_change' | 'order_cancellation' | 'waiver' | 'other' | 'fraudulent',not_in?:string},reference_invoice_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},status?:{in?:string,is?:'adjusted' | 'refunded' | 'refund_due' | 'voided',is_not?:'adjusted' | 'refunded' | 'refund_due' | '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' | 'store',is_not?:'adjustment' | 'refundable' | 'store',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string},voided_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
586
308
|
}
|
|
587
309
|
export interface TransactionsResponse {
|
|
588
310
|
export:Export;
|
|
589
311
|
}
|
|
590
312
|
export interface TransactionsInputParam {
|
|
591
313
|
|
|
592
|
-
|
|
593
|
-
* @description Parameters for transaction
|
|
594
|
-
|
|
595
|
-
*/
|
|
596
|
-
|
|
597
|
-
transaction?:{amount?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_capturable?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},gateway?:{in?:string,is?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',not_in?:string},gateway_account_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id_at_gateway?:{is?:string,is_not?:string,starts_with?:string},payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'klarna_pay_now' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',not_in?:string},payment_source_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},reference_number?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},status?:{in?:string,is?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',is_not?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},type?:{in?:string,is?:'authorization' | 'payment_reversal' | 'payment' | 'refund',is_not?:'authorization' | 'payment_reversal' | 'payment' | 'refund',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
314
|
+
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?:'chargebee' | 'chargebee_payments' | 'adyen' | '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' | 'gocardless' | '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' | 'solidgate' | 'paystack' | 'jp_morgan' | 'not_applicable',is_not?:'chargebee' | 'chargebee_payments' | 'adyen' | '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' | 'gocardless' | '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' | 'solidgate' | 'paystack' | 'jp_morgan' | 'not_applicable',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?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',is_not?:'card' | 'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'other' | 'upi' | 'netbanking_emandates' | 'custom' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',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' | 'voided' | 'failure' | 'timeout' | 'needs_attention' | 'late_failure',is_not?:'in_progress' | 'success' | 'voided' | 'failure' | 'timeout' | 'needs_attention' | 'late_failure',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' | 'refund' | 'payment_reversal',is_not?:'authorization' | 'payment' | 'refund' | 'payment_reversal',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
598
315
|
}
|
|
599
316
|
export interface OrdersResponse {
|
|
600
317
|
export:Export;
|
|
601
318
|
}
|
|
602
319
|
export interface OrdersInputParam {
|
|
603
320
|
|
|
604
|
-
|
|
605
|
-
* @description optional, in cents filter
|
|
606
|
-
Total amount charged for the order.
|
|
607
|
-
**Supported operators :** is, is_not, lt, lte, gt, gte, between
|
|
608
|
-
|
|
609
|
-
**Example →** *total\[is\] = "1394532759"*
|
|
610
|
-
|
|
611
|
-
*/
|
|
612
|
-
|
|
613
|
-
total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
|
|
321
|
+
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' | 'processing' | 'complete' | 'cancelled' | 'voided' | 'queued' | 'awaiting_shipment' | 'on_hold' | 'delivered' | 'shipped' | 'partially_delivered' | 'returned',is_not?:'new' | 'processing' | 'complete' | 'cancelled' | 'voided' | 'queued' | 'awaiting_shipment' | 'on_hold' | 'delivered' | 'shipped' | 'partially_delivered' | '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}};
|
|
614
322
|
|
|
615
323
|
/**
|
|
616
|
-
* @description
|
|
324
|
+
* @description Total amount charged for the order.
|
|
617
325
|
|
|
618
326
|
*/
|
|
619
327
|
|
|
620
|
-
|
|
328
|
+
total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
|
|
621
329
|
}
|
|
622
330
|
export interface ItemFamiliesResponse {
|
|
623
331
|
export:Export;
|
|
624
332
|
}
|
|
625
333
|
export interface ItemFamiliesInputParam {
|
|
626
334
|
|
|
335
|
+
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}};
|
|
336
|
+
|
|
627
337
|
/**
|
|
628
|
-
* @description
|
|
338
|
+
* @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.
|
|
339
|
+
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.
|
|
340
|
+
**Note**
|
|
341
|
+
|
|
342
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
629
343
|
|
|
630
344
|
*/
|
|
631
345
|
|
|
632
|
-
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}};
|
|
633
|
-
|
|
634
346
|
business_entity_id?:{is?:string,is_present?:'true' | 'false'};
|
|
635
347
|
|
|
636
348
|
include_site_level_resources?:{is?:'true' | 'false'};
|
|
@@ -640,13 +352,17 @@ Total amount charged for the order.
|
|
|
640
352
|
}
|
|
641
353
|
export interface ItemsInputParam {
|
|
642
354
|
|
|
355
|
+
item?:{channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'active' | 'archived' | 'deleted',is_not?:'active' | 'archived' | 'deleted',not_in?:string},type?:{in?:string,is?:'plan' | 'addon' | 'charge',is_not?:'plan' | 'addon' | 'charge',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string},usage_calculation?:{in?:string,is?:'sum_of_usages' | 'last_usage' | 'max_usage',is_not?:'sum_of_usages' | 'last_usage' | 'max_usage',not_in?:string}};
|
|
356
|
+
|
|
643
357
|
/**
|
|
644
|
-
* @description
|
|
358
|
+
* @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.
|
|
359
|
+
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.
|
|
360
|
+
**Note**
|
|
361
|
+
|
|
362
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
645
363
|
|
|
646
364
|
*/
|
|
647
365
|
|
|
648
|
-
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}};
|
|
649
|
-
|
|
650
366
|
business_entity_id?:{is?:string,is_present?:'true' | 'false'};
|
|
651
367
|
|
|
652
368
|
include_site_level_resources?:{is?:'true' | 'false'};
|
|
@@ -656,46 +372,38 @@ Total amount charged for the order.
|
|
|
656
372
|
}
|
|
657
373
|
export interface ItemPricesInputParam {
|
|
658
374
|
|
|
375
|
+
item_price?:{channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | '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?:'day' | 'week' | 'month' | 'year',is_not?:'day' | 'week' | 'month' | 'year',not_in?:string},price_variant_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},pricing_model?:{in?:string,is?:'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep',is_not?:'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep',not_in?:string},status?:{in?:string,is?:'active' | 'archived' | 'deleted',is_not?:'active' | 'archived' | 'deleted',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?:'day' | 'month',is_not?:'day' | 'month',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
376
|
+
|
|
659
377
|
/**
|
|
660
|
-
* @description
|
|
661
|
-
Filter item prices based on `item_family_id`.
|
|
662
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
663
|
-
|
|
664
|
-
**Example →** *item_family_id\[is\] = "Acme"*
|
|
378
|
+
* @description Filter item prices based on `item_family_id`.
|
|
665
379
|
|
|
666
380
|
*/
|
|
667
381
|
|
|
668
382
|
item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
669
383
|
|
|
670
384
|
/**
|
|
671
|
-
* @description
|
|
672
|
-
Filter item prices based on `item_type`. Possible values are : plan, addon, charge.
|
|
673
|
-
**Supported operators :** is, is_not, in, not_in
|
|
674
|
-
|
|
675
|
-
**Example →** *item_type\[is_not\] = "plan"*
|
|
385
|
+
* @description Filter item prices based on `item_type`.
|
|
676
386
|
|
|
677
387
|
*/
|
|
678
388
|
|
|
679
|
-
item_type?:{in?:string,is?:'
|
|
389
|
+
item_type?:{in?:string,is?:'plan' | 'addon' | 'charge',is_not?:'plan' | 'addon' | 'charge',not_in?:string};
|
|
680
390
|
|
|
681
391
|
/**
|
|
682
|
-
* @description
|
|
683
|
-
Filter item prices based on their `currency_code`.
|
|
684
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
685
|
-
|
|
686
|
-
**Example →** *currency_code\[is\] = "USD"*
|
|
392
|
+
* @description Filter item prices based on their `currency_code`.
|
|
687
393
|
|
|
688
394
|
*/
|
|
689
395
|
|
|
690
396
|
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
691
397
|
|
|
692
398
|
/**
|
|
693
|
-
* @description
|
|
399
|
+
* @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.
|
|
400
|
+
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.
|
|
401
|
+
**Note**
|
|
402
|
+
|
|
403
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
694
404
|
|
|
695
405
|
*/
|
|
696
406
|
|
|
697
|
-
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}};
|
|
698
|
-
|
|
699
407
|
business_entity_id?:{is?:string,is_present?:'true' | 'false'};
|
|
700
408
|
|
|
701
409
|
include_site_level_resources?:{is?:'true' | 'false'};
|
|
@@ -705,46 +413,28 @@ Filter item prices based on their `currency_code`.
|
|
|
705
413
|
}
|
|
706
414
|
export interface AttachedItemsInputParam {
|
|
707
415
|
|
|
708
|
-
|
|
709
|
-
* @description optional, enumerated string filter
|
|
710
|
-
To filter based on the type of of the attached item. Possible values are : `addon`, `charge`. Possible values are : plan, addon, charge.
|
|
711
|
-
**Supported operators :** is, is_not, in, not_in
|
|
712
|
-
|
|
713
|
-
**Example →** *item_type\[is_not\] = "plan"*
|
|
714
|
-
|
|
715
|
-
*/
|
|
716
|
-
|
|
717
|
-
item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
|
|
416
|
+
attached_item?:{charge_on_event?:{in?:string,is?:'subscription_creation' | 'subscription_trial_start' | 'plan_activation' | 'subscription_activation' | 'contract_termination' | 'on_demand',is_not?:'subscription_creation' | 'subscription_trial_start' | 'plan_activation' | 'subscription_activation' | 'contract_termination' | '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?:'recommended' | 'mandatory' | 'optional',is_not?:'recommended' | 'mandatory' | 'optional',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
718
417
|
|
|
719
418
|
/**
|
|
720
|
-
* @description
|
|
419
|
+
* @description To filter based on the type of of the attached item. Possible values are : `addon`, `charge`.
|
|
721
420
|
|
|
722
421
|
*/
|
|
723
422
|
|
|
724
|
-
|
|
423
|
+
item_type?:{in?:string,is?:'plan' | 'addon' | 'charge',is_not?:'plan' | 'addon' | 'charge',not_in?:string};
|
|
725
424
|
}
|
|
726
425
|
export interface DifferentialPricesResponse {
|
|
727
426
|
export:Export;
|
|
728
427
|
}
|
|
729
428
|
export interface DifferentialPricesInputParam {
|
|
730
429
|
|
|
731
|
-
|
|
732
|
-
* @description optional, string filter
|
|
733
|
-
Item Id of Addon / Charge item price for which differential pricing is applied to.
|
|
734
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
735
|
-
|
|
736
|
-
**Example →** *item_id\[is\] = "day-pass"*
|
|
737
|
-
|
|
738
|
-
*/
|
|
739
|
-
|
|
740
|
-
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
430
|
+
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}};
|
|
741
431
|
|
|
742
432
|
/**
|
|
743
|
-
* @description
|
|
433
|
+
* @description Item Id of Addon / Charge item price for which differential pricing is applied to
|
|
744
434
|
|
|
745
435
|
*/
|
|
746
436
|
|
|
747
|
-
|
|
437
|
+
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
748
438
|
}
|
|
749
439
|
export interface PriceVariantsResponse {
|
|
750
440
|
export:Export;
|
|
@@ -752,31 +442,25 @@ Item Id of Addon / Charge item price for which differential pricing is applied t
|
|
|
752
442
|
export interface PriceVariantsInputParam {
|
|
753
443
|
|
|
754
444
|
price_variant?:{created_at?:{after?:string,before?:string,between?:string,on?: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?:'active' | 'archived',is_not?:'active' | 'archived',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
755
|
-
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* @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.
|
|
448
|
+
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.
|
|
449
|
+
**Note**
|
|
450
|
+
|
|
451
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
452
|
+
|
|
453
|
+
*/
|
|
454
|
+
|
|
756
455
|
business_entity_id?:{is?:string,is_present?:'true' | 'false'};
|
|
757
456
|
|
|
758
457
|
include_site_level_resources?:{is?:'true' | 'false'};
|
|
759
458
|
}
|
|
760
459
|
export interface Download {
|
|
761
|
-
/**
|
|
762
|
-
* @description The URL at which the file is available for download.
|
|
763
|
-
|
|
764
|
-
*/
|
|
765
|
-
|
|
766
460
|
download_url:string;
|
|
767
461
|
|
|
768
|
-
/**
|
|
769
|
-
* @description The time until which the `download_url` is valid.
|
|
770
|
-
|
|
771
|
-
*/
|
|
772
|
-
|
|
773
462
|
valid_till:number;
|
|
774
463
|
|
|
775
|
-
/**
|
|
776
|
-
* @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
|
|
777
|
-
|
|
778
|
-
*/
|
|
779
|
-
|
|
780
464
|
mime_type?:string;
|
|
781
465
|
}
|
|
782
466
|
}
|