chargebee 2.32.0 → 2.33.1
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 +29 -15
- package/package.json +1 -1
- package/types/core.d.ts +1 -1
- package/types/index.d.ts +1 -0
- package/types/resources/CreditNote.d.ts +9 -9
- package/types/resources/CreditNoteEstimate.d.ts +27 -19
- package/types/resources/Entitlement.d.ts +102 -5
- package/types/resources/Estimate.d.ts +25 -15
- package/types/resources/Event.d.ts +2 -0
- package/types/resources/GatewayErrorDetail.d.ts +76 -0
- package/types/resources/ImpactedSubscription.d.ts +7 -7
- package/types/resources/Invoice.d.ts +2 -2
- package/types/resources/InvoiceEstimate.d.ts +3 -1
- package/types/resources/ItemEntitlement.d.ts +50 -12
- package/types/resources/ItemPrice.d.ts +21 -3
- package/types/resources/NonSubscription.d.ts +30 -0
- package/types/resources/PaymentIntent.d.ts +13 -5
- package/types/resources/PaymentVoucher.d.ts +3 -3
- package/types/resources/PortalSession.d.ts +5 -5
- package/types/resources/Purchase.d.ts +7 -7
- package/types/resources/Quote.d.ts +1 -1
- package/types/resources/QuoteLineGroup.d.ts +1 -1
- package/types/resources/QuotedCharge.d.ts +12 -12
- package/types/resources/QuotedSubscription.d.ts +27 -20
- package/types/resources/Subscription.d.ts +7 -0
- package/types/resources/Transaction.d.ts +80 -2
- package/types/resources/Usage.d.ts +2 -2
|
@@ -80,7 +80,7 @@ The response contains one or more of the following objects:
|
|
|
80
80
|
|
|
81
81
|
*/
|
|
82
82
|
|
|
83
|
-
create_sub_item_estimate(input
|
|
83
|
+
create_sub_item_estimate(input:CreateSubItemEstimateInputParam):ChargebeeRequest<CreateSubItemEstimateResponse>;
|
|
84
84
|
|
|
85
85
|
/**
|
|
86
86
|
* @description Generates an estimate without creating a subscription. This endpoint can be called when you want to preview details of a new subscription before actually creating one.
|
|
@@ -90,7 +90,7 @@ The response contains one or more of the following objects:
|
|
|
90
90
|
|
|
91
91
|
*/
|
|
92
92
|
|
|
93
|
-
create_sub_item_for_customer_estimate(customer_id:string, input
|
|
93
|
+
create_sub_item_for_customer_estimate(customer_id:string, input:CreateSubItemForCustomerEstimateInputParam):ChargebeeRequest<CreateSubItemForCustomerEstimateResponse>;
|
|
94
94
|
|
|
95
95
|
/**
|
|
96
96
|
* @description Returns an estimate for updating a subscription.
|
|
@@ -109,7 +109,7 @@ In the response,
|
|
|
109
109
|
|
|
110
110
|
*/
|
|
111
111
|
|
|
112
|
-
update_subscription_for_items(input
|
|
112
|
+
update_subscription_for_items(input:UpdateSubscriptionForItemsInputParam):ChargebeeRequest<UpdateSubscriptionForItemsResponse>;
|
|
113
113
|
|
|
114
114
|
/**
|
|
115
115
|
* @description This returns an estimate of the amount that will be charged when the subscription is billed next. The estimate is calculated based on the current recurring items of the subscription - plan, addons, and coupons.
|
|
@@ -237,14 +237,14 @@ In the response,
|
|
|
237
237
|
|
|
238
238
|
*/
|
|
239
239
|
|
|
240
|
-
gift_subscription_for_items(input
|
|
240
|
+
gift_subscription_for_items(input:GiftSubscriptionForItemsInputParam):ChargebeeRequest<GiftSubscriptionForItemsResponse>;
|
|
241
241
|
|
|
242
242
|
/**
|
|
243
243
|
* @description This endpoint creates an invoice estimate for non-recurring items.
|
|
244
244
|
|
|
245
245
|
*/
|
|
246
246
|
|
|
247
|
-
create_invoice_for_items(input
|
|
247
|
+
create_invoice_for_items(input:CreateInvoiceForItemsInputParam):ChargebeeRequest<CreateInvoiceForItemsResponse>;
|
|
248
248
|
}
|
|
249
249
|
export interface CreateSubItemEstimateResponse {
|
|
250
250
|
estimate:Estimate;
|
|
@@ -348,14 +348,14 @@ In the response,
|
|
|
348
348
|
|
|
349
349
|
*/
|
|
350
350
|
|
|
351
|
-
subscription_items
|
|
351
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
352
352
|
|
|
353
353
|
/**
|
|
354
354
|
* @description Parameters for discounts
|
|
355
355
|
|
|
356
356
|
*/
|
|
357
357
|
|
|
358
|
-
discounts
|
|
358
|
+
discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
359
359
|
|
|
360
360
|
/**
|
|
361
361
|
* @description Parameters for item_tiers
|
|
@@ -440,6 +440,16 @@ In the response,
|
|
|
440
440
|
|
|
441
441
|
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
442
442
|
|
|
443
|
+
/**
|
|
444
|
+
* @description Generates an estimate without creating a subscription. This endpoint can be called when you want to preview details of a new subscription before actually creating one.
|
|
445
|
+
**See also**
|
|
446
|
+
|
|
447
|
+
* [Estimate a purchase](https://apidocs.chargebee.com/docs/api/purchases#estimates_for_purchase): an operation that estimates a `purchase` representing multiple subscriptions bought together by a customer.
|
|
448
|
+
|
|
449
|
+
*/
|
|
450
|
+
|
|
451
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
452
|
+
|
|
443
453
|
/**
|
|
444
454
|
* @description Parameters for contract_term
|
|
445
455
|
|
|
@@ -452,14 +462,14 @@ In the response,
|
|
|
452
462
|
|
|
453
463
|
*/
|
|
454
464
|
|
|
455
|
-
subscription_items
|
|
465
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
456
466
|
|
|
457
467
|
/**
|
|
458
468
|
* @description Parameters for discounts
|
|
459
469
|
|
|
460
470
|
*/
|
|
461
471
|
|
|
462
|
-
discounts
|
|
472
|
+
discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
463
473
|
|
|
464
474
|
/**
|
|
465
475
|
* @description Parameters for item_tiers
|
|
@@ -617,7 +627,7 @@ An immediate previous change was made
|
|
|
617
627
|
|
|
618
628
|
*/
|
|
619
629
|
|
|
620
|
-
subscription
|
|
630
|
+
subscription:{auto_collection?:AutoCollection,free_period?:number,free_period_unit?:FreePeriodUnit,id:string,offline_payment_method?:OfflinePaymentMethod,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
621
631
|
|
|
622
632
|
/**
|
|
623
633
|
* @description Parameters for billing_address
|
|
@@ -645,14 +655,14 @@ An immediate previous change was made
|
|
|
645
655
|
|
|
646
656
|
*/
|
|
647
657
|
|
|
648
|
-
subscription_items
|
|
658
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
649
659
|
|
|
650
660
|
/**
|
|
651
661
|
* @description Parameters for discounts
|
|
652
662
|
|
|
653
663
|
*/
|
|
654
664
|
|
|
655
|
-
discounts
|
|
665
|
+
discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
656
666
|
|
|
657
667
|
/**
|
|
658
668
|
* @description Parameters for item_tiers
|
|
@@ -1051,14 +1061,14 @@ If `no_action` is chosen, charges are added to the resumption invoice.
|
|
|
1051
1061
|
|
|
1052
1062
|
*/
|
|
1053
1063
|
|
|
1054
|
-
gifter
|
|
1064
|
+
gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
|
|
1055
1065
|
|
|
1056
1066
|
/**
|
|
1057
1067
|
* @description Parameters for gift_receiver
|
|
1058
1068
|
|
|
1059
1069
|
*/
|
|
1060
1070
|
|
|
1061
|
-
gift_receiver
|
|
1071
|
+
gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
|
|
1062
1072
|
|
|
1063
1073
|
/**
|
|
1064
1074
|
* @description Parameters for payment_intent
|
|
@@ -1189,7 +1199,7 @@ If `no_action` is chosen, charges are added to the resumption invoice.
|
|
|
1189
1199
|
|
|
1190
1200
|
*/
|
|
1191
1201
|
|
|
1192
|
-
discounts
|
|
1202
|
+
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
1193
1203
|
}
|
|
1194
1204
|
|
|
1195
1205
|
}
|
|
@@ -56,6 +56,8 @@ declare module 'chargebee' {
|
|
|
56
56
|
|
|
57
57
|
content:object;
|
|
58
58
|
|
|
59
|
+
origin_user?:string;
|
|
60
|
+
|
|
59
61
|
/**
|
|
60
62
|
* @description Array of webhook call statuses: one for each of the webhooks configured for the site. This object is only available after the first webhook call for the event has completed or timed out. Also, creation/updation of the `webhook` object data is a queued operation and hence there can be an additional delay of up to 5 seconds.
|
|
61
63
|
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
declare module 'chargebee' {
|
|
3
|
+
export interface GatewayErrorDetail {
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* @description This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway
|
|
7
|
+
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
request_id?:string;
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* @description This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more
|
|
14
|
+
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
error_category?:string;
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* @description A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services
|
|
21
|
+
|
|
22
|
+
*/
|
|
23
|
+
|
|
24
|
+
error_code?:string;
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* @description A message provided by the gateway that describes the nature of the error encountered
|
|
28
|
+
|
|
29
|
+
*/
|
|
30
|
+
|
|
31
|
+
error_message?:string;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* @description When a transaction is declined, this code is provided by the gateway to specify the reason for the decline
|
|
35
|
+
|
|
36
|
+
*/
|
|
37
|
+
|
|
38
|
+
decline_code?:string;
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* @description This message gives a descriptive explanation of the reason for the transaction's decline
|
|
42
|
+
|
|
43
|
+
*/
|
|
44
|
+
|
|
45
|
+
decline_message?:string;
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* @description This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network's error-handling system
|
|
49
|
+
|
|
50
|
+
*/
|
|
51
|
+
|
|
52
|
+
network_error_code?:string;
|
|
53
|
+
|
|
54
|
+
network_error_message?:string;
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* @description This parameter indicates which specific data field or attribute in the request caused the error
|
|
58
|
+
|
|
59
|
+
*/
|
|
60
|
+
|
|
61
|
+
error_field?:string;
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* @description After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue
|
|
65
|
+
|
|
66
|
+
*/
|
|
67
|
+
|
|
68
|
+
recommendation_code?:string;
|
|
69
|
+
|
|
70
|
+
recommendation_message?:string;
|
|
71
|
+
|
|
72
|
+
processor_error_code?:string;
|
|
73
|
+
|
|
74
|
+
processor_error_message?:string;
|
|
75
|
+
}
|
|
76
|
+
}
|
|
@@ -3,21 +3,21 @@ declare module 'chargebee' {
|
|
|
3
3
|
export interface ImpactedSubscription {
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
* @description The total
|
|
6
|
+
* @description The total count of affected subscriptions.
|
|
7
7
|
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
count?:number;
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
|
-
* @description The
|
|
13
|
+
* @description The impacted subscription IDs. This list contains up to 1,000 IDs. The complete list of subscription IDs is in the `download` resource, which can store up to 100,000 IDs.
|
|
14
14
|
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
17
|
subscription_ids?:any[];
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
* @description
|
|
20
|
+
* @description This [download](downloads) resource contains the impacted subscription IDs. These IDs are in a JSON array in the file at `download.url` until `download.valid_till`. The file at this URL stores up to 100,000 subscription IDs. [Contact Support](https://support.chargebee.com/support/home) to increase this limit for your Chargebee site.
|
|
21
21
|
|
|
22
22
|
*/
|
|
23
23
|
|
|
@@ -28,18 +28,18 @@ declare module 'chargebee' {
|
|
|
28
28
|
|
|
29
29
|
export interface Download {
|
|
30
30
|
/**
|
|
31
|
-
* @description The URL
|
|
31
|
+
* @description The download URL for the file.
|
|
32
32
|
|
|
33
33
|
*/
|
|
34
34
|
|
|
35
|
-
download_url
|
|
35
|
+
download_url:string;
|
|
36
36
|
|
|
37
37
|
/**
|
|
38
|
-
* @description The time
|
|
38
|
+
* @description The expiration time for the `download_url`.
|
|
39
39
|
|
|
40
40
|
*/
|
|
41
41
|
|
|
42
|
-
valid_till
|
|
42
|
+
valid_till:number;
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
45
|
* @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
|
|
@@ -1234,7 +1234,7 @@ The [invoice](/docs/api/invoices?prod_cat_ver=1#invoice_status) is yet to b
|
|
|
1234
1234
|
|
|
1235
1235
|
*/
|
|
1236
1236
|
|
|
1237
|
-
transactions?:{id?:string}[];
|
|
1237
|
+
transactions?:{amount?:number,id?:string}[];
|
|
1238
1238
|
}
|
|
1239
1239
|
export interface SyncUsagesResponse {
|
|
1240
1240
|
invoice:Invoice;
|
|
@@ -2147,7 +2147,7 @@ For metered line items, this value is updated from [usages](https://apidocs.char
|
|
|
2147
2147
|
|
|
2148
2148
|
*/
|
|
2149
2149
|
|
|
2150
|
-
tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
|
|
2150
|
+
tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'tax_not_configured_external_provider' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
|
|
2151
2151
|
|
|
2152
2152
|
/**
|
|
2153
2153
|
* @description The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
|
|
@@ -69,6 +69,8 @@ declare module 'chargebee' {
|
|
|
69
69
|
discount_amount?:number;
|
|
70
70
|
|
|
71
71
|
item_level_discount_amount?:number;
|
|
72
|
+
|
|
73
|
+
usage_percentage?:string;
|
|
72
74
|
|
|
73
75
|
reference_line_item_id?:string;
|
|
74
76
|
|
|
@@ -78,7 +80,7 @@ declare module 'chargebee' {
|
|
|
78
80
|
|
|
79
81
|
entity_type:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc';
|
|
80
82
|
|
|
81
|
-
tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
|
|
83
|
+
tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'tax_not_configured_external_provider' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
|
|
82
84
|
|
|
83
85
|
entity_id?:string;
|
|
84
86
|
|
|
@@ -70,28 +70,42 @@ declare module 'chargebee' {
|
|
|
70
70
|
export namespace ItemEntitlement {
|
|
71
71
|
export class ItemEntitlementResource {
|
|
72
72
|
/**
|
|
73
|
-
* @description
|
|
73
|
+
* @description **Deprecated**
|
|
74
|
+
|
|
75
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
76
|
+
Retrieves a list of all the `item_entitlements` for the `item` specified.
|
|
74
77
|
|
|
75
78
|
*/
|
|
76
79
|
|
|
77
80
|
item_entitlements_for_item(item_id:string, input?:ItemEntitlementsForItemInputParam):ChargebeeRequest<ItemEntitlementsForItemResponse>;
|
|
78
81
|
|
|
79
82
|
/**
|
|
80
|
-
* @description
|
|
83
|
+
* @description **Deprecated**
|
|
84
|
+
|
|
85
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
86
|
+
Retrieves a list of all the `item_entitlement`s for the `feature` specified.
|
|
81
87
|
|
|
82
88
|
*/
|
|
83
89
|
|
|
84
90
|
item_entitlements_for_feature(feature_id:string, input?:ItemEntitlementsForFeatureInputParam):ChargebeeRequest<ItemEntitlementsForFeatureResponse>;
|
|
85
91
|
|
|
86
92
|
/**
|
|
87
|
-
* @description
|
|
93
|
+
* @description **Deprecated**
|
|
94
|
+
|
|
95
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [Manage entitlements](entitlements?prod_cat_ver=2#upsert_or_remove_entitlements_for_a_feature).
|
|
96
|
+
|
|
97
|
+
Upserts or removes a set of `item_entitlement`s for an `feature` depending on the `action` specified. The API returns the upserted or deleted `item_entitlements` after successfully completing the operation. The operation returns an error when the first `item_entitlement` fails to be processed. Either all the `item_entitlement`s provided in the request are processed or none.
|
|
88
98
|
|
|
89
99
|
*/
|
|
90
100
|
|
|
91
101
|
add_item_entitlements(feature_id:string, input:AddItemEntitlementsInputParam):ChargebeeRequest<AddItemEntitlementsResponse>;
|
|
92
102
|
|
|
93
103
|
/**
|
|
94
|
-
* @description
|
|
104
|
+
* @description **Deprecated**
|
|
105
|
+
|
|
106
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [Manage entitlements](entitlements?prod_cat_ver=2#upsert_or_remove_entitlements_for_a_feature).
|
|
107
|
+
|
|
108
|
+
Upserts or removes a set of `item_entitlements` for an [item](items?prod_cat_ver=2) depending on the `action` specified. The API returns the upserted or deleted `item_entitlements` after successfully completing the operation. The operation returns an error when the first `item_entitlement` fails to be processed. Either all the `item_entitlement`s provided in the request are processed or none.
|
|
95
109
|
|
|
96
110
|
*/
|
|
97
111
|
|
|
@@ -99,14 +113,20 @@ declare module 'chargebee' {
|
|
|
99
113
|
}
|
|
100
114
|
export interface ItemEntitlementsForItemResponse {
|
|
101
115
|
/**
|
|
102
|
-
* @description
|
|
116
|
+
* @description **Deprecated**
|
|
117
|
+
|
|
118
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
119
|
+
Retrieves a list of all the `item_entitlements` for the `item` specified.
|
|
103
120
|
|
|
104
121
|
*/
|
|
105
122
|
|
|
106
123
|
list:{item_entitlement:ItemEntitlement}[];
|
|
107
124
|
|
|
108
125
|
/**
|
|
109
|
-
* @description
|
|
126
|
+
* @description **Deprecated**
|
|
127
|
+
|
|
128
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
129
|
+
Retrieves a list of all the `item_entitlements` for the `item` specified.
|
|
110
130
|
|
|
111
131
|
*/
|
|
112
132
|
|
|
@@ -115,14 +135,20 @@ declare module 'chargebee' {
|
|
|
115
135
|
export interface ItemEntitlementsForItemInputParam {
|
|
116
136
|
[key : string]: any;
|
|
117
137
|
/**
|
|
118
|
-
* @description
|
|
138
|
+
* @description **Deprecated**
|
|
139
|
+
|
|
140
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
141
|
+
Retrieves a list of all the `item_entitlements` for the `item` specified.
|
|
119
142
|
|
|
120
143
|
*/
|
|
121
144
|
|
|
122
145
|
limit?:number;
|
|
123
146
|
|
|
124
147
|
/**
|
|
125
|
-
* @description
|
|
148
|
+
* @description **Deprecated**
|
|
149
|
+
|
|
150
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
151
|
+
Retrieves a list of all the `item_entitlements` for the `item` specified.
|
|
126
152
|
|
|
127
153
|
*/
|
|
128
154
|
|
|
@@ -130,14 +156,20 @@ declare module 'chargebee' {
|
|
|
130
156
|
}
|
|
131
157
|
export interface ItemEntitlementsForFeatureResponse {
|
|
132
158
|
/**
|
|
133
|
-
* @description
|
|
159
|
+
* @description **Deprecated**
|
|
160
|
+
|
|
161
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
162
|
+
Retrieves a list of all the `item_entitlement`s for the `feature` specified.
|
|
134
163
|
|
|
135
164
|
*/
|
|
136
165
|
|
|
137
166
|
list:{item_entitlement:ItemEntitlement}[];
|
|
138
167
|
|
|
139
168
|
/**
|
|
140
|
-
* @description
|
|
169
|
+
* @description **Deprecated**
|
|
170
|
+
|
|
171
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
172
|
+
Retrieves a list of all the `item_entitlement`s for the `feature` specified.
|
|
141
173
|
|
|
142
174
|
*/
|
|
143
175
|
|
|
@@ -146,14 +178,20 @@ declare module 'chargebee' {
|
|
|
146
178
|
export interface ItemEntitlementsForFeatureInputParam {
|
|
147
179
|
[key : string]: any;
|
|
148
180
|
/**
|
|
149
|
-
* @description
|
|
181
|
+
* @description **Deprecated**
|
|
182
|
+
|
|
183
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
184
|
+
Retrieves a list of all the `item_entitlement`s for the `feature` specified.
|
|
150
185
|
|
|
151
186
|
*/
|
|
152
187
|
|
|
153
188
|
limit?:number;
|
|
154
189
|
|
|
155
190
|
/**
|
|
156
|
-
* @description
|
|
191
|
+
* @description **Deprecated**
|
|
192
|
+
|
|
193
|
+
This endpoint remains operational, but we recommend transitioning to its successor: [List entitlements](entitlements?prod_cat_ver=2#list_all_entitlements).
|
|
194
|
+
Retrieves a list of all the `item_entitlement`s for the `feature` specified.
|
|
157
195
|
|
|
158
196
|
*/
|
|
159
197
|
|
|
@@ -61,7 +61,13 @@ If your input contains characters that are subjected to sanitization (like incom
|
|
|
61
61
|
external_name?:string;
|
|
62
62
|
|
|
63
63
|
/**
|
|
64
|
-
* @description
|
|
64
|
+
* @description **Note**
|
|
65
|
+
|
|
66
|
+
Applicable only for item prices with:
|
|
67
|
+
|
|
68
|
+
* [item_type](item_prices#item_price_item_type) = `addon`.
|
|
69
|
+
* [pricing_model](item_prices#item_price_pricing_model) = `per_unit`.
|
|
70
|
+
Specifies how to manage charges or credits for the addon item price during a [subscription update](subscriptions?prod_cat_ver=2#update_subscription_for_items) or [estimating](estimates?prod_cat_ver=2#estimate_for_updating_a_subscription) a subscription update. \* full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration. \* site_default - Use the [site-wide proration setting](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change). \* partial_term - Prorate the charges or credits for the rest of the current term.
|
|
65
71
|
|
|
66
72
|
*/
|
|
67
73
|
|
|
@@ -381,7 +387,13 @@ If your input contains characters that are subjected to sanitization (like incom
|
|
|
381
387
|
invoice_notes?:string;
|
|
382
388
|
|
|
383
389
|
/**
|
|
384
|
-
* @description
|
|
390
|
+
* @description **Note**
|
|
391
|
+
|
|
392
|
+
Applicable only for item prices with:
|
|
393
|
+
|
|
394
|
+
* [item_type](item_prices#item_price_item_type) = `addon`.
|
|
395
|
+
* [pricing_model](item_prices#item_price_pricing_model) = `per_unit`.
|
|
396
|
+
Specifies how to manage charges or credits for the addon item price during a [subscription update](subscriptions?prod_cat_ver=2#update_subscription_for_items) or [estimating](estimates?prod_cat_ver=2#estimate_for_updating_a_subscription) a subscription update. \* full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration. \* site_default - Use the [site-wide proration setting](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change). \* partial_term - Prorate the charges or credits for the rest of the current term.
|
|
385
397
|
|
|
386
398
|
*/
|
|
387
399
|
|
|
@@ -584,7 +596,13 @@ If your input contains characters that are subjected to sanitization (like incom
|
|
|
584
596
|
description?:string;
|
|
585
597
|
|
|
586
598
|
/**
|
|
587
|
-
* @description
|
|
599
|
+
* @description **Note**
|
|
600
|
+
|
|
601
|
+
Applicable only for item prices with:
|
|
602
|
+
|
|
603
|
+
* [item_type](item_prices#item_price_item_type) = `addon`.
|
|
604
|
+
* [pricing_model](item_prices#item_price_pricing_model) = `per_unit`.
|
|
605
|
+
Specifies how to manage charges or credits for the addon item price during a [subscription update](subscriptions?prod_cat_ver=2#update_subscription_for_items) or [estimating](estimates?prod_cat_ver=2#estimate_for_updating_a_subscription) a subscription update. \* full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration. \* site_default - Use the [site-wide proration setting](https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change). \* partial_term - Prorate the charges or credits for the rest of the current term.
|
|
588
606
|
|
|
589
607
|
*/
|
|
590
608
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
declare module 'chargebee' {
|
|
3
|
+
export interface NonSubscription {
|
|
4
|
+
|
|
5
|
+
app_id:string;
|
|
6
|
+
|
|
7
|
+
invoice_id:string;
|
|
8
|
+
|
|
9
|
+
customer_id?:string;
|
|
10
|
+
|
|
11
|
+
charge_id:string;
|
|
12
|
+
}
|
|
13
|
+
export namespace NonSubscription {
|
|
14
|
+
export class NonSubscriptionResource {
|
|
15
|
+
process_receipt(non_subscription_app_id:string, input:ProcessReceiptInputParam):ChargebeeRequest<ProcessReceiptResponse>;
|
|
16
|
+
}
|
|
17
|
+
export interface ProcessReceiptResponse {
|
|
18
|
+
non_subscription:NonSubscription;
|
|
19
|
+
}
|
|
20
|
+
export interface ProcessReceiptInputParam {
|
|
21
|
+
|
|
22
|
+
receipt:string;
|
|
23
|
+
|
|
24
|
+
product:{currency_code:string,id:string,name?:string,price:number,price_in_decimal?:string,type:'non_consumable' | 'consumable' | 'non_renewing_subscription'};
|
|
25
|
+
|
|
26
|
+
customer?:{email?:string,first_name?:string,id?:string,last_name?:string};
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
}
|
|
30
|
+
}
|
|
@@ -52,7 +52,7 @@ declare module 'chargebee' {
|
|
|
52
52
|
reference_id?:string;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
* @description The payment method of this intent \* google_pay - google_pay \* apple_pay - apple_pay \* ideal - ideal \* bancontact - bancontact \* netbanking_emandates - netbanking_emandates \* dotpay - dotpay \* giropay - giropay \* sofort - sofort \* direct_debit - direct_debit \* paypal_express_checkout - paypal_express_checkout \* boleto - boleto \* card - card \* upi - upi
|
|
55
|
+
* @description The payment method of this intent \* google_pay - google_pay \* apple_pay - apple_pay \* ideal - ideal \* bancontact - bancontact \* netbanking_emandates - netbanking_emandates \* pay_to - PayTo \* venmo - Venmo \* dotpay - dotpay \* giropay - giropay \* sofort - sofort \* sepa_instant_transfer - SEPA Instant Transfer \* direct_debit - direct_debit \* paypal_express_checkout - paypal_express_checkout \* boleto - boleto \* faster_payments - Faster Payments \* amazon_payments - amazon_payments \* card - card \* upi - upi
|
|
56
56
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
@@ -306,10 +306,10 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
306
306
|
|
|
307
307
|
*/
|
|
308
308
|
|
|
309
|
-
status
|
|
309
|
+
status:'pending_authorization' | 'inited' | 'refused' | 'requires_challenge' | 'authorized' | 'requires_identification' | 'requires_redirection';
|
|
310
310
|
|
|
311
311
|
/**
|
|
312
|
-
* @description The payment method of this attempt \* ideal - ideal \* sofort - sofort \* paypal_express_checkout - paypal_express_checkout \* giropay - giropay \* bancontact - bancontact \* google_pay - google_pay \* card - card \* upi - upi \* direct_debit - direct_debit \* dotpay - dotpay \* apple_pay - apple_pay \* boleto - boleto \* netbanking_emandates - netbanking_emandates
|
|
312
|
+
* @description The payment method of this attempt \* venmo - Venmo \* ideal - ideal \* sofort - sofort \* paypal_express_checkout - paypal_express_checkout \* giropay - giropay \* sepa_instant_transfer - SEPA Instant Transfer \* bancontact - bancontact \* google_pay - google_pay \* card - card \* faster_payments - faster payments \* upi - upi \* amazon_payments - amazon_payments \* direct_debit - direct_debit \* dotpay - dotpay \* apple_pay - apple_pay \* boleto - boleto \* pay_to - PayTo \* netbanking_emandates - netbanking_emandates
|
|
313
313
|
|
|
314
314
|
*/
|
|
315
315
|
|
|
@@ -341,14 +341,22 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
341
341
|
|
|
342
342
|
*/
|
|
343
343
|
|
|
344
|
-
created_at
|
|
344
|
+
created_at:number;
|
|
345
345
|
|
|
346
346
|
/**
|
|
347
347
|
* @description Timestamp indicating when the active payment attempt was last modified.
|
|
348
348
|
|
|
349
349
|
*/
|
|
350
350
|
|
|
351
|
-
modified_at
|
|
351
|
+
modified_at:number;
|
|
352
|
+
|
|
353
|
+
/**
|
|
354
|
+
* @description Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about [gateway error references](gateway_error_references)
|
|
355
|
+
This attribute will be available soon
|
|
356
|
+
|
|
357
|
+
*/
|
|
358
|
+
|
|
359
|
+
error_detail?:GatewayErrorDetail;
|
|
352
360
|
}
|
|
353
361
|
}
|
|
354
362
|
}
|
|
@@ -74,7 +74,7 @@ declare module 'chargebee' {
|
|
|
74
74
|
|
|
75
75
|
/**
|
|
76
76
|
* @description The gateway through which this payment voucher was created.
|
|
77
|
-
**Note** : Note: Currently, `stripe` is the only supported gateway through which you can create the payment voucher. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway.
|
|
77
|
+
**Note** : Note: Currently, `stripe` is the only supported gateway through which you can create the payment voucher. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
|
|
78
78
|
|
|
79
79
|
*/
|
|
80
80
|
|
|
@@ -197,14 +197,14 @@ declare module 'chargebee' {
|
|
|
197
197
|
|
|
198
198
|
*/
|
|
199
199
|
|
|
200
|
-
voucher_payment_source
|
|
200
|
+
voucher_payment_source:{voucher_type:VoucherType};
|
|
201
201
|
|
|
202
202
|
/**
|
|
203
203
|
* @description Parameters for `invoice_allocations`
|
|
204
204
|
|
|
205
205
|
*/
|
|
206
206
|
|
|
207
|
-
invoice_allocations
|
|
207
|
+
invoice_allocations:{invoice_id:string}[];
|
|
208
208
|
}
|
|
209
209
|
export interface RetrieveResponse {
|
|
210
210
|
payment_voucher:PaymentVoucher;
|