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,239 +1,99 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface ItemEntitlement {
|
|
4
5
|
|
|
5
|
-
/**
|
|
6
|
-
* @description A unique identifier for the `item_entitlement`. This is auto-generated.
|
|
7
6
|
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
7
|
id:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description The `id` of the `item` to which this entitlement belongs.
|
|
14
8
|
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
9
|
item_id?:string;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description The `type` of the `item` to which this entitlement belongs. \* charge - Charge \* item - Item \* subscription - Subscription \* addon - Addon \* plan - Plan
|
|
21
10
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
item_type?:'item' | 'charge' | 'addon' | 'subscription' | 'plan';
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description The `id` of the feature towards which this entitlement has been granted.
|
|
11
|
+
item_type?:'plan' | 'addon' | 'charge' | 'subscription' | 'item';
|
|
28
12
|
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
13
|
feature_id?:string;
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* @description The `name` of the `feature` towards which this entitlement has been granted.
|
|
35
14
|
|
|
36
|
-
*/
|
|
37
|
-
|
|
38
15
|
feature_name?:string;
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* @description The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`:
|
|
42
16
|
|
|
43
|
-
* When `feature.type` is `quantity` and:
|
|
44
|
-
* If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.
|
|
45
|
-
* If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can also be:
|
|
46
|
-
* any one of `feature.levels[value][]`
|
|
47
|
-
* or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
|
|
48
|
-
* When `type` is `range` and:
|
|
49
|
-
* If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).
|
|
50
|
-
* If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:
|
|
51
|
-
* any whole number equal to or greater than `levels[value][0]`
|
|
52
|
-
* or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
|
|
53
|
-
* When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.
|
|
54
|
-
* When `type` is `switch`, then the value is set as `available` or `true`.
|
|
55
|
-
|
|
56
|
-
*/
|
|
57
|
-
|
|
58
17
|
value?:string;
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* @description The display name for the entitlement level. The default values are auto-generated based on `feature.type` as follows:
|
|
62
18
|
|
|
63
|
-
* When `feature.type` is `quantity` or `range`, then `name` is the space-separated concatenation of `value` and the pluralized version of `feature.unit`. For example, if `value` is `20` and `feature.unit` is `user`, then `name` becomes `20 users`.
|
|
64
|
-
* When `feature.type` is `custom`, then `name` is the same as `value`.a
|
|
65
|
-
|
|
66
|
-
*/
|
|
67
|
-
|
|
68
19
|
name?:string;
|
|
20
|
+
|
|
69
21
|
}
|
|
70
22
|
export namespace ItemEntitlement {
|
|
71
23
|
export class ItemEntitlementResource {
|
|
72
|
-
/**
|
|
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.
|
|
77
|
-
|
|
78
|
-
*/
|
|
79
|
-
|
|
80
24
|
item_entitlements_for_item(item_id:string, input?:ItemEntitlementsForItemInputParam):ChargebeeRequest<ItemEntitlementsForItemResponse>;
|
|
81
25
|
|
|
82
|
-
/**
|
|
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.
|
|
87
|
-
|
|
88
|
-
*/
|
|
89
|
-
|
|
90
26
|
item_entitlements_for_feature(feature_id:string, input?:ItemEntitlementsForFeatureInputParam):ChargebeeRequest<ItemEntitlementsForFeatureResponse>;
|
|
91
27
|
|
|
92
|
-
/**
|
|
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.
|
|
98
|
-
|
|
99
|
-
*/
|
|
100
|
-
|
|
101
28
|
add_item_entitlements(feature_id:string, input:AddItemEntitlementsInputParam):ChargebeeRequest<AddItemEntitlementsResponse>;
|
|
102
29
|
|
|
103
|
-
/**
|
|
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.
|
|
109
|
-
|
|
110
|
-
*/
|
|
111
|
-
|
|
112
30
|
upsert_or_remove_item_entitlements_for_item(item_id:string, input:UpsertOrRemoveItemEntitlementsForItemInputParam):ChargebeeRequest<UpsertOrRemoveItemEntitlementsForItemResponse>;
|
|
113
31
|
}
|
|
114
32
|
export interface ItemEntitlementsForItemResponse {
|
|
115
|
-
/**
|
|
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.
|
|
120
|
-
|
|
121
|
-
*/
|
|
122
|
-
|
|
123
33
|
list:{item_entitlement:ItemEntitlement}[];
|
|
124
34
|
|
|
125
|
-
/**
|
|
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.
|
|
130
|
-
|
|
131
|
-
*/
|
|
132
|
-
|
|
133
35
|
next_offset?:string;
|
|
134
36
|
}
|
|
135
37
|
export interface ItemEntitlementsForItemInputParam {
|
|
136
38
|
[key : string]: any;
|
|
137
39
|
/**
|
|
138
|
-
* @description
|
|
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.
|
|
40
|
+
* @description The number of resources to be returned.
|
|
142
41
|
|
|
143
42
|
*/
|
|
144
43
|
|
|
145
44
|
limit?:number;
|
|
146
45
|
|
|
147
46
|
/**
|
|
148
|
-
* @description
|
|
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.
|
|
47
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
|
|
152
48
|
|
|
153
49
|
*/
|
|
154
50
|
|
|
155
51
|
offset?:string;
|
|
52
|
+
|
|
53
|
+
include_drafts?:boolean;
|
|
54
|
+
|
|
55
|
+
embed?:string;
|
|
156
56
|
}
|
|
157
57
|
export interface ItemEntitlementsForFeatureResponse {
|
|
158
|
-
/**
|
|
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.
|
|
163
|
-
|
|
164
|
-
*/
|
|
165
|
-
|
|
166
58
|
list:{item_entitlement:ItemEntitlement}[];
|
|
167
59
|
|
|
168
|
-
/**
|
|
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.
|
|
173
|
-
|
|
174
|
-
*/
|
|
175
|
-
|
|
176
60
|
next_offset?:string;
|
|
177
61
|
}
|
|
178
62
|
export interface ItemEntitlementsForFeatureInputParam {
|
|
179
63
|
[key : string]: any;
|
|
180
64
|
/**
|
|
181
|
-
* @description
|
|
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.
|
|
65
|
+
* @description The number of resources to be returned.
|
|
185
66
|
|
|
186
67
|
*/
|
|
187
68
|
|
|
188
69
|
limit?:number;
|
|
189
70
|
|
|
190
71
|
/**
|
|
191
|
-
* @description
|
|
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.
|
|
72
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
|
|
195
73
|
|
|
196
74
|
*/
|
|
197
75
|
|
|
198
76
|
offset?:string;
|
|
77
|
+
|
|
78
|
+
include_drafts?:boolean;
|
|
199
79
|
}
|
|
200
80
|
export interface AddItemEntitlementsResponse {
|
|
201
81
|
item_entitlement:ItemEntitlement;
|
|
202
82
|
}
|
|
203
83
|
export interface AddItemEntitlementsInputParam {
|
|
204
84
|
|
|
205
|
-
|
|
206
|
-
* @description The specific action to be performed for each `item_entitlement` specified. \* remove - Deletes the `item_entitlement` for the `feature_id` and `item_id` combination, if it exists. \* upsert - If the `item_entitlement` already exists for the `feature_id` and `item_id` combination, the `value` of the `item_entitlement` is updated. If it doesn't exist, a new `item_entitelment` is created.
|
|
207
|
-
|
|
208
|
-
*/
|
|
85
|
+
item_entitlements:{item_id:string,item_type?:'plan' | 'addon' | 'charge' | 'subscription' | 'item',value?:string}[];
|
|
209
86
|
|
|
210
87
|
action:Action;
|
|
211
|
-
|
|
212
|
-
/**
|
|
213
|
-
* @description Parameters for item_entitlements
|
|
214
|
-
|
|
215
|
-
*/
|
|
216
|
-
|
|
217
|
-
item_entitlements?:{item_id:string,item_type?:'item' | 'charge' | 'addon' | 'subscription' | 'plan',value?:string}[];
|
|
218
88
|
}
|
|
219
89
|
export interface UpsertOrRemoveItemEntitlementsForItemResponse {
|
|
220
90
|
item_entitlement:ItemEntitlement;
|
|
221
91
|
}
|
|
222
92
|
export interface UpsertOrRemoveItemEntitlementsForItemInputParam {
|
|
223
93
|
|
|
224
|
-
|
|
225
|
-
* @description The specific action to be performed for each `item_entitlement` specified. \* remove - Deletes the `item_entitlement` for the `feature_id` and `item_id` combination, if it exists. \* upsert - If the `item_entitlement` already exists for the `feature_id` and `item_id` combination, the `value` of the `item_entitlement` is updated. If it doesn't exist, a new `item_entitelment` is created.
|
|
226
|
-
|
|
227
|
-
*/
|
|
94
|
+
item_entitlements:{feature_id:string,value?:string}[];
|
|
228
95
|
|
|
229
96
|
action:Action;
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* @description Parameters for item_entitlements
|
|
233
|
-
|
|
234
|
-
*/
|
|
235
|
-
|
|
236
|
-
item_entitlements?:{feature_id:string,value?:string}[];
|
|
237
97
|
}
|
|
238
98
|
|
|
239
99
|
}
|
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface NonSubscription {
|
|
4
5
|
|
|
6
|
+
|
|
5
7
|
app_id:string;
|
|
6
|
-
|
|
8
|
+
|
|
7
9
|
invoice_id:string;
|
|
8
|
-
|
|
10
|
+
|
|
9
11
|
customer_id?:string;
|
|
10
|
-
|
|
12
|
+
|
|
11
13
|
charge_id:string;
|
|
14
|
+
|
|
12
15
|
}
|
|
13
16
|
export namespace NonSubscription {
|
|
14
17
|
export class NonSubscriptionResource {
|
|
@@ -19,11 +22,11 @@ declare module 'chargebee' {
|
|
|
19
22
|
}
|
|
20
23
|
export interface ProcessReceiptInputParam {
|
|
21
24
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
product:{currency_code:string,id:string,name?:string,price:number,price_in_decimal?:string,type:'non_consumable' | 'consumable' | 'non_renewing_subscription'};
|
|
25
|
+
product:{currency_code:string,id:string,name?:string,price:number,price_in_decimal?:string,type:'consumable' | 'non_consumable' | 'non_renewing_subscription'};
|
|
25
26
|
|
|
26
27
|
customer?:{email?:string,first_name?:string,id?:string,last_name?:string};
|
|
28
|
+
|
|
29
|
+
receipt:string;
|
|
27
30
|
}
|
|
28
31
|
|
|
29
32
|
}
|
|
@@ -1,167 +1,52 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface PaymentIntent {
|
|
4
5
|
|
|
5
|
-
/**
|
|
6
|
-
* @description Identifier for PaymentIntent.
|
|
7
6
|
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
7
|
id:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description Current status of PaymentIntent. \* in_progress - Status will be in_progress if the Active Payment Attempt state is in requires_identification, requires_challenge or requires_redirection. \* authorized - 3DS verification successfully completed. \* consumed - If any Chargebee operation such as create subscription etc. is completed using the intent, it will be in consumed state. Intent cannot be used if it's already in consumed state. \* expired - Intent has expired, since it was not consumed before the predefined time-out. \* inited - Intent is initialized.
|
|
14
8
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
status:'consumed' | 'in_progress' | 'inited' | 'expired' | 'authorized';
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description The currency code (ISO 4217 format) of the amount used in transaction.
|
|
9
|
+
status:'inited' | 'in_progress' | 'authorized' | 'consumed' | 'expired';
|
|
21
10
|
|
|
22
|
-
*/
|
|
23
|
-
|
|
24
11
|
currency_code?:string;
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description Amount(in cents) to be authorized for 3DS flow.
|
|
28
12
|
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
13
|
amount:number;
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* @description The gateway account used for performing the 3DS flow.
|
|
35
14
|
|
|
36
|
-
*/
|
|
37
|
-
|
|
38
15
|
gateway_account_id:string;
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* @description Timestamp indicating when the PaymentIntent will expire if left unconsumed.
|
|
42
16
|
|
|
43
|
-
*/
|
|
44
|
-
|
|
45
17
|
expires_at:number;
|
|
46
|
-
|
|
47
|
-
/**
|
|
48
|
-
* @description Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.
|
|
49
18
|
|
|
50
|
-
*/
|
|
51
|
-
|
|
52
19
|
reference_id?:string;
|
|
53
|
-
|
|
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 \* 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
20
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card' | 'online_banking_poland';
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
21
|
+
payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact';
|
|
63
22
|
|
|
64
|
-
*/
|
|
65
|
-
|
|
66
23
|
success_url?:string;
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* @description The URL the customer will be directed to when 3DS verification fails. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
70
24
|
|
|
71
|
-
*/
|
|
72
|
-
|
|
73
25
|
failure_url?:string;
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* @description Timestamp indicating when the PaymentIntent was created.
|
|
77
26
|
|
|
78
|
-
*/
|
|
79
|
-
|
|
80
27
|
created_at:number;
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
* @description Timestamp indicating when the PaymentIntent was last modified.
|
|
84
28
|
|
|
85
|
-
*/
|
|
86
|
-
|
|
87
29
|
modified_at:number;
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* @description Version number of this resource. The `resource_version` is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
|
|
91
30
|
|
|
92
|
-
*/
|
|
93
|
-
|
|
94
31
|
resource_version?:number;
|
|
95
|
-
|
|
96
|
-
/**
|
|
97
|
-
* @description Timestamp indicating when this payment intent was last updated.
|
|
98
32
|
|
|
99
|
-
*/
|
|
100
|
-
|
|
101
33
|
updated_at?:number;
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* @description The unique ID of the customer for which this payment_intent should be created. If not provided, a new customer is created and its ID is autogenerated.
|
|
105
|
-
**See also**
|
|
106
34
|
|
|
107
|
-
[Customer resource lookup and creation](/docs/api/payment_intents#customer_lookup)
|
|
108
|
-
|
|
109
|
-
*/
|
|
110
|
-
|
|
111
35
|
customer_id:string;
|
|
112
|
-
|
|
113
|
-
/**
|
|
114
|
-
* @description Gateway associated with the PaymentIntent.
|
|
115
36
|
|
|
116
|
-
*/
|
|
117
|
-
|
|
118
37
|
gateway?:string;
|
|
119
|
-
|
|
120
|
-
/**
|
|
121
|
-
* @description The unique ID of the [business entity](/docs/api/advanced-features?prod_cat_ver=2#mbe) of this `payment_intent`
|
|
122
38
|
|
|
123
|
-
|
|
124
|
-
|
|
39
|
+
active_payment_attempt?:PaymentIntent.PaymentAttempt;
|
|
40
|
+
|
|
125
41
|
business_entity_id?:string;
|
|
126
|
-
|
|
127
|
-
/**
|
|
128
|
-
* @description Active payment attempt for the PaymentIntent.
|
|
129
42
|
|
|
130
|
-
*/
|
|
131
|
-
|
|
132
|
-
active_payment_attempt?:PaymentIntent.PaymentAttempt;
|
|
133
43
|
}
|
|
134
44
|
export namespace PaymentIntent {
|
|
135
45
|
export class PaymentIntentResource {
|
|
136
|
-
/**
|
|
137
|
-
* @description Creates a PaymentIntent object. This is to be used with Chargebee.js API to complete the 3DS flow for new or stored cards.
|
|
138
|
-
|
|
139
|
-
While creating, specify the appropriate gateway account and amount. Exact amount can be estimated using our [Estimate API](/docs/api/estimates).
|
|
140
|
-
|
|
141
|
-
#### Customer resource lookup and creation {#customer_lookup}
|
|
142
|
-
|
|
143
|
-
When [customer[id]](/docs/api/payment_intents#create_a_payment_intent_customer_id) is provided for this operation, it is looked up by Chargebee, and if found, the payment_intent is created for it. If not found, a new customer resource is created with the ID provided, and the payment_intent is created.
|
|
144
|
-
|
|
145
|
-
##### Multiple business entities
|
|
146
|
-
|
|
147
|
-
If multiple [business entities](/docs/api/advanced-features#mbe) are created for the site, the customer resource lookup and creation happen within the [context](/docs/api/advanced-features#mbe-context) of the business entity [specified](/docs/api/advanced-features#mbe-header-main) in this API call. If no business entity is specified, the customer resource lookup is performed within the [site context](/docs/api/advanced-features#mbe-context), and if not found, the resource is created for the [default business entity](/docs/api/advanced-features#mbe-default-be) of the site.
|
|
148
|
-
|
|
149
|
-
*/
|
|
150
|
-
|
|
151
46
|
create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
|
|
152
47
|
|
|
153
|
-
/**
|
|
154
|
-
* @description Updating properties on a PaymentIntent object. All the subsequent 3DS transaction attempts will have the updated values.
|
|
155
|
-
|
|
156
|
-
*/
|
|
157
|
-
|
|
158
48
|
update(payment_intent_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
|
|
159
49
|
|
|
160
|
-
/**
|
|
161
|
-
* @description Retrieves the PaymentIntent resource.
|
|
162
|
-
|
|
163
|
-
*/
|
|
164
|
-
|
|
165
50
|
retrieve(payment_intent_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
166
51
|
}
|
|
167
52
|
export interface CreateResponse {
|
|
@@ -169,77 +54,22 @@ If multiple [business entities](/docs/api/advanced-features#mbe) are created for
|
|
|
169
54
|
}
|
|
170
55
|
export interface CreateInputParam {
|
|
171
56
|
|
|
172
|
-
/**
|
|
173
|
-
* @description Sets the [context]() for this operation to the [business entity](/docs/api/advanced-features?prod_cat_ver=2#mbe) specified. Applicable only when multiple business entities have been created for the site. When this parameter is provided, the operation is able to read/write data associated only to the business entity specified. When not provided, the operation can read/write data for the entire site.
|
|
174
|
-
**Note**
|
|
175
|
-
|
|
176
|
-
An alternative way of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features?prod_cat_ver=2#mbe-header-main).
|
|
177
|
-
**See also**
|
|
178
|
-
|
|
179
|
-
[Customer resource lookup and creation.](/docs/api/payment_intents#customer_lookup)
|
|
180
|
-
|
|
181
|
-
*/
|
|
182
|
-
|
|
183
57
|
business_entity_id?:string;
|
|
184
58
|
|
|
185
|
-
/**
|
|
186
|
-
* @description The unique ID of the customer for which this `payment_intent` should be created. If not provided, a new customer is created and its ID is autogenerated.
|
|
187
|
-
**See also**
|
|
188
|
-
|
|
189
|
-
[Customer resource lookup and creation](/docs/api/payment_intents#customer_lookup)
|
|
190
|
-
.
|
|
191
|
-
|
|
192
|
-
*/
|
|
193
|
-
|
|
194
59
|
customer_id?:string;
|
|
195
60
|
|
|
196
|
-
/**
|
|
197
|
-
* @description Amount(in cents) to be authorized for 3DS flow.
|
|
198
|
-
|
|
199
|
-
*/
|
|
200
|
-
|
|
201
61
|
amount:number;
|
|
202
62
|
|
|
203
|
-
/**
|
|
204
|
-
* @description The currency code (ISO 4217 format) of the amount used in transaction.
|
|
205
|
-
|
|
206
|
-
*/
|
|
207
|
-
|
|
208
63
|
currency_code:string;
|
|
209
64
|
|
|
210
|
-
/**
|
|
211
|
-
* @description The gateway account used for performing the 3DS flow.
|
|
212
|
-
|
|
213
|
-
*/
|
|
214
|
-
|
|
215
65
|
gateway_account_id?:string;
|
|
216
66
|
|
|
217
|
-
/**
|
|
218
|
-
* @description Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.
|
|
219
|
-
|
|
220
|
-
*/
|
|
221
|
-
|
|
222
67
|
reference_id?:string;
|
|
223
68
|
|
|
224
|
-
|
|
225
|
-
* @description The payment method of this intent. \* google_pay - google_pay \* boleto - boleto \* apple_pay - apple_pay \* ideal - ideal \* bancontact - bancontact \* netbanking_emandates - netbanking_emandates \* direct_debit - direct_debit \* card - card \* dotpay - dotpay \* giropay - giropay \* upi - upi \* sofort - sofort \* paypal_express_checkout - paypal_express_checkout
|
|
226
|
-
|
|
227
|
-
*/
|
|
228
|
-
|
|
229
|
-
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card' | 'online_banking_poland';
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
233
|
-
|
|
234
|
-
*/
|
|
69
|
+
payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact';
|
|
235
70
|
|
|
236
71
|
success_url?:string;
|
|
237
72
|
|
|
238
|
-
/**
|
|
239
|
-
* @description The URL the customer will be directed to when 3DS verification fails. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
240
|
-
|
|
241
|
-
*/
|
|
242
|
-
|
|
243
73
|
failure_url?:string;
|
|
244
74
|
}
|
|
245
75
|
export interface UpdateResponse {
|
|
@@ -247,46 +77,16 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
247
77
|
}
|
|
248
78
|
export interface UpdateInputParam {
|
|
249
79
|
|
|
250
|
-
/**
|
|
251
|
-
* @description Amount(in cents) to be authorized for 3DS flow.
|
|
252
|
-
|
|
253
|
-
*/
|
|
254
|
-
|
|
255
80
|
amount?:number;
|
|
256
81
|
|
|
257
|
-
/**
|
|
258
|
-
* @description The currency code (ISO 4217 format) of the amount used in transaction.
|
|
259
|
-
|
|
260
|
-
*/
|
|
261
|
-
|
|
262
82
|
currency_code?:string;
|
|
263
83
|
|
|
264
|
-
/**
|
|
265
|
-
* @description The gateway account used for performing the 3DS flow.
|
|
266
|
-
|
|
267
|
-
*/
|
|
268
|
-
|
|
269
84
|
gateway_account_id?:string;
|
|
270
85
|
|
|
271
|
-
|
|
272
|
-
* @description The payment method of this intent. \* google_pay - google_pay \* boleto - boleto \* apple_pay - apple_pay \* ideal - ideal \* bancontact - bancontact \* netbanking_emandates - netbanking_emandates \* direct_debit - direct_debit \* card - card \* dotpay - dotpay \* giropay - giropay \* upi - upi \* sofort - sofort \* paypal_express_checkout - paypal_express_checkout
|
|
273
|
-
|
|
274
|
-
*/
|
|
275
|
-
|
|
276
|
-
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card' | 'online_banking_poland';
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
280
|
-
|
|
281
|
-
*/
|
|
86
|
+
payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact';
|
|
282
87
|
|
|
283
88
|
success_url?:string;
|
|
284
89
|
|
|
285
|
-
/**
|
|
286
|
-
* @description The URL the customer will be directed to when 3DS verification fails. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
287
|
-
|
|
288
|
-
*/
|
|
289
|
-
|
|
290
90
|
failure_url?:string;
|
|
291
91
|
}
|
|
292
92
|
export interface RetrieveResponse {
|
|
@@ -294,68 +94,22 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
294
94
|
}
|
|
295
95
|
|
|
296
96
|
export interface PaymentAttempt {
|
|
297
|
-
/**
|
|
298
|
-
* @description Identifier for PaymentIntent's active payment attempt.
|
|
299
|
-
|
|
300
|
-
*/
|
|
301
|
-
|
|
302
97
|
id?:string;
|
|
303
98
|
|
|
304
|
-
|
|
305
|
-
* @description Current status of active payment attempt \* authorized - 3DS verification successfully completed. \* requires_challenge - The transaction has to go through 3DS Challenge flow and the customer needs to authenticate via 3DS 2.0 \* pending_authorization - Waiting for the authorization. \* requires_redirection - The transaction has to go through 3DS Redirection flow and the customer needs to authenticate via 3DS 1.0 \* inited - Payment attempt is initialized. \* refused - 3DS verification attempt failed. \* requires_identification - Customer's device fingerprint is used to verify their identity. It needs to be sent to the Issuing Bank for verification.
|
|
306
|
-
|
|
307
|
-
*/
|
|
308
|
-
|
|
309
|
-
status:'pending_authorization' | 'inited' | 'refused' | 'requires_challenge' | 'authorized' | 'requires_identification' | 'requires_redirection';
|
|
310
|
-
|
|
311
|
-
/**
|
|
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
|
-
|
|
314
|
-
*/
|
|
315
|
-
|
|
316
|
-
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card' | 'online_banking_poland';
|
|
99
|
+
status:'inited' | 'requires_identification' | 'requires_challenge' | 'requires_redirection' | 'authorized' | 'refused' | 'pending_authorization';
|
|
317
100
|
|
|
318
|
-
|
|
319
|
-
* @description Reference of PaymentIntent at gateway
|
|
320
|
-
|
|
321
|
-
*/
|
|
101
|
+
payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact';
|
|
322
102
|
|
|
323
103
|
id_at_gateway?:string;
|
|
324
104
|
|
|
325
|
-
/**
|
|
326
|
-
* @description Error code received from the payment gateway on failure.
|
|
327
|
-
|
|
328
|
-
*/
|
|
329
|
-
|
|
330
105
|
error_code?:string;
|
|
331
106
|
|
|
332
|
-
/**
|
|
333
|
-
* @description Error message received from the payment gateway on failure.
|
|
334
|
-
|
|
335
|
-
*/
|
|
336
|
-
|
|
337
107
|
error_text?:string;
|
|
338
108
|
|
|
339
|
-
/**
|
|
340
|
-
* @description Timestamp indicating when the active payment attempt was created.
|
|
341
|
-
|
|
342
|
-
*/
|
|
343
|
-
|
|
344
109
|
created_at:number;
|
|
345
110
|
|
|
346
|
-
/**
|
|
347
|
-
* @description Timestamp indicating when the active payment attempt was last modified.
|
|
348
|
-
|
|
349
|
-
*/
|
|
350
|
-
|
|
351
111
|
modified_at:number;
|
|
352
112
|
|
|
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
113
|
error_detail?:GatewayErrorDetail;
|
|
360
114
|
}
|
|
361
115
|
}
|