chargebee 3.25.0 → 3.26.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 +37 -0
- package/cjs/environment.js +1 -1
- package/cjs/resources/api_endpoints.js +120 -1
- package/esm/environment.js +1 -1
- package/esm/resources/api_endpoints.js +120 -1
- package/package.json +1 -1
- package/types/core.d.ts +1 -0
- package/types/index.d.ts +8 -0
- package/types/resources/Content.d.ts +4 -0
- package/types/resources/CreditNote.d.ts +1 -0
- package/types/resources/GrantBlock.d.ts +59 -0
- package/types/resources/HostedPage.d.ts +5 -1
- package/types/resources/LedgerAccountBalance.d.ts +50 -0
- package/types/resources/LedgerOperation.d.ts +141 -0
- package/types/resources/OmnichannelSubscription.d.ts +2 -0
- package/types/resources/PromotionalGrant.d.ts +37 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,40 @@
|
|
|
1
|
+
### v3.26.0 (2026-06-12)
|
|
2
|
+
* * *
|
|
3
|
+
### New Resources:
|
|
4
|
+
- [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks) has been added.
|
|
5
|
+
- [`LedgerAccountBalance`](https://apidocs.chargebee.com/docs/api/ledger_account_balances) has been added.
|
|
6
|
+
- [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations) has been added.
|
|
7
|
+
- [`PromotionalGrant`](https://apidocs.chargebee.com/docs/api/promotional_grants) has been added.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
### New Attributes:
|
|
11
|
+
- [`notes`](https://apidocs.chargebee.com/docs/api/credit_notes/credit-note-object#notes) has been added to [`CreditNote`](https://apidocs.chargebee.com/docs/api/credit_notes).
|
|
12
|
+
- [`layout`](https://apidocs.chargebee.com/docs/api/hosted_pages/hosted-page-object#layout) has been added to [`HostedPage`](https://apidocs.chargebee.com/docs/api/hosted_pages).
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### New Parameters:
|
|
16
|
+
- [`sort_by`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#sort_by) has been added as query parameter to [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) in [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### New Enums:
|
|
20
|
+
- `available`, `exhausted`, `scheduled`, and `in_grace_period` have been added as new values enum `Status`.
|
|
21
|
+
- `subscription_created`, `subscription_changed`, `top_up`, `promotional_grants`, and `rollover` have been added as new values to enum attribute [`grant_source`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#grant_source) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
|
|
22
|
+
- `provisioned` and `overdraft` have been added as new values to enum attribute [`account_type`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#account_type) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
|
|
23
|
+
- `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#unit_type) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
|
|
24
|
+
- `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/ledger_account_balances/ledger-account-balance-object#unit_type) in [`LedgerAccountBalance`](https://apidocs.chargebee.com/docs/api/ledger_account_balances).
|
|
25
|
+
- `allocation`, `capture`, `authorize`, `release_authorization`, `capture_authorization`, `expiry`, `void`, `rollover`, and `adjustment` have been added as new values to enum attribute [`type`](https://apidocs.chargebee.com/docs/api/ledger_operations/ledger-operation-object#type) in [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
|
|
26
|
+
- `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/ledger_operations/ledger-operation-object#unit_type) in [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
|
|
27
|
+
- `expires_at`, `created_at`, and `effective_from` have been added as new values to enum query parameter `sort_by.asc` in [`list_grant_blocks`](https://apidocs.chargebee.com/docs/api/grant_blocks/list-grant-blocks) of [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
|
|
28
|
+
- `expires_at`, `created_at`, and `effective_from` have been added as new values to enum query parameter `sort_by.desc` in [`list_grant_blocks`](https://apidocs.chargebee.com/docs/api/grant_blocks/list-grant-blocks) of [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
|
|
29
|
+
- `allocation`, `release_authorization`, `void`, `capture`, `rollover`, `adjustment`, `expiry`, `authorize`, and `capture_authorization` have been added as new values to enum query parameter `type.is` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
|
|
30
|
+
- `allocation`, `release_authorization`, `void`, `capture`, `rollover`, `adjustment`, `expiry`, `authorize`, and `capture_authorization` have been added as new values to enum query parameter `type.in` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
|
|
31
|
+
- `created_at` has been added as a new value to enum query parameter `sort_by.asc` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
|
|
32
|
+
- `created_at` has been added as a new value to enum query parameter `sort_by.desc` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
|
|
33
|
+
- `updated_at` and `created_at` have been added as new values to enum query parameter `sort_by.asc` in [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) of [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
|
|
34
|
+
- `updated_at` and `created_at` have been added as new values to enum query parameter `sort_by.desc` in [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) of [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
1
38
|
### v3.25.0 (2026-06-08)
|
|
2
39
|
* * *
|
|
3
40
|
### New Attributes:
|
package/cjs/environment.js
CHANGED
|
@@ -11,7 +11,7 @@ exports.Environment = {
|
|
|
11
11
|
hostSuffix: '.chargebee.com',
|
|
12
12
|
apiPath: '/api/v2',
|
|
13
13
|
timeout: DEFAULT_TIME_OUT,
|
|
14
|
-
clientVersion: 'v3.
|
|
14
|
+
clientVersion: 'v3.26.0',
|
|
15
15
|
port: DEFAULT_PORT,
|
|
16
16
|
timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
|
|
17
17
|
exportWaitInMillis: DEFAULT_EXPORT_WAIT,
|
|
@@ -4887,7 +4887,7 @@ exports.Endpoints = {
|
|
|
4887
4887
|
null,
|
|
4888
4888
|
true,
|
|
4889
4889
|
'grow',
|
|
4890
|
-
|
|
4890
|
+
false,
|
|
4891
4891
|
{},
|
|
4892
4892
|
{},
|
|
4893
4893
|
],
|
|
@@ -5054,6 +5054,125 @@ exports.Endpoints = {
|
|
|
5054
5054
|
{},
|
|
5055
5055
|
],
|
|
5056
5056
|
],
|
|
5057
|
+
ledgerAccountBalance: [
|
|
5058
|
+
[
|
|
5059
|
+
'listLedgerAccountBalances',
|
|
5060
|
+
'GET',
|
|
5061
|
+
'/ledger_account_balances',
|
|
5062
|
+
null,
|
|
5063
|
+
false,
|
|
5064
|
+
null,
|
|
5065
|
+
false,
|
|
5066
|
+
{},
|
|
5067
|
+
{},
|
|
5068
|
+
],
|
|
5069
|
+
],
|
|
5070
|
+
ledgerOperation: [
|
|
5071
|
+
[
|
|
5072
|
+
'retrieveLedgerOperation',
|
|
5073
|
+
'GET',
|
|
5074
|
+
'/ledger_operations',
|
|
5075
|
+
null,
|
|
5076
|
+
true,
|
|
5077
|
+
null,
|
|
5078
|
+
false,
|
|
5079
|
+
{},
|
|
5080
|
+
{},
|
|
5081
|
+
],
|
|
5082
|
+
[
|
|
5083
|
+
'listLedgerOperations',
|
|
5084
|
+
'GET',
|
|
5085
|
+
'/ledger_operations',
|
|
5086
|
+
null,
|
|
5087
|
+
false,
|
|
5088
|
+
null,
|
|
5089
|
+
false,
|
|
5090
|
+
{},
|
|
5091
|
+
{},
|
|
5092
|
+
],
|
|
5093
|
+
[
|
|
5094
|
+
'capture',
|
|
5095
|
+
'POST',
|
|
5096
|
+
'/ledger_operations',
|
|
5097
|
+
'/capture',
|
|
5098
|
+
false,
|
|
5099
|
+
null,
|
|
5100
|
+
true,
|
|
5101
|
+
{
|
|
5102
|
+
metadata: 0,
|
|
5103
|
+
},
|
|
5104
|
+
{},
|
|
5105
|
+
],
|
|
5106
|
+
[
|
|
5107
|
+
'authorize',
|
|
5108
|
+
'POST',
|
|
5109
|
+
'/ledger_operations',
|
|
5110
|
+
'/authorize',
|
|
5111
|
+
false,
|
|
5112
|
+
null,
|
|
5113
|
+
true,
|
|
5114
|
+
{
|
|
5115
|
+
metadata: 0,
|
|
5116
|
+
},
|
|
5117
|
+
{},
|
|
5118
|
+
],
|
|
5119
|
+
[
|
|
5120
|
+
'captureAuthorization',
|
|
5121
|
+
'POST',
|
|
5122
|
+
'/ledger_operations',
|
|
5123
|
+
'/capture_authorization',
|
|
5124
|
+
false,
|
|
5125
|
+
null,
|
|
5126
|
+
true,
|
|
5127
|
+
{
|
|
5128
|
+
metadata: 0,
|
|
5129
|
+
},
|
|
5130
|
+
{},
|
|
5131
|
+
],
|
|
5132
|
+
[
|
|
5133
|
+
'releaseAuthorization',
|
|
5134
|
+
'POST',
|
|
5135
|
+
'/ledger_operations',
|
|
5136
|
+
'/release_authorization',
|
|
5137
|
+
false,
|
|
5138
|
+
null,
|
|
5139
|
+
true,
|
|
5140
|
+
{
|
|
5141
|
+
metadata: 0,
|
|
5142
|
+
},
|
|
5143
|
+
{},
|
|
5144
|
+
],
|
|
5145
|
+
],
|
|
5146
|
+
grantBlock: [
|
|
5147
|
+
[
|
|
5148
|
+
'listGrantBlocks',
|
|
5149
|
+
'GET',
|
|
5150
|
+
'/grant_blocks',
|
|
5151
|
+
null,
|
|
5152
|
+
false,
|
|
5153
|
+
null,
|
|
5154
|
+
false,
|
|
5155
|
+
{},
|
|
5156
|
+
{},
|
|
5157
|
+
],
|
|
5158
|
+
],
|
|
5159
|
+
promotionalGrant: [
|
|
5160
|
+
[
|
|
5161
|
+
'promotionalGrants',
|
|
5162
|
+
'POST',
|
|
5163
|
+
'/promotional_grants',
|
|
5164
|
+
null,
|
|
5165
|
+
false,
|
|
5166
|
+
null,
|
|
5167
|
+
true,
|
|
5168
|
+
{
|
|
5169
|
+
metadata: 0,
|
|
5170
|
+
},
|
|
5171
|
+
{
|
|
5172
|
+
isIdempotent: true,
|
|
5173
|
+
},
|
|
5174
|
+
],
|
|
5175
|
+
],
|
|
5057
5176
|
impactedCustomer: [],
|
|
5058
5177
|
subscriptionEntitlementsUpdatedDetail: [],
|
|
5059
5178
|
subscriptionEntitlementsCreatedDetail: [],
|
package/esm/environment.js
CHANGED
|
@@ -8,7 +8,7 @@ export const Environment = {
|
|
|
8
8
|
hostSuffix: '.chargebee.com',
|
|
9
9
|
apiPath: '/api/v2',
|
|
10
10
|
timeout: DEFAULT_TIME_OUT,
|
|
11
|
-
clientVersion: 'v3.
|
|
11
|
+
clientVersion: 'v3.26.0',
|
|
12
12
|
port: DEFAULT_PORT,
|
|
13
13
|
timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
|
|
14
14
|
exportWaitInMillis: DEFAULT_EXPORT_WAIT,
|
|
@@ -4884,7 +4884,7 @@ export const Endpoints = {
|
|
|
4884
4884
|
null,
|
|
4885
4885
|
true,
|
|
4886
4886
|
'grow',
|
|
4887
|
-
|
|
4887
|
+
false,
|
|
4888
4888
|
{},
|
|
4889
4889
|
{},
|
|
4890
4890
|
],
|
|
@@ -5051,6 +5051,125 @@ export const Endpoints = {
|
|
|
5051
5051
|
{},
|
|
5052
5052
|
],
|
|
5053
5053
|
],
|
|
5054
|
+
ledgerAccountBalance: [
|
|
5055
|
+
[
|
|
5056
|
+
'listLedgerAccountBalances',
|
|
5057
|
+
'GET',
|
|
5058
|
+
'/ledger_account_balances',
|
|
5059
|
+
null,
|
|
5060
|
+
false,
|
|
5061
|
+
null,
|
|
5062
|
+
false,
|
|
5063
|
+
{},
|
|
5064
|
+
{},
|
|
5065
|
+
],
|
|
5066
|
+
],
|
|
5067
|
+
ledgerOperation: [
|
|
5068
|
+
[
|
|
5069
|
+
'retrieveLedgerOperation',
|
|
5070
|
+
'GET',
|
|
5071
|
+
'/ledger_operations',
|
|
5072
|
+
null,
|
|
5073
|
+
true,
|
|
5074
|
+
null,
|
|
5075
|
+
false,
|
|
5076
|
+
{},
|
|
5077
|
+
{},
|
|
5078
|
+
],
|
|
5079
|
+
[
|
|
5080
|
+
'listLedgerOperations',
|
|
5081
|
+
'GET',
|
|
5082
|
+
'/ledger_operations',
|
|
5083
|
+
null,
|
|
5084
|
+
false,
|
|
5085
|
+
null,
|
|
5086
|
+
false,
|
|
5087
|
+
{},
|
|
5088
|
+
{},
|
|
5089
|
+
],
|
|
5090
|
+
[
|
|
5091
|
+
'capture',
|
|
5092
|
+
'POST',
|
|
5093
|
+
'/ledger_operations',
|
|
5094
|
+
'/capture',
|
|
5095
|
+
false,
|
|
5096
|
+
null,
|
|
5097
|
+
true,
|
|
5098
|
+
{
|
|
5099
|
+
metadata: 0,
|
|
5100
|
+
},
|
|
5101
|
+
{},
|
|
5102
|
+
],
|
|
5103
|
+
[
|
|
5104
|
+
'authorize',
|
|
5105
|
+
'POST',
|
|
5106
|
+
'/ledger_operations',
|
|
5107
|
+
'/authorize',
|
|
5108
|
+
false,
|
|
5109
|
+
null,
|
|
5110
|
+
true,
|
|
5111
|
+
{
|
|
5112
|
+
metadata: 0,
|
|
5113
|
+
},
|
|
5114
|
+
{},
|
|
5115
|
+
],
|
|
5116
|
+
[
|
|
5117
|
+
'captureAuthorization',
|
|
5118
|
+
'POST',
|
|
5119
|
+
'/ledger_operations',
|
|
5120
|
+
'/capture_authorization',
|
|
5121
|
+
false,
|
|
5122
|
+
null,
|
|
5123
|
+
true,
|
|
5124
|
+
{
|
|
5125
|
+
metadata: 0,
|
|
5126
|
+
},
|
|
5127
|
+
{},
|
|
5128
|
+
],
|
|
5129
|
+
[
|
|
5130
|
+
'releaseAuthorization',
|
|
5131
|
+
'POST',
|
|
5132
|
+
'/ledger_operations',
|
|
5133
|
+
'/release_authorization',
|
|
5134
|
+
false,
|
|
5135
|
+
null,
|
|
5136
|
+
true,
|
|
5137
|
+
{
|
|
5138
|
+
metadata: 0,
|
|
5139
|
+
},
|
|
5140
|
+
{},
|
|
5141
|
+
],
|
|
5142
|
+
],
|
|
5143
|
+
grantBlock: [
|
|
5144
|
+
[
|
|
5145
|
+
'listGrantBlocks',
|
|
5146
|
+
'GET',
|
|
5147
|
+
'/grant_blocks',
|
|
5148
|
+
null,
|
|
5149
|
+
false,
|
|
5150
|
+
null,
|
|
5151
|
+
false,
|
|
5152
|
+
{},
|
|
5153
|
+
{},
|
|
5154
|
+
],
|
|
5155
|
+
],
|
|
5156
|
+
promotionalGrant: [
|
|
5157
|
+
[
|
|
5158
|
+
'promotionalGrants',
|
|
5159
|
+
'POST',
|
|
5160
|
+
'/promotional_grants',
|
|
5161
|
+
null,
|
|
5162
|
+
false,
|
|
5163
|
+
null,
|
|
5164
|
+
true,
|
|
5165
|
+
{
|
|
5166
|
+
metadata: 0,
|
|
5167
|
+
},
|
|
5168
|
+
{
|
|
5169
|
+
isIdempotent: true,
|
|
5170
|
+
},
|
|
5171
|
+
],
|
|
5172
|
+
],
|
|
5054
5173
|
impactedCustomer: [],
|
|
5055
5174
|
subscriptionEntitlementsUpdatedDetail: [],
|
|
5056
5175
|
subscriptionEntitlementsCreatedDetail: [],
|
package/package.json
CHANGED
package/types/core.d.ts
CHANGED
|
@@ -626,6 +626,7 @@ declare module 'chargebee' {
|
|
|
626
626
|
| 'js_api'
|
|
627
627
|
| 'migration'
|
|
628
628
|
| 'external_service';
|
|
629
|
+
type StatusEnum = 'available' | 'exhausted' | 'scheduled' | 'in_grace_period';
|
|
629
630
|
type TaxExemptReasonEnum =
|
|
630
631
|
| 'tax_not_configured'
|
|
631
632
|
| 'region_non_taxable'
|
package/types/index.d.ts
CHANGED
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
///<reference path='./resources/FilterCondition.d.ts' />
|
|
37
37
|
///<reference path='./resources/GatewayErrorDetail.d.ts' />
|
|
38
38
|
///<reference path='./resources/Gift.d.ts' />
|
|
39
|
+
///<reference path='./resources/GrantBlock.d.ts' />
|
|
39
40
|
///<reference path='./resources/Hierarchy.d.ts' />
|
|
40
41
|
///<reference path='./resources/HostedPage.d.ts' />
|
|
41
42
|
///<reference path='./resources/ImpactedCustomer.d.ts' />
|
|
@@ -49,6 +50,8 @@
|
|
|
49
50
|
///<reference path='./resources/ItemEntitlement.d.ts' />
|
|
50
51
|
///<reference path='./resources/ItemFamily.d.ts' />
|
|
51
52
|
///<reference path='./resources/ItemPrice.d.ts' />
|
|
53
|
+
///<reference path='./resources/LedgerAccountBalance.d.ts' />
|
|
54
|
+
///<reference path='./resources/LedgerOperation.d.ts' />
|
|
52
55
|
///<reference path='./resources/Metadata.d.ts' />
|
|
53
56
|
///<reference path='./resources/NonSubscription.d.ts' />
|
|
54
57
|
///<reference path='./resources/OfferEvent.d.ts' />
|
|
@@ -74,6 +77,7 @@
|
|
|
74
77
|
///<reference path='./resources/PriceVariant.d.ts' />
|
|
75
78
|
///<reference path='./resources/PricingPageSession.d.ts' />
|
|
76
79
|
///<reference path='./resources/PromotionalCredit.d.ts' />
|
|
80
|
+
///<reference path='./resources/PromotionalGrant.d.ts' />
|
|
77
81
|
///<reference path='./resources/Purchase.d.ts' />
|
|
78
82
|
///<reference path='./resources/Quote.d.ts' />
|
|
79
83
|
///<reference path='./resources/QuoteLineGroup.d.ts' />
|
|
@@ -209,6 +213,7 @@ declare module 'chargebee' {
|
|
|
209
213
|
export: Export.ExportResource;
|
|
210
214
|
feature: Feature.FeatureResource;
|
|
211
215
|
gift: Gift.GiftResource;
|
|
216
|
+
grantBlock: GrantBlock.GrantBlockResource;
|
|
212
217
|
hostedPage: HostedPage.HostedPageResource;
|
|
213
218
|
inAppSubscription: InAppSubscription.InAppSubscriptionResource;
|
|
214
219
|
invoice: Invoice.InvoiceResource;
|
|
@@ -216,6 +221,8 @@ declare module 'chargebee' {
|
|
|
216
221
|
itemEntitlement: ItemEntitlement.ItemEntitlementResource;
|
|
217
222
|
itemFamily: ItemFamily.ItemFamilyResource;
|
|
218
223
|
itemPrice: ItemPrice.ItemPriceResource;
|
|
224
|
+
ledgerAccountBalance: LedgerAccountBalance.LedgerAccountBalanceResource;
|
|
225
|
+
ledgerOperation: LedgerOperation.LedgerOperationResource;
|
|
219
226
|
nonSubscription: NonSubscription.NonSubscriptionResource;
|
|
220
227
|
offerEvent: OfferEvent.OfferEventResource;
|
|
221
228
|
offerFulfillment: OfferFulfillment.OfferFulfillmentResource;
|
|
@@ -233,6 +240,7 @@ declare module 'chargebee' {
|
|
|
233
240
|
priceVariant: PriceVariant.PriceVariantResource;
|
|
234
241
|
pricingPageSession: PricingPageSession.PricingPageSessionResource;
|
|
235
242
|
promotionalCredit: PromotionalCredit.PromotionalCreditResource;
|
|
243
|
+
promotionalGrant: PromotionalGrant.PromotionalGrantResource;
|
|
236
244
|
purchase: Purchase.PurchaseResource;
|
|
237
245
|
quote: Quote.QuoteResource;
|
|
238
246
|
ramp: Ramp.RampResource;
|
|
@@ -41,6 +41,7 @@ declare module 'chargebee' {
|
|
|
41
41
|
filter_condition: FilterCondition;
|
|
42
42
|
gateway_error_detail: GatewayErrorDetail;
|
|
43
43
|
gift: Gift;
|
|
44
|
+
grant_block: GrantBlock;
|
|
44
45
|
hierarchy: Hierarchy;
|
|
45
46
|
hosted_page: HostedPage;
|
|
46
47
|
impacted_customer: ImpactedCustomer;
|
|
@@ -54,6 +55,8 @@ declare module 'chargebee' {
|
|
|
54
55
|
item_entitlement: ItemEntitlement;
|
|
55
56
|
item_family: ItemFamily;
|
|
56
57
|
item_price: ItemPrice;
|
|
58
|
+
ledger_account_balance: LedgerAccountBalance;
|
|
59
|
+
ledger_operation: LedgerOperation;
|
|
57
60
|
metadata: Metadata;
|
|
58
61
|
non_subscription: NonSubscription;
|
|
59
62
|
offer_event: OfferEvent;
|
|
@@ -79,6 +82,7 @@ declare module 'chargebee' {
|
|
|
79
82
|
price_variant: PriceVariant;
|
|
80
83
|
pricing_page_session: PricingPageSession;
|
|
81
84
|
promotional_credit: PromotionalCredit;
|
|
85
|
+
promotional_grant: PromotionalGrant;
|
|
82
86
|
purchase: Purchase;
|
|
83
87
|
quote: Quote;
|
|
84
88
|
quote_line_group: QuoteLineGroup;
|
|
@@ -44,6 +44,7 @@ declare module 'chargebee' {
|
|
|
44
44
|
local_currency_code?: string;
|
|
45
45
|
round_off_amount?: number;
|
|
46
46
|
fractional_correction?: number;
|
|
47
|
+
notes?: string[];
|
|
47
48
|
line_items?: CreditNote.LineItem[];
|
|
48
49
|
line_item_tiers?: CreditNote.LineItemTier[];
|
|
49
50
|
line_item_discounts?: CreditNote.LineItemDiscount[];
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
///<reference path='./filter.d.ts'/>
|
|
4
|
+
declare module 'chargebee' {
|
|
5
|
+
export interface GrantBlock {
|
|
6
|
+
id: string;
|
|
7
|
+
granted_amount: string;
|
|
8
|
+
effective_from: number;
|
|
9
|
+
expires_at: number;
|
|
10
|
+
balance: string;
|
|
11
|
+
hold_amount: string;
|
|
12
|
+
used_amount: string;
|
|
13
|
+
expired_amount: string;
|
|
14
|
+
rolled_over_amount: string;
|
|
15
|
+
voided_amount: string;
|
|
16
|
+
origin_grant_block_id?: string;
|
|
17
|
+
status: StatusEnum;
|
|
18
|
+
metadata?: string;
|
|
19
|
+
grant_source:
|
|
20
|
+
| 'subscription_created'
|
|
21
|
+
| 'subscription_changed'
|
|
22
|
+
| 'top_up'
|
|
23
|
+
| 'promotional_grants'
|
|
24
|
+
| 'rollover';
|
|
25
|
+
created_at?: number;
|
|
26
|
+
account_type?: 'provisioned' | 'overdraft';
|
|
27
|
+
unit_id?: string;
|
|
28
|
+
unit_type?: 'credit_unit';
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export namespace GrantBlock {
|
|
32
|
+
export class GrantBlockResource {
|
|
33
|
+
listGrantBlocks(
|
|
34
|
+
input: ListGrantBlocksInputParam,
|
|
35
|
+
headers?: ChargebeeRequestHeader,
|
|
36
|
+
): Promise<ChargebeeResponse<ListGrantBlocksResponse>>;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface ListGrantBlocksResponse {
|
|
40
|
+
list: { grant_block: GrantBlock }[];
|
|
41
|
+
next_offset?: string;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// REQUEST PARAMS
|
|
45
|
+
//---------------
|
|
46
|
+
|
|
47
|
+
export interface ListGrantBlocksInputParam {
|
|
48
|
+
limit?: number;
|
|
49
|
+
offset?: string;
|
|
50
|
+
subscription_id: filter.String;
|
|
51
|
+
unit_id?: filter.String;
|
|
52
|
+
effective_from?: filter.Timestamp;
|
|
53
|
+
expires_at?: filter.Timestamp;
|
|
54
|
+
created_at?: filter.Timestamp;
|
|
55
|
+
'sort_by[asc]'?: string;
|
|
56
|
+
'sort_by[desc]'?: string;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
@@ -7,7 +7,6 @@ declare module 'chargebee' {
|
|
|
7
7
|
type?:
|
|
8
8
|
| 'checkout_new'
|
|
9
9
|
| 'checkout_existing'
|
|
10
|
-
| 'update_payment_method'
|
|
11
10
|
| 'manage_payment_sources'
|
|
12
11
|
| 'collect_now'
|
|
13
12
|
| 'extend_subscription'
|
|
@@ -29,6 +28,7 @@ declare module 'chargebee' {
|
|
|
29
28
|
embed: boolean;
|
|
30
29
|
created_at?: number;
|
|
31
30
|
expires_at?: number;
|
|
31
|
+
layout?: LayoutEnum;
|
|
32
32
|
content: Content;
|
|
33
33
|
updated_at?: number;
|
|
34
34
|
resource_version?: number;
|
|
@@ -77,6 +77,10 @@ declare module 'chargebee' {
|
|
|
77
77
|
headers?: ChargebeeRequestHeader,
|
|
78
78
|
): Promise<ChargebeeResponse<UpdateCardResponse>>;
|
|
79
79
|
|
|
80
|
+
/**
|
|
81
|
+
* @deprecated This method is deprecated and will be removed in a future version.
|
|
82
|
+
*/
|
|
83
|
+
|
|
80
84
|
updatePaymentMethod(
|
|
81
85
|
input: UpdatePaymentMethodInputParam,
|
|
82
86
|
headers?: ChargebeeRequestHeader,
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
///<reference path='./filter.d.ts'/>
|
|
4
|
+
declare module 'chargebee' {
|
|
5
|
+
export interface LedgerAccountBalance {
|
|
6
|
+
subscription_id: string;
|
|
7
|
+
unit_id: string;
|
|
8
|
+
unit_type: 'credit_unit';
|
|
9
|
+
modified_at?: number;
|
|
10
|
+
provisioned_balance?: LedgerAccountBalance.ProvisionedBalance;
|
|
11
|
+
overdraft_balance?: LedgerAccountBalance.OverdraftBalance;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export namespace LedgerAccountBalance {
|
|
15
|
+
export class LedgerAccountBalanceResource {
|
|
16
|
+
listLedgerAccountBalances(
|
|
17
|
+
input: ListLedgerAccountBalancesInputParam,
|
|
18
|
+
headers?: ChargebeeRequestHeader,
|
|
19
|
+
): Promise<ChargebeeResponse<ListLedgerAccountBalancesResponse>>;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export interface ListLedgerAccountBalancesResponse {
|
|
23
|
+
list: { ledger_account_balance: LedgerAccountBalance }[];
|
|
24
|
+
next_offset?: string;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export interface ProvisionedBalance {
|
|
28
|
+
total_balance: string;
|
|
29
|
+
usable_balance: string;
|
|
30
|
+
hold_amount: string;
|
|
31
|
+
}
|
|
32
|
+
export interface OverdraftBalance {
|
|
33
|
+
is_unlimited: boolean;
|
|
34
|
+
limit?: string;
|
|
35
|
+
total_balance?: string;
|
|
36
|
+
usable_balance?: string;
|
|
37
|
+
used_amount: string;
|
|
38
|
+
hold_amount: string;
|
|
39
|
+
}
|
|
40
|
+
// REQUEST PARAMS
|
|
41
|
+
//---------------
|
|
42
|
+
|
|
43
|
+
export interface ListLedgerAccountBalancesInputParam {
|
|
44
|
+
limit?: number;
|
|
45
|
+
offset?: string;
|
|
46
|
+
subscription_id: filter.String;
|
|
47
|
+
unit_id?: filter.String;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
///<reference path='./filter.d.ts'/>
|
|
4
|
+
declare module 'chargebee' {
|
|
5
|
+
export interface LedgerOperation {
|
|
6
|
+
id: string;
|
|
7
|
+
type:
|
|
8
|
+
| 'allocation'
|
|
9
|
+
| 'capture'
|
|
10
|
+
| 'authorize'
|
|
11
|
+
| 'release_authorization'
|
|
12
|
+
| 'capture_authorization'
|
|
13
|
+
| 'expiry'
|
|
14
|
+
| 'void'
|
|
15
|
+
| 'rollover'
|
|
16
|
+
| 'adjustment';
|
|
17
|
+
amount: string;
|
|
18
|
+
start_balance: string;
|
|
19
|
+
end_balance: string;
|
|
20
|
+
provisioned_start_balance: string;
|
|
21
|
+
provisioned_end_balance: string;
|
|
22
|
+
overdraft_start_balance: string;
|
|
23
|
+
overdraft_end_balance: string;
|
|
24
|
+
parent_ledger_operation_id?: string;
|
|
25
|
+
ledger_operation_timestamp?: number;
|
|
26
|
+
auto_release_timestamp?: number;
|
|
27
|
+
metadata?: string;
|
|
28
|
+
created_at?: number;
|
|
29
|
+
modified_at?: number;
|
|
30
|
+
subscription_id?: string;
|
|
31
|
+
unit_id?: string;
|
|
32
|
+
unit_type?: 'credit_unit';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export namespace LedgerOperation {
|
|
36
|
+
export class LedgerOperationResource {
|
|
37
|
+
retrieveLedgerOperation(
|
|
38
|
+
ledger_operation_id: string,
|
|
39
|
+
headers?: ChargebeeRequestHeader,
|
|
40
|
+
): Promise<ChargebeeResponse<RetrieveLedgerOperationResponse>>;
|
|
41
|
+
|
|
42
|
+
listLedgerOperations(
|
|
43
|
+
input: ListLedgerOperationsInputParam,
|
|
44
|
+
headers?: ChargebeeRequestHeader,
|
|
45
|
+
): Promise<ChargebeeResponse<ListLedgerOperationsResponse>>;
|
|
46
|
+
|
|
47
|
+
capture(
|
|
48
|
+
input: CaptureInputParam,
|
|
49
|
+
headers?: ChargebeeRequestHeader,
|
|
50
|
+
): Promise<ChargebeeResponse<CaptureResponse>>;
|
|
51
|
+
|
|
52
|
+
authorize(
|
|
53
|
+
input: AuthorizeInputParam,
|
|
54
|
+
headers?: ChargebeeRequestHeader,
|
|
55
|
+
): Promise<ChargebeeResponse<AuthorizeResponse>>;
|
|
56
|
+
|
|
57
|
+
captureAuthorization(
|
|
58
|
+
input: CaptureAuthorizationInputParam,
|
|
59
|
+
headers?: ChargebeeRequestHeader,
|
|
60
|
+
): Promise<ChargebeeResponse<CaptureAuthorizationResponse>>;
|
|
61
|
+
|
|
62
|
+
releaseAuthorization(
|
|
63
|
+
input: ReleaseAuthorizationInputParam,
|
|
64
|
+
headers?: ChargebeeRequestHeader,
|
|
65
|
+
): Promise<ChargebeeResponse<ReleaseAuthorizationResponse>>;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export interface RetrieveLedgerOperationResponse {
|
|
69
|
+
ledger_operation: LedgerOperation;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export interface ListLedgerOperationsResponse {
|
|
73
|
+
list: { ledger_operation: LedgerOperation }[];
|
|
74
|
+
next_offset?: string;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export interface CaptureResponse {
|
|
78
|
+
ledger_operation: LedgerOperation;
|
|
79
|
+
ledger_account_balance: LedgerAccountBalance;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export interface AuthorizeResponse {
|
|
83
|
+
ledger_operation: LedgerOperation;
|
|
84
|
+
ledger_account_balance: LedgerAccountBalance;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export interface CaptureAuthorizationResponse {
|
|
88
|
+
ledger_operation: LedgerOperation;
|
|
89
|
+
ledger_account_balance: LedgerAccountBalance;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export interface ReleaseAuthorizationResponse {
|
|
93
|
+
ledger_operation: LedgerOperation;
|
|
94
|
+
ledger_account_balance: LedgerAccountBalance;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
// REQUEST PARAMS
|
|
98
|
+
//---------------
|
|
99
|
+
|
|
100
|
+
export interface ListLedgerOperationsInputParam {
|
|
101
|
+
limit?: number;
|
|
102
|
+
offset?: string;
|
|
103
|
+
subscription_id: filter.String;
|
|
104
|
+
unit_id?: filter.String;
|
|
105
|
+
created_at?: filter.Timestamp;
|
|
106
|
+
type?: filter.Enum;
|
|
107
|
+
'sort_by[asc]'?: string;
|
|
108
|
+
'sort_by[desc]'?: string;
|
|
109
|
+
}
|
|
110
|
+
export interface CaptureInputParam {
|
|
111
|
+
id?: string;
|
|
112
|
+
subscription_id: string;
|
|
113
|
+
unit_id: string;
|
|
114
|
+
amount: string;
|
|
115
|
+
ledger_operation_timestamp: number;
|
|
116
|
+
metadata?: any;
|
|
117
|
+
}
|
|
118
|
+
export interface AuthorizeInputParam {
|
|
119
|
+
id?: string;
|
|
120
|
+
subscription_id: string;
|
|
121
|
+
unit_id: string;
|
|
122
|
+
amount: string;
|
|
123
|
+
ledger_operation_timestamp: number;
|
|
124
|
+
auto_release_timestamp?: number;
|
|
125
|
+
metadata?: any;
|
|
126
|
+
}
|
|
127
|
+
export interface CaptureAuthorizationInputParam {
|
|
128
|
+
authorization_id: string;
|
|
129
|
+
id?: string;
|
|
130
|
+
amount: string;
|
|
131
|
+
ledger_operation_timestamp: number;
|
|
132
|
+
metadata?: any;
|
|
133
|
+
}
|
|
134
|
+
export interface ReleaseAuthorizationInputParam {
|
|
135
|
+
authorization_id: string;
|
|
136
|
+
id?: string;
|
|
137
|
+
ledger_operation_timestamp: number;
|
|
138
|
+
metadata?: any;
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
@@ -74,6 +74,8 @@ declare module 'chargebee' {
|
|
|
74
74
|
id_at_source?: filter.String;
|
|
75
75
|
updated_at?: filter.Timestamp;
|
|
76
76
|
purchased_at?: filter.Timestamp;
|
|
77
|
+
'sort_by[asc]'?: string;
|
|
78
|
+
'sort_by[desc]'?: string;
|
|
77
79
|
}
|
|
78
80
|
export interface OmnichannelTransactionsForOmnichannelSubscriptionInputParam {
|
|
79
81
|
limit?: number;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
|
|
4
|
+
declare module 'chargebee' {
|
|
5
|
+
export interface PromotionalGrant {
|
|
6
|
+
subscription_id: string;
|
|
7
|
+
unit_id: string;
|
|
8
|
+
amount: string;
|
|
9
|
+
expires_at: number;
|
|
10
|
+
metadata?: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export namespace PromotionalGrant {
|
|
14
|
+
export class PromotionalGrantResource {
|
|
15
|
+
promotionalGrants(
|
|
16
|
+
input: PromotionalGrantsInputParam,
|
|
17
|
+
headers?: ChargebeeRequestHeader,
|
|
18
|
+
): Promise<ChargebeeResponse<PromotionalGrantsResponse>>;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export interface PromotionalGrantsResponse {
|
|
22
|
+
ledger_operations: LedgerOperation[];
|
|
23
|
+
grant_blocks: GrantBlock[];
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
// REQUEST PARAMS
|
|
27
|
+
//---------------
|
|
28
|
+
|
|
29
|
+
export interface PromotionalGrantsInputParam {
|
|
30
|
+
subscription_id: string;
|
|
31
|
+
unit_id: string;
|
|
32
|
+
amount: string;
|
|
33
|
+
expires_at: number;
|
|
34
|
+
metadata?: any;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|