chargebee 2.37.0 → 2.39.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/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +1 -0
- package/package.json +1 -1
- package/types/core.d.ts +1 -1
- package/types/index.d.ts +1 -4
- package/types/resources/BusinessEntity.d.ts +1 -0
- package/types/resources/Customer.d.ts +2 -1
- package/types/resources/EntitlementOverride.d.ts +12 -0
- package/types/resources/Estimate.d.ts +1 -0
- package/types/resources/HostedPage.d.ts +4 -0
- package/types/resources/InstallmentConfig.d.ts +1 -1
- package/types/resources/Invoice.d.ts +1 -0
- package/types/resources/Metadata.d.ts +10 -0
- package/types/resources/PaymentSource.d.ts +1 -0
- package/types/resources/PriceVariant.d.ts +6 -1
- package/types/resources/PricingPageSession.d.ts +54 -0
- package/types/resources/QuotedSubscription.d.ts +4 -0
- package/types/resources/Ramp.d.ts +7 -0
- package/types/resources/Subscription.d.ts +7 -8
- package/types/resources/SubscriptionEntitlement.d.ts +11 -1
- package/types/resources/UnbilledCharge.d.ts +2 -1
- package/types/resources/Usage.d.ts +8 -0
- package/types/resources/VirtualBankAccount.d.ts +1 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,40 @@
|
|
|
1
|
+
### v2.39.0 (2024-07-31)
|
|
2
|
+
* * *
|
|
3
|
+
|
|
4
|
+
#### New Resource:
|
|
5
|
+
* Metadata has been added.
|
|
6
|
+
|
|
7
|
+
#### New Attributes:
|
|
8
|
+
* variant_group has been added in PriceVariant resource.
|
|
9
|
+
* effective_from & schedule_status have been added in EntitlementOverride resource.
|
|
10
|
+
* effective_from & schedule_status have been added in SubscriptionEntitlement resource.
|
|
11
|
+
* status_transition_reason has been added in Ramp subresource.
|
|
12
|
+
* billing_period & billing_period_unit have been added in SubscriptionItem subresource.
|
|
13
|
+
|
|
14
|
+
#### New Input parameters:
|
|
15
|
+
* variant_group has been added to PriceVariant#CreateRequest, PriceVariant#UpdateRequest.
|
|
16
|
+
* include_scheduled_overrides has been added to SubscriptionEntitlement#SubscriptionEntitlementsForSubscriptionRequest.
|
|
17
|
+
* entitlement_overrides[effective_from] has been added to SubscriptionEntitlement#SubscriptionEntitlementsForSubscriptionRequest.
|
|
18
|
+
* entitlement_overrides[effective_from] has been added to EntitlementOverride#AddEntitlementOverrideForSubscriptionRequest.
|
|
19
|
+
* include_scheduled_overrides has been added to EntitlementOverride#ListEntitlementOverrideForSubscriptionRequest.
|
|
20
|
+
* updated_at has been added to Usage#ListRequest.
|
|
21
|
+
|
|
22
|
+
#### New Enum values:
|
|
23
|
+
* SUBSCRIPTION_ITEMS_RENEWED has been added in EventType enum.
|
|
24
|
+
* SUBSCRIPTION_RAMP_DRAFTED has been added in EventType enum.
|
|
25
|
+
* SUBSCRIPTION_RAMP_UPDATED has been added in EventType enum.
|
|
26
|
+
|
|
27
|
+
### v2.38.0 (2024-07-19)
|
|
28
|
+
* * *
|
|
29
|
+
|
|
30
|
+
#### New Input parameters:
|
|
31
|
+
* change_option has been added to HostedPage#CheckoutExistingForItemsRequest.
|
|
32
|
+
* changes_scheduled_at has been added to HostedPage#CheckoutExistingForItemsRequest.
|
|
33
|
+
|
|
34
|
+
#### Bug Fixes:
|
|
35
|
+
* index.d.ts referencing to non existing file/ non resources.
|
|
36
|
+
* missing imports for few resources.
|
|
37
|
+
|
|
1
38
|
### v2.37.0 (2024-07-03)
|
|
2
39
|
* * *
|
|
3
40
|
|
package/lib/chargebee.js
CHANGED
package/package.json
CHANGED
package/types/core.d.ts
CHANGED
|
@@ -44,7 +44,7 @@ declare module 'chargebee' {
|
|
|
44
44
|
type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
|
|
45
45
|
type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant'
|
|
46
46
|
type EventName = 'cancellation_page_loaded'
|
|
47
|
-
type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'invoice_installments_created' | 'invoice_installment_updated' | 'installment_config_created' | 'installment_config_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'ramp_created' | 'ramp_deleted' | 'ramp_applied' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
|
|
47
|
+
type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'invoice_installments_created' | 'invoice_installment_updated' | 'installment_config_created' | 'installment_config_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'ramp_created' | 'ramp_deleted' | 'ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
|
|
48
48
|
type ExportType = 'data' | 'import_friendly_data'
|
|
49
49
|
type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
|
|
50
50
|
type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
|
package/types/index.d.ts
CHANGED
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
///<reference path='./resources/ItemEntitlement.d.ts' />
|
|
42
42
|
///<reference path='./resources/ItemFamily.d.ts' />
|
|
43
43
|
///<reference path='./resources/ItemPrice.d.ts' />
|
|
44
|
-
///<reference path='./resources/
|
|
44
|
+
///<reference path='./resources/Metadata.d.ts' />
|
|
45
45
|
///<reference path='./resources/NonSubscription.d.ts' />
|
|
46
46
|
///<reference path='./resources/Order.d.ts' />
|
|
47
47
|
///<reference path='./resources/PaymentIntent.d.ts' />
|
|
@@ -78,7 +78,6 @@ declare module 'chargebee' {
|
|
|
78
78
|
static address: Address.AddressResource;
|
|
79
79
|
static attached_item: AttachedItem.AttachedItemResource;
|
|
80
80
|
static business_entity: BusinessEntity.BusinessEntityResource;
|
|
81
|
-
static business_entity_transfer: BusinessEntityTransfer.BusinessEntityTransferResource;
|
|
82
81
|
static card: Card.CardResource;
|
|
83
82
|
static comment: Comment.CommentResource;
|
|
84
83
|
static coupon: Coupon.CouponResource;
|
|
@@ -120,9 +119,7 @@ declare module 'chargebee' {
|
|
|
120
119
|
static site_migration_detail: SiteMigrationDetail.SiteMigrationDetailResource;
|
|
121
120
|
static subscription: Subscription.SubscriptionResource;
|
|
122
121
|
static subscription_entitlement: SubscriptionEntitlement.SubscriptionEntitlementResource;
|
|
123
|
-
static tax_withheld: TaxWithheld.TaxWithheldResource;
|
|
124
122
|
static time_machine: TimeMachine.TimeMachineResource;
|
|
125
|
-
static token: Token.TokenResource;
|
|
126
123
|
static transaction: Transaction.TransactionResource;
|
|
127
124
|
static unbilled_charge: UnbilledCharge.UnbilledChargeResource;
|
|
128
125
|
static usage: Usage.UsageResource;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface Customer {
|
|
4
5
|
[key : string] : any;
|
|
@@ -116,7 +117,7 @@ declare module 'chargebee' {
|
|
|
116
117
|
|
|
117
118
|
excess_payments:number;
|
|
118
119
|
|
|
119
|
-
balances?:Customer.
|
|
120
|
+
balances?:Customer.Balance[];
|
|
120
121
|
|
|
121
122
|
entity_identifiers?:Customer.EntityIdentifier[];
|
|
122
123
|
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface EntitlementOverride {
|
|
4
5
|
|
|
@@ -73,6 +74,11 @@ declare module 'chargebee' {
|
|
|
73
74
|
*/
|
|
74
75
|
|
|
75
76
|
expires_at?:number;
|
|
77
|
+
|
|
78
|
+
effective_from?:number;
|
|
79
|
+
|
|
80
|
+
schedule_status?:'activated' | 'scheduled' | 'failed';
|
|
81
|
+
|
|
76
82
|
}
|
|
77
83
|
export namespace EntitlementOverride {
|
|
78
84
|
export class EntitlementOverrideResource {
|
|
@@ -139,6 +145,12 @@ declare module 'chargebee' {
|
|
|
139
145
|
*/
|
|
140
146
|
|
|
141
147
|
offset?:string;
|
|
148
|
+
|
|
149
|
+
embed?:string;
|
|
150
|
+
|
|
151
|
+
include_drafts?:boolean;
|
|
152
|
+
|
|
153
|
+
include_scheduled_overrides?:boolean;
|
|
142
154
|
}
|
|
143
155
|
|
|
144
156
|
}
|
|
@@ -445,6 +445,10 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
445
445
|
*/
|
|
446
446
|
|
|
447
447
|
entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
|
|
448
|
+
|
|
449
|
+
change_option?:ChangeOption;
|
|
450
|
+
|
|
451
|
+
changes_scheduled_at?:number;
|
|
448
452
|
}
|
|
449
453
|
export interface CheckoutNewForItemsResponse {
|
|
450
454
|
hosted_page:HostedPage;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface PriceVariant {
|
|
4
5
|
|
|
@@ -27,7 +28,7 @@ declare module 'chargebee' {
|
|
|
27
28
|
* @description Description of the price variant.
|
|
28
29
|
|
|
29
30
|
*/
|
|
30
|
-
|
|
31
|
+
variant_group?:string;
|
|
31
32
|
description?:string;
|
|
32
33
|
|
|
33
34
|
/**
|
|
@@ -152,6 +153,8 @@ Attributes can be used to store additional information about the price variant.
|
|
|
152
153
|
*/
|
|
153
154
|
|
|
154
155
|
attributes:{name:string,value:string}[];
|
|
156
|
+
|
|
157
|
+
variant_group?:string;
|
|
155
158
|
}
|
|
156
159
|
export interface RetrieveResponse {
|
|
157
160
|
price_variant:PriceVariant;
|
|
@@ -182,6 +185,8 @@ Attributes can be used to store additional information about the price variant.
|
|
|
182
185
|
*/
|
|
183
186
|
|
|
184
187
|
description?:string;
|
|
188
|
+
|
|
189
|
+
variant_group?:string;
|
|
185
190
|
|
|
186
191
|
/**
|
|
187
192
|
* @description Status of a price variant. \* active - Active price variant. This price variant can be attached to [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang=curl). \* deleted - Deleted price variant. The `id` and `name` of the deleted price variant can be reused. \* archived - Archived price variant. This price variant is no longer `active` and cannot be attached to new [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang=curl). Existing item prices that already have this price variant attached will continue to remain as is.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
declare module 'chargebee' {
|
|
4
|
+
export interface PricingPageSession {
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
id?:string;
|
|
8
|
+
|
|
9
|
+
url?:string;
|
|
10
|
+
|
|
11
|
+
created_at?:number;
|
|
12
|
+
|
|
13
|
+
expires_at?:number;
|
|
14
|
+
|
|
15
|
+
}
|
|
16
|
+
export namespace PricingPageSession {
|
|
17
|
+
export class PricingPageSessionResource {
|
|
18
|
+
create_for_new_subscription(input:CreateForNewSubscriptionInputParam):ChargebeeRequest<CreateForNewSubscriptionResponse>;
|
|
19
|
+
|
|
20
|
+
create_for_existing_subscription(input:CreateForExistingSubscriptionInputParam):ChargebeeRequest<CreateForExistingSubscriptionResponse>;
|
|
21
|
+
}
|
|
22
|
+
export interface CreateForNewSubscriptionResponse {
|
|
23
|
+
pricing_page_session:PricingPageSession;
|
|
24
|
+
}
|
|
25
|
+
export interface CreateForNewSubscriptionInputParam {
|
|
26
|
+
|
|
27
|
+
pricing_page:{id:string};
|
|
28
|
+
|
|
29
|
+
subscription?:object;
|
|
30
|
+
|
|
31
|
+
customer?:object;
|
|
32
|
+
|
|
33
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
34
|
+
|
|
35
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
36
|
+
|
|
37
|
+
redirect_url?:string;
|
|
38
|
+
|
|
39
|
+
business_entity_id?:string;
|
|
40
|
+
}
|
|
41
|
+
export interface CreateForExistingSubscriptionResponse {
|
|
42
|
+
pricing_page_session:PricingPageSession;
|
|
43
|
+
}
|
|
44
|
+
export interface CreateForExistingSubscriptionInputParam {
|
|
45
|
+
|
|
46
|
+
pricing_page:{id:string};
|
|
47
|
+
|
|
48
|
+
subscription:object;
|
|
49
|
+
|
|
50
|
+
redirect_url?:string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
}
|
|
54
|
+
}
|
|
@@ -383,6 +383,10 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
383
383
|
*/
|
|
384
384
|
|
|
385
385
|
proration_type?:'partial_term' | 'full_term' | 'none';
|
|
386
|
+
|
|
387
|
+
billing_period?:number;
|
|
388
|
+
|
|
389
|
+
billing_period_unit?:'day' | 'week' | 'month' | 'year';
|
|
386
390
|
}
|
|
387
391
|
export interface ItemTier {
|
|
388
392
|
/**
|
|
@@ -131,6 +131,8 @@ Overrides the [item_tiers](subscriptions#subscription_item_tiers) for specific &
|
|
|
131
131
|
*/
|
|
132
132
|
|
|
133
133
|
item_tiers?:Ramp.ItemTier[];
|
|
134
|
+
|
|
135
|
+
status_transition_reason?:Ramp.StatusTransitionReason;
|
|
134
136
|
}
|
|
135
137
|
export namespace Ramp {
|
|
136
138
|
export class RampResource {
|
|
@@ -740,5 +742,10 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
740
742
|
|
|
741
743
|
index:number;
|
|
742
744
|
}
|
|
745
|
+
export interface StatusTransitionReason {
|
|
746
|
+
code?:string;
|
|
747
|
+
|
|
748
|
+
message?:string;
|
|
749
|
+
}
|
|
743
750
|
}
|
|
744
751
|
}
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
|
|
2
4
|
declare module 'chargebee' {
|
|
3
5
|
export interface Subscription {
|
|
4
6
|
[key : string] : any;
|
|
@@ -433,14 +435,7 @@ Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_bi
|
|
|
433
435
|
*/
|
|
434
436
|
|
|
435
437
|
referral_info?:Subscription.ReferralInfo;
|
|
436
|
-
|
|
437
|
-
/**
|
|
438
|
-
* @description Contract terms for this subscription
|
|
439
|
-
|
|
440
|
-
*/
|
|
441
|
-
|
|
442
|
-
contract_term?:Subscription.ContractTerm;
|
|
443
|
-
|
|
438
|
+
|
|
444
439
|
/**
|
|
445
440
|
* @description List of discounts for this subscription
|
|
446
441
|
|
|
@@ -3846,6 +3841,10 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
3846
3841
|
*/
|
|
3847
3842
|
|
|
3848
3843
|
proration_type?:'partial_term' | 'full_term' | 'none';
|
|
3844
|
+
|
|
3845
|
+
billing_period?:number;
|
|
3846
|
+
|
|
3847
|
+
billing_period_unit?:'day' | 'week' | 'month' | 'year';
|
|
3849
3848
|
}
|
|
3850
3849
|
export interface ItemTier {
|
|
3851
3850
|
/**
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface SubscriptionEntitlement {
|
|
4
5
|
|
|
@@ -66,7 +67,10 @@ declare module 'chargebee' {
|
|
|
66
67
|
* @description Timestamp when the subscription entitlements are going to expire.
|
|
67
68
|
|
|
68
69
|
*/
|
|
69
|
-
|
|
70
|
+
effective_from?:number;
|
|
71
|
+
|
|
72
|
+
schedule_status?:'activated' | 'scheduled' | 'failed';
|
|
73
|
+
|
|
70
74
|
expires_at?:number;
|
|
71
75
|
|
|
72
76
|
/**
|
|
@@ -137,6 +141,12 @@ The `components` attribute is not returned for any of the `subscr
|
|
|
137
141
|
*/
|
|
138
142
|
|
|
139
143
|
offset?:string;
|
|
144
|
+
|
|
145
|
+
include_drafts?:boolean;
|
|
146
|
+
|
|
147
|
+
embed?:string;
|
|
148
|
+
|
|
149
|
+
include_scheduled_overrides?:boolean;
|
|
140
150
|
}
|
|
141
151
|
export interface SetSubscriptionEntitlementAvailabilityResponse {
|
|
142
152
|
subscription_entitlement:SubscriptionEntitlement;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface UnbilledCharge {
|
|
4
5
|
|
|
@@ -42,7 +43,7 @@ declare module 'chargebee' {
|
|
|
42
43
|
|
|
43
44
|
updated_at:number;
|
|
44
45
|
|
|
45
|
-
tiers?:UnbilledCharge.
|
|
46
|
+
tiers?:UnbilledCharge.Tier[];
|
|
46
47
|
|
|
47
48
|
is_advance_charge?:boolean;
|
|
48
49
|
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface Usage {
|
|
4
5
|
|
|
@@ -270,6 +271,13 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
|
|
|
270
271
|
*/
|
|
271
272
|
|
|
272
273
|
sort_by?:{asc?:'usage_date',desc?:'usage_date'};
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* @description Indicates the date at which this credit note is last updated.
|
|
277
|
+
|
|
278
|
+
*/
|
|
279
|
+
|
|
280
|
+
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
273
281
|
}
|
|
274
282
|
export interface PdfResponse {
|
|
275
283
|
download:Download;
|