@stigg/typescript 0.1.0-alpha.3 → 0.1.0-alpha.4
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 +8 -0
- package/client.d.mts +2 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -2
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +6 -89
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +6 -89
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/customers/customers.d.mts +106 -46
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +106 -46
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +16 -10
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +16 -10
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +2 -2
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +2 -2
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js +3 -3
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +1 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +350 -0
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -0
- package/resources/v1/customers/promotional-entitlements.d.ts +350 -0
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -0
- package/resources/v1/customers/promotional-entitlements.js +23 -0
- package/resources/v1/customers/promotional-entitlements.js.map +1 -0
- package/resources/v1/customers/promotional-entitlements.mjs +19 -0
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -0
- package/resources/v1/events.d.mts +62 -0
- package/resources/v1/events.d.mts.map +1 -0
- package/resources/v1/events.d.ts +62 -0
- package/resources/v1/events.d.ts.map +1 -0
- package/resources/v1/events.js +15 -0
- package/resources/v1/events.js.map +1 -0
- package/resources/v1/events.mjs +11 -0
- package/resources/v1/events.mjs.map +1 -0
- package/resources/v1/index.d.mts +6 -4
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +6 -4
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +5 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +3 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +6 -20
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +6 -20
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/index.d.mts +2 -2
- package/resources/v1/subscriptions/index.d.mts.map +1 -1
- package/resources/v1/subscriptions/index.d.ts +2 -2
- package/resources/v1/subscriptions/index.d.ts.map +1 -1
- package/resources/v1/subscriptions/index.js.map +1 -1
- package/resources/v1/subscriptions/index.mjs +1 -1
- package/resources/v1/subscriptions/index.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +963 -1049
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +963 -1049
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +24 -6
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +25 -7
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/usage.d.mts +229 -0
- package/resources/v1/usage.d.mts.map +1 -0
- package/resources/v1/usage.d.ts +229 -0
- package/resources/v1/usage.d.ts.map +1 -0
- package/resources/v1/usage.js +23 -0
- package/resources/v1/usage.js.map +1 -0
- package/resources/v1/usage.mjs +19 -0
- package/resources/v1/usage.mjs.map +1 -0
- package/resources/v1/v1.d.mts +14 -172
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +14 -172
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +8 -12
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +8 -12
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +2 -14
- package/src/resources/index.ts +1 -7
- package/src/resources/v1/coupons.ts +6 -222
- package/src/resources/v1/customers/customers.ts +142 -57
- package/src/resources/v1/customers/index.ts +10 -2
- package/src/resources/v1/customers/promotional-entitlements.ts +466 -0
- package/src/resources/v1/events.ts +73 -0
- package/src/resources/v1/index.ts +19 -15
- package/src/resources/v1/subscriptions/future-update.ts +6 -28
- package/src/resources/v1/subscriptions/index.ts +8 -11
- package/src/resources/v1/subscriptions/subscriptions.ts +2541 -2304
- package/src/resources/v1/usage.ts +283 -0
- package/src/resources/v1/v1.ts +50 -220
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/v1/customers/usage.d.mts +0 -4
- package/resources/v1/customers/usage.d.mts.map +0 -1
- package/resources/v1/customers/usage.d.ts +0 -4
- package/resources/v1/customers/usage.d.ts.map +0 -1
- package/resources/v1/customers/usage.js +0 -9
- package/resources/v1/customers/usage.js.map +0 -1
- package/resources/v1/customers/usage.mjs +0 -5
- package/resources/v1/customers/usage.mjs.map +0 -1
- package/src/resources/v1/customers/usage.ts +0 -5
|
@@ -1,415 +1,166 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.js";
|
|
2
2
|
import * as FutureUpdateAPI from "./future-update.js";
|
|
3
|
-
import {
|
|
3
|
+
import { CancelSubscription, FutureUpdate } from "./future-update.js";
|
|
4
4
|
import { APIPromise } from "../../../core/api-promise.js";
|
|
5
5
|
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
|
|
6
6
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
7
7
|
export declare class Subscriptions extends APIResource {
|
|
8
8
|
futureUpdate: FutureUpdateAPI.FutureUpdate;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Get a single subscription by ID
|
|
11
11
|
*/
|
|
12
|
-
|
|
12
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Subscription>;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Update a subscription
|
|
15
15
|
*/
|
|
16
|
-
|
|
16
|
+
update(id: string, body: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
17
17
|
/**
|
|
18
18
|
* Get a list of subscriptions
|
|
19
19
|
*/
|
|
20
20
|
list(query?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse>;
|
|
21
|
+
/**
|
|
22
|
+
* Cancel subscription
|
|
23
|
+
*/
|
|
24
|
+
cancel(id: string, body: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
21
25
|
/**
|
|
22
26
|
* Delegate subscription payment to customer
|
|
23
27
|
*/
|
|
24
|
-
delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<
|
|
28
|
+
delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
29
|
+
/**
|
|
30
|
+
* Bulk import subscriptions
|
|
31
|
+
*/
|
|
32
|
+
import(body: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse>;
|
|
25
33
|
/**
|
|
26
34
|
* Migrate subscription to latest plan version
|
|
27
35
|
*/
|
|
28
|
-
migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<
|
|
36
|
+
migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
29
37
|
/**
|
|
30
38
|
* Preview subscription
|
|
31
39
|
*/
|
|
32
40
|
preview(body: SubscriptionPreviewParams, options?: RequestOptions): APIPromise<SubscriptionPreviewResponse>;
|
|
41
|
+
/**
|
|
42
|
+
* Provision subscription
|
|
43
|
+
*/
|
|
44
|
+
provision(body: SubscriptionProvisionParams, options?: RequestOptions): APIPromise<SubscriptionProvisionResponse>;
|
|
33
45
|
/**
|
|
34
46
|
* Transfer subscription to resource
|
|
35
47
|
*/
|
|
36
|
-
transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<
|
|
48
|
+
transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
37
49
|
}
|
|
38
50
|
export type SubscriptionListResponsesMyCursorIDPage = MyCursorIDPage<SubscriptionListResponse>;
|
|
39
51
|
/**
|
|
40
52
|
* Response object
|
|
41
53
|
*/
|
|
42
|
-
export interface
|
|
54
|
+
export interface Subscription {
|
|
43
55
|
/**
|
|
44
|
-
*
|
|
56
|
+
* Customer subscription to a plan
|
|
45
57
|
*/
|
|
46
|
-
data:
|
|
58
|
+
data: Subscription.Data;
|
|
47
59
|
}
|
|
48
|
-
export declare namespace
|
|
60
|
+
export declare namespace Subscription {
|
|
49
61
|
/**
|
|
50
|
-
*
|
|
62
|
+
* Customer subscription to a plan
|
|
51
63
|
*/
|
|
52
64
|
interface Data {
|
|
53
65
|
/**
|
|
54
|
-
*
|
|
66
|
+
* Subscription ID
|
|
55
67
|
*/
|
|
56
68
|
id: string;
|
|
57
|
-
entitlements: Array<Data.Entitlement>;
|
|
58
69
|
/**
|
|
59
|
-
*
|
|
70
|
+
* Billing ID
|
|
60
71
|
*/
|
|
61
|
-
|
|
72
|
+
billingId: string | null;
|
|
62
73
|
/**
|
|
63
|
-
*
|
|
74
|
+
* Created at
|
|
64
75
|
*/
|
|
65
|
-
|
|
76
|
+
createdAt: string;
|
|
66
77
|
/**
|
|
67
|
-
*
|
|
78
|
+
* Customer ID
|
|
68
79
|
*/
|
|
69
|
-
|
|
80
|
+
customerId: string;
|
|
70
81
|
/**
|
|
71
|
-
*
|
|
82
|
+
* Payment collection
|
|
72
83
|
*/
|
|
73
|
-
|
|
84
|
+
paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
|
|
74
85
|
/**
|
|
75
|
-
*
|
|
86
|
+
* Plan ID
|
|
76
87
|
*/
|
|
77
|
-
|
|
78
|
-
}
|
|
79
|
-
namespace Data {
|
|
80
|
-
interface Entitlement {
|
|
81
|
-
accessDeniedReason?: string | null;
|
|
82
|
-
currentUsage?: number;
|
|
83
|
-
/**
|
|
84
|
-
* entitlement updated at
|
|
85
|
-
*/
|
|
86
|
-
entitlementUpdatedAt?: string | null;
|
|
87
|
-
feature?: Entitlement.Feature | null;
|
|
88
|
-
hasUnlimitedUsage?: boolean | null;
|
|
89
|
-
isGranted?: boolean;
|
|
90
|
-
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
|
|
91
|
-
usageLimit?: number | null;
|
|
92
|
-
/**
|
|
93
|
-
* usage period anchor
|
|
94
|
-
*/
|
|
95
|
-
usagePeriodAnchor?: string | null;
|
|
96
|
-
/**
|
|
97
|
-
* usage period end
|
|
98
|
-
*/
|
|
99
|
-
usagePeriodEnd?: string | null;
|
|
100
|
-
/**
|
|
101
|
-
* usage period start
|
|
102
|
-
*/
|
|
103
|
-
usagePeriodStart?: string | null;
|
|
104
|
-
}
|
|
105
|
-
namespace Entitlement {
|
|
106
|
-
interface Feature {
|
|
107
|
-
/**
|
|
108
|
-
* Feature ID
|
|
109
|
-
*/
|
|
110
|
-
refId: string;
|
|
111
|
-
}
|
|
112
|
-
}
|
|
88
|
+
planId: string;
|
|
113
89
|
/**
|
|
114
|
-
*
|
|
90
|
+
* Pricing type
|
|
115
91
|
*/
|
|
116
|
-
|
|
92
|
+
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
93
|
+
/**
|
|
94
|
+
* Subscription start date
|
|
95
|
+
*/
|
|
96
|
+
startDate: string;
|
|
97
|
+
/**
|
|
98
|
+
* Subscription status
|
|
99
|
+
*/
|
|
100
|
+
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
101
|
+
/**
|
|
102
|
+
* Subscription cancellation date
|
|
103
|
+
*/
|
|
104
|
+
cancellationDate?: string | null;
|
|
105
|
+
/**
|
|
106
|
+
* Subscription cancel reason
|
|
107
|
+
*/
|
|
108
|
+
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
109
|
+
/**
|
|
110
|
+
* End of the current billing period
|
|
111
|
+
*/
|
|
112
|
+
currentBillingPeriodEnd?: string | null;
|
|
113
|
+
/**
|
|
114
|
+
* Start of the current billing period
|
|
115
|
+
*/
|
|
116
|
+
currentBillingPeriodStart?: string | null;
|
|
117
|
+
/**
|
|
118
|
+
* Subscription effective end date
|
|
119
|
+
*/
|
|
120
|
+
effectiveEndDate?: string | null;
|
|
121
|
+
/**
|
|
122
|
+
* Subscription end date
|
|
123
|
+
*/
|
|
124
|
+
endDate?: string | null;
|
|
125
|
+
/**
|
|
126
|
+
* Additional metadata for the subscription
|
|
127
|
+
*/
|
|
128
|
+
metadata?: {
|
|
129
|
+
[key: string]: string;
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* Paying customer ID for delegated billing
|
|
133
|
+
*/
|
|
134
|
+
payingCustomerId?: string | null;
|
|
135
|
+
/**
|
|
136
|
+
* The method used to collect payments for a subscription
|
|
137
|
+
*/
|
|
138
|
+
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
|
|
139
|
+
prices?: Array<Data.Price>;
|
|
140
|
+
/**
|
|
141
|
+
* Resource ID
|
|
142
|
+
*/
|
|
143
|
+
resourceId?: string | null;
|
|
144
|
+
/**
|
|
145
|
+
* Subscription trial end date
|
|
146
|
+
*/
|
|
147
|
+
trialEndDate?: string | null;
|
|
148
|
+
}
|
|
149
|
+
namespace Data {
|
|
150
|
+
interface Price {
|
|
117
151
|
/**
|
|
118
|
-
*
|
|
152
|
+
* Price ID
|
|
119
153
|
*/
|
|
120
154
|
id: string;
|
|
121
155
|
/**
|
|
122
|
-
*
|
|
123
|
-
*/
|
|
124
|
-
billingId: string | null;
|
|
125
|
-
/**
|
|
126
|
-
* Created at
|
|
156
|
+
* Creation timestamp
|
|
127
157
|
*/
|
|
128
158
|
createdAt: string;
|
|
129
159
|
/**
|
|
130
|
-
*
|
|
131
|
-
*/
|
|
132
|
-
customerId: string;
|
|
133
|
-
/**
|
|
134
|
-
* Payment collection
|
|
135
|
-
*/
|
|
136
|
-
paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
|
|
137
|
-
/**
|
|
138
|
-
* Plan ID
|
|
139
|
-
*/
|
|
140
|
-
planId: string;
|
|
141
|
-
/**
|
|
142
|
-
* Pricing type
|
|
143
|
-
*/
|
|
144
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
145
|
-
/**
|
|
146
|
-
* Subscription start date
|
|
147
|
-
*/
|
|
148
|
-
startDate: string;
|
|
149
|
-
/**
|
|
150
|
-
* Subscription status
|
|
151
|
-
*/
|
|
152
|
-
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
153
|
-
/**
|
|
154
|
-
* Subscription cancellation date
|
|
155
|
-
*/
|
|
156
|
-
cancellationDate?: string | null;
|
|
157
|
-
/**
|
|
158
|
-
* Subscription cancel reason
|
|
159
|
-
*/
|
|
160
|
-
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
161
|
-
/**
|
|
162
|
-
* End of the current billing period
|
|
163
|
-
*/
|
|
164
|
-
currentBillingPeriodEnd?: string | null;
|
|
165
|
-
/**
|
|
166
|
-
* Start of the current billing period
|
|
167
|
-
*/
|
|
168
|
-
currentBillingPeriodStart?: string | null;
|
|
169
|
-
/**
|
|
170
|
-
* Subscription effective end date
|
|
171
|
-
*/
|
|
172
|
-
effectiveEndDate?: string | null;
|
|
173
|
-
/**
|
|
174
|
-
* Subscription end date
|
|
175
|
-
*/
|
|
176
|
-
endDate?: string | null;
|
|
177
|
-
/**
|
|
178
|
-
* Additional metadata for the subscription
|
|
179
|
-
*/
|
|
180
|
-
metadata?: {
|
|
181
|
-
[key: string]: string;
|
|
182
|
-
};
|
|
183
|
-
/**
|
|
184
|
-
* Paying customer ID for delegated billing
|
|
185
|
-
*/
|
|
186
|
-
payingCustomerId?: string | null;
|
|
187
|
-
/**
|
|
188
|
-
* The method used to collect payments for a subscription
|
|
189
|
-
*/
|
|
190
|
-
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
|
|
191
|
-
prices?: Array<Subscription.Price>;
|
|
192
|
-
/**
|
|
193
|
-
* Resource ID
|
|
194
|
-
*/
|
|
195
|
-
resourceId?: string | null;
|
|
196
|
-
/**
|
|
197
|
-
* Subscription trial end date
|
|
160
|
+
* Last update timestamp
|
|
198
161
|
*/
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
namespace Subscription {
|
|
202
|
-
interface Price {
|
|
203
|
-
/**
|
|
204
|
-
* Addon identifier for the price override
|
|
205
|
-
*/
|
|
206
|
-
addonId?: string | null;
|
|
207
|
-
/**
|
|
208
|
-
* Whether this is a base charge override
|
|
209
|
-
*/
|
|
210
|
-
baseCharge?: boolean;
|
|
211
|
-
/**
|
|
212
|
-
* Block size for pricing
|
|
213
|
-
*/
|
|
214
|
-
blockSize?: number;
|
|
215
|
-
/**
|
|
216
|
-
* Feature identifier for the price override
|
|
217
|
-
*/
|
|
218
|
-
featureId?: string | null;
|
|
219
|
-
/**
|
|
220
|
-
* Override price amount
|
|
221
|
-
*/
|
|
222
|
-
price?: Price.Price;
|
|
223
|
-
/**
|
|
224
|
-
* Pricing tiers configuration
|
|
225
|
-
*/
|
|
226
|
-
tiers?: Array<Price.Tier>;
|
|
227
|
-
}
|
|
228
|
-
namespace Price {
|
|
229
|
-
/**
|
|
230
|
-
* Override price amount
|
|
231
|
-
*/
|
|
232
|
-
interface Price {
|
|
233
|
-
/**
|
|
234
|
-
* The price amount
|
|
235
|
-
*/
|
|
236
|
-
amount?: number;
|
|
237
|
-
/**
|
|
238
|
-
* The billing country code of the price
|
|
239
|
-
*/
|
|
240
|
-
billingCountryCode?: string | null;
|
|
241
|
-
/**
|
|
242
|
-
* The price currency
|
|
243
|
-
*/
|
|
244
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
245
|
-
}
|
|
246
|
-
interface Tier {
|
|
247
|
-
/**
|
|
248
|
-
* The flat fee price of the price tier
|
|
249
|
-
*/
|
|
250
|
-
flatPrice?: Tier.FlatPrice;
|
|
251
|
-
/**
|
|
252
|
-
* The unit price of the price tier
|
|
253
|
-
*/
|
|
254
|
-
unitPrice?: Tier.UnitPrice;
|
|
255
|
-
/**
|
|
256
|
-
* The up to quantity of the price tier
|
|
257
|
-
*/
|
|
258
|
-
upTo?: number;
|
|
259
|
-
}
|
|
260
|
-
namespace Tier {
|
|
261
|
-
/**
|
|
262
|
-
* The flat fee price of the price tier
|
|
263
|
-
*/
|
|
264
|
-
interface FlatPrice {
|
|
265
|
-
/**
|
|
266
|
-
* The price amount
|
|
267
|
-
*/
|
|
268
|
-
amount?: number;
|
|
269
|
-
/**
|
|
270
|
-
* The billing country code of the price
|
|
271
|
-
*/
|
|
272
|
-
billingCountryCode?: string | null;
|
|
273
|
-
/**
|
|
274
|
-
* The price currency
|
|
275
|
-
*/
|
|
276
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
277
|
-
}
|
|
278
|
-
/**
|
|
279
|
-
* The unit price of the price tier
|
|
280
|
-
*/
|
|
281
|
-
interface UnitPrice {
|
|
282
|
-
/**
|
|
283
|
-
* The price amount
|
|
284
|
-
*/
|
|
285
|
-
amount?: number;
|
|
286
|
-
/**
|
|
287
|
-
* The billing country code of the price
|
|
288
|
-
*/
|
|
289
|
-
billingCountryCode?: string | null;
|
|
290
|
-
/**
|
|
291
|
-
* The price currency
|
|
292
|
-
*/
|
|
293
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
294
|
-
}
|
|
295
|
-
}
|
|
296
|
-
}
|
|
297
|
-
}
|
|
298
|
-
}
|
|
299
|
-
}
|
|
300
|
-
/**
|
|
301
|
-
* Response object
|
|
302
|
-
*/
|
|
303
|
-
export interface SubscriptionRetrieveResponse {
|
|
304
|
-
/**
|
|
305
|
-
* Customer subscription to a plan
|
|
306
|
-
*/
|
|
307
|
-
data: SubscriptionRetrieveResponse.Data;
|
|
308
|
-
}
|
|
309
|
-
export declare namespace SubscriptionRetrieveResponse {
|
|
310
|
-
/**
|
|
311
|
-
* Customer subscription to a plan
|
|
312
|
-
*/
|
|
313
|
-
interface Data {
|
|
314
|
-
/**
|
|
315
|
-
* Subscription ID
|
|
316
|
-
*/
|
|
317
|
-
id: string;
|
|
318
|
-
/**
|
|
319
|
-
* Billing ID
|
|
320
|
-
*/
|
|
321
|
-
billingId: string | null;
|
|
322
|
-
/**
|
|
323
|
-
* Created at
|
|
324
|
-
*/
|
|
325
|
-
createdAt: string;
|
|
326
|
-
/**
|
|
327
|
-
* Customer ID
|
|
328
|
-
*/
|
|
329
|
-
customerId: string;
|
|
330
|
-
/**
|
|
331
|
-
* Payment collection
|
|
332
|
-
*/
|
|
333
|
-
paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
|
|
334
|
-
/**
|
|
335
|
-
* Plan ID
|
|
336
|
-
*/
|
|
337
|
-
planId: string;
|
|
338
|
-
/**
|
|
339
|
-
* Pricing type
|
|
340
|
-
*/
|
|
341
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
342
|
-
/**
|
|
343
|
-
* Subscription start date
|
|
344
|
-
*/
|
|
345
|
-
startDate: string;
|
|
346
|
-
/**
|
|
347
|
-
* Subscription status
|
|
348
|
-
*/
|
|
349
|
-
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
350
|
-
/**
|
|
351
|
-
* Subscription cancellation date
|
|
352
|
-
*/
|
|
353
|
-
cancellationDate?: string | null;
|
|
354
|
-
/**
|
|
355
|
-
* Subscription cancel reason
|
|
356
|
-
*/
|
|
357
|
-
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
358
|
-
/**
|
|
359
|
-
* End of the current billing period
|
|
360
|
-
*/
|
|
361
|
-
currentBillingPeriodEnd?: string | null;
|
|
362
|
-
/**
|
|
363
|
-
* Start of the current billing period
|
|
364
|
-
*/
|
|
365
|
-
currentBillingPeriodStart?: string | null;
|
|
366
|
-
/**
|
|
367
|
-
* Subscription effective end date
|
|
368
|
-
*/
|
|
369
|
-
effectiveEndDate?: string | null;
|
|
370
|
-
/**
|
|
371
|
-
* Subscription end date
|
|
372
|
-
*/
|
|
373
|
-
endDate?: string | null;
|
|
374
|
-
/**
|
|
375
|
-
* Additional metadata for the subscription
|
|
376
|
-
*/
|
|
377
|
-
metadata?: {
|
|
378
|
-
[key: string]: string;
|
|
379
|
-
};
|
|
380
|
-
/**
|
|
381
|
-
* Paying customer ID for delegated billing
|
|
382
|
-
*/
|
|
383
|
-
payingCustomerId?: string | null;
|
|
384
|
-
/**
|
|
385
|
-
* The method used to collect payments for a subscription
|
|
386
|
-
*/
|
|
387
|
-
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
|
|
388
|
-
prices?: Array<Data.Price>;
|
|
389
|
-
/**
|
|
390
|
-
* Resource ID
|
|
391
|
-
*/
|
|
392
|
-
resourceId?: string | null;
|
|
393
|
-
/**
|
|
394
|
-
* Subscription trial end date
|
|
395
|
-
*/
|
|
396
|
-
trialEndDate?: string | null;
|
|
397
|
-
}
|
|
398
|
-
namespace Data {
|
|
399
|
-
interface Price {
|
|
400
|
-
/**
|
|
401
|
-
* Price ID
|
|
402
|
-
*/
|
|
403
|
-
id: string;
|
|
404
|
-
/**
|
|
405
|
-
* Creation timestamp
|
|
406
|
-
*/
|
|
407
|
-
createdAt: string;
|
|
408
|
-
/**
|
|
409
|
-
* Last update timestamp
|
|
410
|
-
*/
|
|
411
|
-
updatedAt: string;
|
|
412
|
-
[k: string]: unknown;
|
|
162
|
+
updatedAt: string;
|
|
163
|
+
[k: string]: unknown;
|
|
413
164
|
}
|
|
414
165
|
}
|
|
415
166
|
}
|
|
@@ -521,277 +272,59 @@ export declare namespace SubscriptionListResponse {
|
|
|
521
272
|
/**
|
|
522
273
|
* Response object
|
|
523
274
|
*/
|
|
524
|
-
export interface
|
|
275
|
+
export interface SubscriptionImportResponse {
|
|
276
|
+
data: SubscriptionImportResponse.Data;
|
|
277
|
+
}
|
|
278
|
+
export declare namespace SubscriptionImportResponse {
|
|
279
|
+
interface Data {
|
|
280
|
+
/**
|
|
281
|
+
* Unique identifier for the import task
|
|
282
|
+
*/
|
|
283
|
+
taskId: string;
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* Response object
|
|
288
|
+
*/
|
|
289
|
+
export interface SubscriptionPreviewResponse {
|
|
525
290
|
/**
|
|
526
|
-
*
|
|
291
|
+
* Pricing preview with invoices
|
|
527
292
|
*/
|
|
528
|
-
data:
|
|
293
|
+
data: SubscriptionPreviewResponse.Data;
|
|
529
294
|
}
|
|
530
|
-
export declare namespace
|
|
295
|
+
export declare namespace SubscriptionPreviewResponse {
|
|
531
296
|
/**
|
|
532
|
-
*
|
|
297
|
+
* Pricing preview with invoices
|
|
533
298
|
*/
|
|
534
299
|
interface Data {
|
|
535
300
|
/**
|
|
536
|
-
*
|
|
537
|
-
*/
|
|
538
|
-
id: string;
|
|
539
|
-
/**
|
|
540
|
-
* Billing ID
|
|
541
|
-
*/
|
|
542
|
-
billingId: string | null;
|
|
543
|
-
/**
|
|
544
|
-
* Created at
|
|
545
|
-
*/
|
|
546
|
-
createdAt: string;
|
|
547
|
-
/**
|
|
548
|
-
* Customer ID
|
|
549
|
-
*/
|
|
550
|
-
customerId: string;
|
|
551
|
-
/**
|
|
552
|
-
* Payment collection
|
|
553
|
-
*/
|
|
554
|
-
paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
|
|
555
|
-
/**
|
|
556
|
-
* Plan ID
|
|
557
|
-
*/
|
|
558
|
-
planId: string;
|
|
559
|
-
/**
|
|
560
|
-
* Pricing type
|
|
561
|
-
*/
|
|
562
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
563
|
-
/**
|
|
564
|
-
* Subscription start date
|
|
565
|
-
*/
|
|
566
|
-
startDate: string;
|
|
567
|
-
/**
|
|
568
|
-
* Subscription status
|
|
569
|
-
*/
|
|
570
|
-
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
571
|
-
/**
|
|
572
|
-
* Subscription cancellation date
|
|
573
|
-
*/
|
|
574
|
-
cancellationDate?: string | null;
|
|
575
|
-
/**
|
|
576
|
-
* Subscription cancel reason
|
|
301
|
+
* Invoice due immediately
|
|
577
302
|
*/
|
|
578
|
-
|
|
303
|
+
immediateInvoice: Data.ImmediateInvoice;
|
|
579
304
|
/**
|
|
580
|
-
*
|
|
305
|
+
* Billing period range
|
|
581
306
|
*/
|
|
582
|
-
|
|
307
|
+
billingPeriodRange?: Data.BillingPeriodRange;
|
|
583
308
|
/**
|
|
584
|
-
*
|
|
309
|
+
* Free items included
|
|
585
310
|
*/
|
|
586
|
-
|
|
311
|
+
freeItems?: Array<Data.FreeItem>;
|
|
587
312
|
/**
|
|
588
|
-
*
|
|
313
|
+
* Whether updates are scheduled
|
|
589
314
|
*/
|
|
590
|
-
|
|
315
|
+
hasScheduledUpdates?: boolean;
|
|
591
316
|
/**
|
|
592
|
-
*
|
|
317
|
+
* Whether this is a downgrade
|
|
593
318
|
*/
|
|
594
|
-
|
|
319
|
+
isPlanDowngrade?: boolean;
|
|
595
320
|
/**
|
|
596
|
-
*
|
|
321
|
+
* Recurring invoice preview
|
|
597
322
|
*/
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
323
|
+
recurringInvoice?: Data.RecurringInvoice;
|
|
324
|
+
}
|
|
325
|
+
namespace Data {
|
|
601
326
|
/**
|
|
602
|
-
*
|
|
603
|
-
*/
|
|
604
|
-
payingCustomerId?: string | null;
|
|
605
|
-
/**
|
|
606
|
-
* The method used to collect payments for a subscription
|
|
607
|
-
*/
|
|
608
|
-
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
|
|
609
|
-
prices?: Array<Data.Price>;
|
|
610
|
-
/**
|
|
611
|
-
* Resource ID
|
|
612
|
-
*/
|
|
613
|
-
resourceId?: string | null;
|
|
614
|
-
/**
|
|
615
|
-
* Subscription trial end date
|
|
616
|
-
*/
|
|
617
|
-
trialEndDate?: string | null;
|
|
618
|
-
}
|
|
619
|
-
namespace Data {
|
|
620
|
-
interface Price {
|
|
621
|
-
/**
|
|
622
|
-
* Price ID
|
|
623
|
-
*/
|
|
624
|
-
id: string;
|
|
625
|
-
/**
|
|
626
|
-
* Creation timestamp
|
|
627
|
-
*/
|
|
628
|
-
createdAt: string;
|
|
629
|
-
/**
|
|
630
|
-
* Last update timestamp
|
|
631
|
-
*/
|
|
632
|
-
updatedAt: string;
|
|
633
|
-
[k: string]: unknown;
|
|
634
|
-
}
|
|
635
|
-
}
|
|
636
|
-
}
|
|
637
|
-
/**
|
|
638
|
-
* Response object
|
|
639
|
-
*/
|
|
640
|
-
export interface SubscriptionMigrateResponse {
|
|
641
|
-
/**
|
|
642
|
-
* Customer subscription to a plan
|
|
643
|
-
*/
|
|
644
|
-
data: SubscriptionMigrateResponse.Data;
|
|
645
|
-
}
|
|
646
|
-
export declare namespace SubscriptionMigrateResponse {
|
|
647
|
-
/**
|
|
648
|
-
* Customer subscription to a plan
|
|
649
|
-
*/
|
|
650
|
-
interface Data {
|
|
651
|
-
/**
|
|
652
|
-
* Subscription ID
|
|
653
|
-
*/
|
|
654
|
-
id: string;
|
|
655
|
-
/**
|
|
656
|
-
* Billing ID
|
|
657
|
-
*/
|
|
658
|
-
billingId: string | null;
|
|
659
|
-
/**
|
|
660
|
-
* Created at
|
|
661
|
-
*/
|
|
662
|
-
createdAt: string;
|
|
663
|
-
/**
|
|
664
|
-
* Customer ID
|
|
665
|
-
*/
|
|
666
|
-
customerId: string;
|
|
667
|
-
/**
|
|
668
|
-
* Payment collection
|
|
669
|
-
*/
|
|
670
|
-
paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
|
|
671
|
-
/**
|
|
672
|
-
* Plan ID
|
|
673
|
-
*/
|
|
674
|
-
planId: string;
|
|
675
|
-
/**
|
|
676
|
-
* Pricing type
|
|
677
|
-
*/
|
|
678
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
679
|
-
/**
|
|
680
|
-
* Subscription start date
|
|
681
|
-
*/
|
|
682
|
-
startDate: string;
|
|
683
|
-
/**
|
|
684
|
-
* Subscription status
|
|
685
|
-
*/
|
|
686
|
-
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
687
|
-
/**
|
|
688
|
-
* Subscription cancellation date
|
|
689
|
-
*/
|
|
690
|
-
cancellationDate?: string | null;
|
|
691
|
-
/**
|
|
692
|
-
* Subscription cancel reason
|
|
693
|
-
*/
|
|
694
|
-
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
695
|
-
/**
|
|
696
|
-
* End of the current billing period
|
|
697
|
-
*/
|
|
698
|
-
currentBillingPeriodEnd?: string | null;
|
|
699
|
-
/**
|
|
700
|
-
* Start of the current billing period
|
|
701
|
-
*/
|
|
702
|
-
currentBillingPeriodStart?: string | null;
|
|
703
|
-
/**
|
|
704
|
-
* Subscription effective end date
|
|
705
|
-
*/
|
|
706
|
-
effectiveEndDate?: string | null;
|
|
707
|
-
/**
|
|
708
|
-
* Subscription end date
|
|
709
|
-
*/
|
|
710
|
-
endDate?: string | null;
|
|
711
|
-
/**
|
|
712
|
-
* Additional metadata for the subscription
|
|
713
|
-
*/
|
|
714
|
-
metadata?: {
|
|
715
|
-
[key: string]: string;
|
|
716
|
-
};
|
|
717
|
-
/**
|
|
718
|
-
* Paying customer ID for delegated billing
|
|
719
|
-
*/
|
|
720
|
-
payingCustomerId?: string | null;
|
|
721
|
-
/**
|
|
722
|
-
* The method used to collect payments for a subscription
|
|
723
|
-
*/
|
|
724
|
-
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
|
|
725
|
-
prices?: Array<Data.Price>;
|
|
726
|
-
/**
|
|
727
|
-
* Resource ID
|
|
728
|
-
*/
|
|
729
|
-
resourceId?: string | null;
|
|
730
|
-
/**
|
|
731
|
-
* Subscription trial end date
|
|
732
|
-
*/
|
|
733
|
-
trialEndDate?: string | null;
|
|
734
|
-
}
|
|
735
|
-
namespace Data {
|
|
736
|
-
interface Price {
|
|
737
|
-
/**
|
|
738
|
-
* Price ID
|
|
739
|
-
*/
|
|
740
|
-
id: string;
|
|
741
|
-
/**
|
|
742
|
-
* Creation timestamp
|
|
743
|
-
*/
|
|
744
|
-
createdAt: string;
|
|
745
|
-
/**
|
|
746
|
-
* Last update timestamp
|
|
747
|
-
*/
|
|
748
|
-
updatedAt: string;
|
|
749
|
-
[k: string]: unknown;
|
|
750
|
-
}
|
|
751
|
-
}
|
|
752
|
-
}
|
|
753
|
-
/**
|
|
754
|
-
* Response object
|
|
755
|
-
*/
|
|
756
|
-
export interface SubscriptionPreviewResponse {
|
|
757
|
-
/**
|
|
758
|
-
* Pricing preview with invoices
|
|
759
|
-
*/
|
|
760
|
-
data: SubscriptionPreviewResponse.Data;
|
|
761
|
-
}
|
|
762
|
-
export declare namespace SubscriptionPreviewResponse {
|
|
763
|
-
/**
|
|
764
|
-
* Pricing preview with invoices
|
|
765
|
-
*/
|
|
766
|
-
interface Data {
|
|
767
|
-
/**
|
|
768
|
-
* Invoice due immediately
|
|
769
|
-
*/
|
|
770
|
-
immediateInvoice: Data.ImmediateInvoice;
|
|
771
|
-
/**
|
|
772
|
-
* Billing period range
|
|
773
|
-
*/
|
|
774
|
-
billingPeriodRange?: Data.BillingPeriodRange;
|
|
775
|
-
/**
|
|
776
|
-
* Free items included
|
|
777
|
-
*/
|
|
778
|
-
freeItems?: Array<Data.FreeItem>;
|
|
779
|
-
/**
|
|
780
|
-
* Whether updates are scheduled
|
|
781
|
-
*/
|
|
782
|
-
hasScheduledUpdates?: boolean;
|
|
783
|
-
/**
|
|
784
|
-
* Whether this is a downgrade
|
|
785
|
-
*/
|
|
786
|
-
isPlanDowngrade?: boolean;
|
|
787
|
-
/**
|
|
788
|
-
* Recurring invoice preview
|
|
789
|
-
*/
|
|
790
|
-
recurringInvoice?: Data.RecurringInvoice;
|
|
791
|
-
}
|
|
792
|
-
namespace Data {
|
|
793
|
-
/**
|
|
794
|
-
* Invoice due immediately
|
|
327
|
+
* Invoice due immediately
|
|
795
328
|
*/
|
|
796
329
|
interface ImmediateInvoice {
|
|
797
330
|
/**
|
|
@@ -1051,73 +584,498 @@ export declare namespace SubscriptionPreviewResponse {
|
|
|
1051
584
|
/**
|
|
1052
585
|
* Response object
|
|
1053
586
|
*/
|
|
1054
|
-
export interface
|
|
587
|
+
export interface SubscriptionProvisionResponse {
|
|
1055
588
|
/**
|
|
1056
|
-
*
|
|
589
|
+
* Provisioning result with status and subscription or checkout URL.
|
|
1057
590
|
*/
|
|
1058
|
-
data:
|
|
591
|
+
data: SubscriptionProvisionResponse.Data;
|
|
1059
592
|
}
|
|
1060
|
-
export declare namespace
|
|
593
|
+
export declare namespace SubscriptionProvisionResponse {
|
|
1061
594
|
/**
|
|
1062
|
-
*
|
|
595
|
+
* Provisioning result with status and subscription or checkout URL.
|
|
1063
596
|
*/
|
|
1064
597
|
interface Data {
|
|
1065
598
|
/**
|
|
1066
|
-
*
|
|
599
|
+
* Unique identifier for the provisioned subscription
|
|
1067
600
|
*/
|
|
1068
601
|
id: string;
|
|
602
|
+
entitlements: Array<Data.Entitlement>;
|
|
1069
603
|
/**
|
|
1070
|
-
*
|
|
604
|
+
* Provision status: SUCCESS or PAYMENT_REQUIRED
|
|
1071
605
|
*/
|
|
1072
|
-
|
|
606
|
+
status: 'SUCCESS' | 'PAYMENT_REQUIRED';
|
|
1073
607
|
/**
|
|
1074
|
-
*
|
|
608
|
+
* Checkout billing ID when payment is required
|
|
1075
609
|
*/
|
|
1076
|
-
|
|
610
|
+
checkoutBillingId?: string | null;
|
|
611
|
+
/**
|
|
612
|
+
* URL to complete payment when PAYMENT_REQUIRED
|
|
613
|
+
*/
|
|
614
|
+
checkoutUrl?: string | null;
|
|
615
|
+
/**
|
|
616
|
+
* Whether the subscription is scheduled for future activation
|
|
617
|
+
*/
|
|
618
|
+
isScheduled?: boolean;
|
|
619
|
+
/**
|
|
620
|
+
* Created subscription (when status is SUCCESS)
|
|
621
|
+
*/
|
|
622
|
+
subscription?: Data.Subscription;
|
|
623
|
+
}
|
|
624
|
+
namespace Data {
|
|
625
|
+
interface Entitlement {
|
|
626
|
+
accessDeniedReason?: string | null;
|
|
627
|
+
currentUsage?: number;
|
|
628
|
+
/**
|
|
629
|
+
* entitlement updated at
|
|
630
|
+
*/
|
|
631
|
+
entitlementUpdatedAt?: string | null;
|
|
632
|
+
feature?: Entitlement.Feature | null;
|
|
633
|
+
hasUnlimitedUsage?: boolean | null;
|
|
634
|
+
isGranted?: boolean;
|
|
635
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
|
|
636
|
+
usageLimit?: number | null;
|
|
637
|
+
/**
|
|
638
|
+
* usage period anchor
|
|
639
|
+
*/
|
|
640
|
+
usagePeriodAnchor?: string | null;
|
|
641
|
+
/**
|
|
642
|
+
* usage period end
|
|
643
|
+
*/
|
|
644
|
+
usagePeriodEnd?: string | null;
|
|
645
|
+
/**
|
|
646
|
+
* usage period start
|
|
647
|
+
*/
|
|
648
|
+
usagePeriodStart?: string | null;
|
|
649
|
+
}
|
|
650
|
+
namespace Entitlement {
|
|
651
|
+
interface Feature {
|
|
652
|
+
/**
|
|
653
|
+
* Feature ID
|
|
654
|
+
*/
|
|
655
|
+
refId: string;
|
|
656
|
+
}
|
|
657
|
+
}
|
|
658
|
+
/**
|
|
659
|
+
* Created subscription (when status is SUCCESS)
|
|
660
|
+
*/
|
|
661
|
+
interface Subscription {
|
|
662
|
+
/**
|
|
663
|
+
* Subscription ID
|
|
664
|
+
*/
|
|
665
|
+
id: string;
|
|
666
|
+
/**
|
|
667
|
+
* Billing ID
|
|
668
|
+
*/
|
|
669
|
+
billingId: string | null;
|
|
670
|
+
/**
|
|
671
|
+
* Created at
|
|
672
|
+
*/
|
|
673
|
+
createdAt: string;
|
|
674
|
+
/**
|
|
675
|
+
* Customer ID
|
|
676
|
+
*/
|
|
677
|
+
customerId: string;
|
|
678
|
+
/**
|
|
679
|
+
* Payment collection
|
|
680
|
+
*/
|
|
681
|
+
paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
|
|
682
|
+
/**
|
|
683
|
+
* Plan ID
|
|
684
|
+
*/
|
|
685
|
+
planId: string;
|
|
686
|
+
/**
|
|
687
|
+
* Pricing type
|
|
688
|
+
*/
|
|
689
|
+
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
690
|
+
/**
|
|
691
|
+
* Subscription start date
|
|
692
|
+
*/
|
|
693
|
+
startDate: string;
|
|
694
|
+
/**
|
|
695
|
+
* Subscription status
|
|
696
|
+
*/
|
|
697
|
+
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
698
|
+
/**
|
|
699
|
+
* Subscription cancellation date
|
|
700
|
+
*/
|
|
701
|
+
cancellationDate?: string | null;
|
|
702
|
+
/**
|
|
703
|
+
* Subscription cancel reason
|
|
704
|
+
*/
|
|
705
|
+
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
706
|
+
/**
|
|
707
|
+
* End of the current billing period
|
|
708
|
+
*/
|
|
709
|
+
currentBillingPeriodEnd?: string | null;
|
|
710
|
+
/**
|
|
711
|
+
* Start of the current billing period
|
|
712
|
+
*/
|
|
713
|
+
currentBillingPeriodStart?: string | null;
|
|
714
|
+
/**
|
|
715
|
+
* Subscription effective end date
|
|
716
|
+
*/
|
|
717
|
+
effectiveEndDate?: string | null;
|
|
718
|
+
/**
|
|
719
|
+
* Subscription end date
|
|
720
|
+
*/
|
|
721
|
+
endDate?: string | null;
|
|
722
|
+
/**
|
|
723
|
+
* Additional metadata for the subscription
|
|
724
|
+
*/
|
|
725
|
+
metadata?: {
|
|
726
|
+
[key: string]: string;
|
|
727
|
+
};
|
|
728
|
+
/**
|
|
729
|
+
* Paying customer ID for delegated billing
|
|
730
|
+
*/
|
|
731
|
+
payingCustomerId?: string | null;
|
|
732
|
+
/**
|
|
733
|
+
* The method used to collect payments for a subscription
|
|
734
|
+
*/
|
|
735
|
+
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
|
|
736
|
+
prices?: Array<Subscription.Price>;
|
|
737
|
+
/**
|
|
738
|
+
* Resource ID
|
|
739
|
+
*/
|
|
740
|
+
resourceId?: string | null;
|
|
741
|
+
/**
|
|
742
|
+
* Subscription trial end date
|
|
743
|
+
*/
|
|
744
|
+
trialEndDate?: string | null;
|
|
745
|
+
}
|
|
746
|
+
namespace Subscription {
|
|
747
|
+
interface Price {
|
|
748
|
+
/**
|
|
749
|
+
* Addon identifier for the price override
|
|
750
|
+
*/
|
|
751
|
+
addonId?: string | null;
|
|
752
|
+
/**
|
|
753
|
+
* Whether this is a base charge override
|
|
754
|
+
*/
|
|
755
|
+
baseCharge?: boolean;
|
|
756
|
+
/**
|
|
757
|
+
* Block size for pricing
|
|
758
|
+
*/
|
|
759
|
+
blockSize?: number;
|
|
760
|
+
/**
|
|
761
|
+
* Feature identifier for the price override
|
|
762
|
+
*/
|
|
763
|
+
featureId?: string | null;
|
|
764
|
+
/**
|
|
765
|
+
* Override price amount
|
|
766
|
+
*/
|
|
767
|
+
price?: Price.Price;
|
|
768
|
+
/**
|
|
769
|
+
* Pricing tiers configuration
|
|
770
|
+
*/
|
|
771
|
+
tiers?: Array<Price.Tier>;
|
|
772
|
+
}
|
|
773
|
+
namespace Price {
|
|
774
|
+
/**
|
|
775
|
+
* Override price amount
|
|
776
|
+
*/
|
|
777
|
+
interface Price {
|
|
778
|
+
/**
|
|
779
|
+
* The price amount
|
|
780
|
+
*/
|
|
781
|
+
amount?: number;
|
|
782
|
+
/**
|
|
783
|
+
* The billing country code of the price
|
|
784
|
+
*/
|
|
785
|
+
billingCountryCode?: string | null;
|
|
786
|
+
/**
|
|
787
|
+
* The price currency
|
|
788
|
+
*/
|
|
789
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
790
|
+
}
|
|
791
|
+
interface Tier {
|
|
792
|
+
/**
|
|
793
|
+
* The flat fee price of the price tier
|
|
794
|
+
*/
|
|
795
|
+
flatPrice?: Tier.FlatPrice;
|
|
796
|
+
/**
|
|
797
|
+
* The unit price of the price tier
|
|
798
|
+
*/
|
|
799
|
+
unitPrice?: Tier.UnitPrice;
|
|
800
|
+
/**
|
|
801
|
+
* The up to quantity of the price tier
|
|
802
|
+
*/
|
|
803
|
+
upTo?: number;
|
|
804
|
+
}
|
|
805
|
+
namespace Tier {
|
|
806
|
+
/**
|
|
807
|
+
* The flat fee price of the price tier
|
|
808
|
+
*/
|
|
809
|
+
interface FlatPrice {
|
|
810
|
+
/**
|
|
811
|
+
* The price amount
|
|
812
|
+
*/
|
|
813
|
+
amount?: number;
|
|
814
|
+
/**
|
|
815
|
+
* The billing country code of the price
|
|
816
|
+
*/
|
|
817
|
+
billingCountryCode?: string | null;
|
|
818
|
+
/**
|
|
819
|
+
* The price currency
|
|
820
|
+
*/
|
|
821
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
822
|
+
}
|
|
823
|
+
/**
|
|
824
|
+
* The unit price of the price tier
|
|
825
|
+
*/
|
|
826
|
+
interface UnitPrice {
|
|
827
|
+
/**
|
|
828
|
+
* The price amount
|
|
829
|
+
*/
|
|
830
|
+
amount?: number;
|
|
831
|
+
/**
|
|
832
|
+
* The billing country code of the price
|
|
833
|
+
*/
|
|
834
|
+
billingCountryCode?: string | null;
|
|
835
|
+
/**
|
|
836
|
+
* The price currency
|
|
837
|
+
*/
|
|
838
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
839
|
+
}
|
|
840
|
+
}
|
|
841
|
+
}
|
|
842
|
+
}
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
export interface SubscriptionUpdateParams {
|
|
846
|
+
addons?: Array<SubscriptionUpdateParams.Addon>;
|
|
847
|
+
appliedCoupon?: SubscriptionUpdateParams.AppliedCoupon;
|
|
848
|
+
awaitPaymentConfirmation?: boolean;
|
|
849
|
+
billingInformation?: SubscriptionUpdateParams.BillingInformation;
|
|
850
|
+
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
851
|
+
budget?: SubscriptionUpdateParams.Budget | null;
|
|
852
|
+
charges?: Array<SubscriptionUpdateParams.Charge>;
|
|
853
|
+
/**
|
|
854
|
+
* Additional metadata for the subscription
|
|
855
|
+
*/
|
|
856
|
+
metadata?: {
|
|
857
|
+
[key: string]: string;
|
|
858
|
+
};
|
|
859
|
+
minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
|
|
860
|
+
priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
|
|
861
|
+
promotionCode?: string;
|
|
862
|
+
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
863
|
+
subscriptionEntitlements?: Array<SubscriptionUpdateParams.SubscriptionEntitlement>;
|
|
864
|
+
/**
|
|
865
|
+
* Subscription trial end date
|
|
866
|
+
*/
|
|
867
|
+
trialEndDate?: string;
|
|
868
|
+
}
|
|
869
|
+
export declare namespace SubscriptionUpdateParams {
|
|
870
|
+
interface Addon {
|
|
871
|
+
/**
|
|
872
|
+
* Addon ID
|
|
873
|
+
*/
|
|
874
|
+
addonId: string;
|
|
875
|
+
quantity: number;
|
|
876
|
+
}
|
|
877
|
+
interface AppliedCoupon {
|
|
878
|
+
billingCouponId?: string;
|
|
879
|
+
configuration?: AppliedCoupon.Configuration;
|
|
880
|
+
couponId?: string;
|
|
881
|
+
discount?: AppliedCoupon.Discount;
|
|
882
|
+
promotionCode?: string | null;
|
|
883
|
+
}
|
|
884
|
+
namespace AppliedCoupon {
|
|
885
|
+
interface Configuration {
|
|
886
|
+
/**
|
|
887
|
+
* Coupon start date
|
|
888
|
+
*/
|
|
889
|
+
startDate?: string;
|
|
890
|
+
}
|
|
891
|
+
interface Discount {
|
|
892
|
+
amountsOff?: Array<Discount.AmountsOff> | null;
|
|
893
|
+
description?: string;
|
|
894
|
+
durationInMonths?: number;
|
|
895
|
+
name?: string;
|
|
896
|
+
percentOff?: number;
|
|
897
|
+
}
|
|
898
|
+
namespace Discount {
|
|
899
|
+
interface AmountsOff {
|
|
900
|
+
amount: number;
|
|
901
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
902
|
+
}
|
|
903
|
+
}
|
|
904
|
+
}
|
|
905
|
+
interface BillingInformation {
|
|
906
|
+
/**
|
|
907
|
+
* Physical address
|
|
908
|
+
*/
|
|
909
|
+
billingAddress?: BillingInformation.BillingAddress;
|
|
910
|
+
chargeOnBehalfOfAccount?: string;
|
|
911
|
+
couponId?: string;
|
|
912
|
+
integrationId?: string;
|
|
913
|
+
invoiceDaysUntilDue?: number;
|
|
914
|
+
isBackdated?: boolean;
|
|
915
|
+
isInvoicePaid?: boolean;
|
|
916
|
+
/**
|
|
917
|
+
* Additional metadata for the subscription
|
|
918
|
+
*/
|
|
919
|
+
metadata?: {
|
|
920
|
+
[key: string]: unknown;
|
|
921
|
+
};
|
|
922
|
+
prorationBehavior?: 'INVOICE_IMMEDIATELY' | 'CREATE_PRORATIONS' | 'NONE';
|
|
923
|
+
taxIds?: Array<BillingInformation.TaxID>;
|
|
924
|
+
taxPercentage?: number;
|
|
925
|
+
taxRateIds?: Array<string>;
|
|
926
|
+
}
|
|
927
|
+
namespace BillingInformation {
|
|
928
|
+
/**
|
|
929
|
+
* Physical address
|
|
930
|
+
*/
|
|
931
|
+
interface BillingAddress {
|
|
932
|
+
/**
|
|
933
|
+
* City name
|
|
934
|
+
*/
|
|
935
|
+
city?: string;
|
|
936
|
+
/**
|
|
937
|
+
* Country code or name
|
|
938
|
+
*/
|
|
939
|
+
country?: string;
|
|
940
|
+
/**
|
|
941
|
+
* Street address line 1
|
|
942
|
+
*/
|
|
943
|
+
line1?: string;
|
|
944
|
+
/**
|
|
945
|
+
* Street address line 2
|
|
946
|
+
*/
|
|
947
|
+
line2?: string;
|
|
948
|
+
/**
|
|
949
|
+
* Postal or ZIP code
|
|
950
|
+
*/
|
|
951
|
+
postalCode?: string;
|
|
952
|
+
/**
|
|
953
|
+
* State or province
|
|
954
|
+
*/
|
|
955
|
+
state?: string;
|
|
956
|
+
}
|
|
957
|
+
interface TaxID {
|
|
958
|
+
type: string;
|
|
959
|
+
value: string;
|
|
960
|
+
}
|
|
961
|
+
}
|
|
962
|
+
interface Budget {
|
|
963
|
+
hasSoftLimit: boolean;
|
|
964
|
+
limit: number;
|
|
965
|
+
}
|
|
966
|
+
interface Charge {
|
|
967
|
+
/**
|
|
968
|
+
* Charge ID
|
|
969
|
+
*/
|
|
970
|
+
id: string;
|
|
971
|
+
quantity: number;
|
|
972
|
+
type: 'FEATURE' | 'CREDIT';
|
|
973
|
+
}
|
|
974
|
+
interface MinimumSpend {
|
|
975
|
+
minimum?: MinimumSpend.Minimum | null;
|
|
976
|
+
}
|
|
977
|
+
namespace MinimumSpend {
|
|
978
|
+
interface Minimum {
|
|
979
|
+
amount: number;
|
|
980
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
981
|
+
}
|
|
982
|
+
}
|
|
983
|
+
interface PriceOverride {
|
|
984
|
+
/**
|
|
985
|
+
* Feature ID
|
|
986
|
+
*/
|
|
987
|
+
featureId: string;
|
|
988
|
+
price?: PriceOverride.Price;
|
|
989
|
+
}
|
|
990
|
+
namespace PriceOverride {
|
|
991
|
+
interface Price {
|
|
992
|
+
amount: number;
|
|
993
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
994
|
+
}
|
|
995
|
+
}
|
|
996
|
+
interface SubscriptionEntitlement {
|
|
997
|
+
id?: string;
|
|
998
|
+
featureId?: string;
|
|
999
|
+
hasSoftLimit?: boolean;
|
|
1000
|
+
hasUnlimitedUsage?: boolean;
|
|
1001
|
+
monthlyResetPeriodConfiguration?: SubscriptionEntitlement.MonthlyResetPeriodConfiguration;
|
|
1002
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
|
|
1003
|
+
usageLimit?: number;
|
|
1004
|
+
weeklyResetPeriodConfiguration?: SubscriptionEntitlement.WeeklyResetPeriodConfiguration;
|
|
1005
|
+
yearlyResetPeriodConfiguration?: SubscriptionEntitlement.YearlyResetPeriodConfiguration;
|
|
1006
|
+
}
|
|
1007
|
+
namespace SubscriptionEntitlement {
|
|
1008
|
+
interface MonthlyResetPeriodConfiguration {
|
|
1009
|
+
accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
|
|
1010
|
+
}
|
|
1011
|
+
interface WeeklyResetPeriodConfiguration {
|
|
1012
|
+
accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
|
|
1013
|
+
}
|
|
1014
|
+
interface YearlyResetPeriodConfiguration {
|
|
1015
|
+
accordingTo: 'SubscriptionStart';
|
|
1016
|
+
}
|
|
1017
|
+
}
|
|
1018
|
+
}
|
|
1019
|
+
export interface SubscriptionListParams extends MyCursorIDPageParams {
|
|
1020
|
+
/**
|
|
1021
|
+
* Filter by customer ID
|
|
1022
|
+
*/
|
|
1023
|
+
customerId?: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* Filter by status (comma-separated)
|
|
1026
|
+
*/
|
|
1027
|
+
status?: string;
|
|
1028
|
+
}
|
|
1029
|
+
export interface SubscriptionCancelParams {
|
|
1030
|
+
/**
|
|
1031
|
+
* Action on cancellation (downgrade or revoke)
|
|
1032
|
+
*/
|
|
1033
|
+
cancellationAction?: 'DEFAULT' | 'REVOKE_ENTITLEMENTS';
|
|
1034
|
+
/**
|
|
1035
|
+
* When to cancel (immediate, period end, or date)
|
|
1036
|
+
*/
|
|
1037
|
+
cancellationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
|
|
1038
|
+
/**
|
|
1039
|
+
* Subscription end date
|
|
1040
|
+
*/
|
|
1041
|
+
endDate?: string;
|
|
1042
|
+
/**
|
|
1043
|
+
* If set, enables or disables prorating of credits on subscription cancellation.
|
|
1044
|
+
*/
|
|
1045
|
+
prorate?: boolean;
|
|
1046
|
+
}
|
|
1047
|
+
export interface SubscriptionDelegateParams {
|
|
1048
|
+
/**
|
|
1049
|
+
* The unique identifier of the customer who will assume payment responsibility for
|
|
1050
|
+
* this subscription. This customer must already exist in your Stigg account and
|
|
1051
|
+
* have a valid payment method if the subscription requires payment.
|
|
1052
|
+
*/
|
|
1053
|
+
targetCustomerId: string;
|
|
1054
|
+
}
|
|
1055
|
+
export interface SubscriptionImportParams {
|
|
1056
|
+
/**
|
|
1057
|
+
* List of subscription objects to import
|
|
1058
|
+
*/
|
|
1059
|
+
subscriptions: Array<SubscriptionImportParams.Subscription>;
|
|
1060
|
+
}
|
|
1061
|
+
export declare namespace SubscriptionImportParams {
|
|
1062
|
+
interface Subscription {
|
|
1063
|
+
/**
|
|
1064
|
+
* Subscription ID
|
|
1065
|
+
*/
|
|
1066
|
+
id: string;
|
|
1077
1067
|
/**
|
|
1078
1068
|
* Customer ID
|
|
1079
1069
|
*/
|
|
1080
1070
|
customerId: string;
|
|
1081
|
-
/**
|
|
1082
|
-
* Payment collection
|
|
1083
|
-
*/
|
|
1084
|
-
paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
|
|
1085
1071
|
/**
|
|
1086
1072
|
* Plan ID
|
|
1087
1073
|
*/
|
|
1088
1074
|
planId: string;
|
|
1089
1075
|
/**
|
|
1090
|
-
*
|
|
1091
|
-
*/
|
|
1092
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
1093
|
-
/**
|
|
1094
|
-
* Subscription start date
|
|
1095
|
-
*/
|
|
1096
|
-
startDate: string;
|
|
1097
|
-
/**
|
|
1098
|
-
* Subscription status
|
|
1099
|
-
*/
|
|
1100
|
-
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
1101
|
-
/**
|
|
1102
|
-
* Subscription cancellation date
|
|
1103
|
-
*/
|
|
1104
|
-
cancellationDate?: string | null;
|
|
1105
|
-
/**
|
|
1106
|
-
* Subscription cancel reason
|
|
1107
|
-
*/
|
|
1108
|
-
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
1109
|
-
/**
|
|
1110
|
-
* End of the current billing period
|
|
1111
|
-
*/
|
|
1112
|
-
currentBillingPeriodEnd?: string | null;
|
|
1113
|
-
/**
|
|
1114
|
-
* Start of the current billing period
|
|
1115
|
-
*/
|
|
1116
|
-
currentBillingPeriodStart?: string | null;
|
|
1117
|
-
/**
|
|
1118
|
-
* Subscription effective end date
|
|
1076
|
+
* Billing ID
|
|
1119
1077
|
*/
|
|
1120
|
-
|
|
1078
|
+
billingId?: string | null;
|
|
1121
1079
|
/**
|
|
1122
1080
|
* Subscription end date
|
|
1123
1081
|
*/
|
|
@@ -1128,135 +1086,100 @@ export declare namespace SubscriptionTransferResponse {
|
|
|
1128
1086
|
metadata?: {
|
|
1129
1087
|
[key: string]: string;
|
|
1130
1088
|
};
|
|
1131
|
-
/**
|
|
1132
|
-
* Paying customer ID for delegated billing
|
|
1133
|
-
*/
|
|
1134
|
-
payingCustomerId?: string | null;
|
|
1135
|
-
/**
|
|
1136
|
-
* The method used to collect payments for a subscription
|
|
1137
|
-
*/
|
|
1138
|
-
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
|
|
1139
|
-
prices?: Array<Data.Price>;
|
|
1140
1089
|
/**
|
|
1141
1090
|
* Resource ID
|
|
1142
1091
|
*/
|
|
1143
1092
|
resourceId?: string | null;
|
|
1144
1093
|
/**
|
|
1145
|
-
* Subscription
|
|
1094
|
+
* Subscription start date
|
|
1146
1095
|
*/
|
|
1147
|
-
|
|
1148
|
-
}
|
|
1149
|
-
namespace Data {
|
|
1150
|
-
interface Price {
|
|
1151
|
-
/**
|
|
1152
|
-
* Price ID
|
|
1153
|
-
*/
|
|
1154
|
-
id: string;
|
|
1155
|
-
/**
|
|
1156
|
-
* Creation timestamp
|
|
1157
|
-
*/
|
|
1158
|
-
createdAt: string;
|
|
1159
|
-
/**
|
|
1160
|
-
* Last update timestamp
|
|
1161
|
-
*/
|
|
1162
|
-
updatedAt: string;
|
|
1163
|
-
[k: string]: unknown;
|
|
1164
|
-
}
|
|
1096
|
+
startDate?: string;
|
|
1165
1097
|
}
|
|
1166
1098
|
}
|
|
1167
|
-
export interface
|
|
1099
|
+
export interface SubscriptionMigrateParams {
|
|
1168
1100
|
/**
|
|
1169
|
-
*
|
|
1101
|
+
* When to migrate (immediate or period end)
|
|
1102
|
+
*/
|
|
1103
|
+
subscriptionMigrationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE';
|
|
1104
|
+
}
|
|
1105
|
+
export interface SubscriptionPreviewParams {
|
|
1106
|
+
/**
|
|
1107
|
+
* Customer ID
|
|
1170
1108
|
*/
|
|
1171
1109
|
customerId: string;
|
|
1172
1110
|
/**
|
|
1173
|
-
* Plan ID
|
|
1111
|
+
* Plan ID
|
|
1174
1112
|
*/
|
|
1175
1113
|
planId: string;
|
|
1176
1114
|
/**
|
|
1177
|
-
*
|
|
1115
|
+
* Addons to include
|
|
1178
1116
|
*/
|
|
1179
|
-
|
|
1180
|
-
addons?: Array<SubscriptionCreateParams.Addon>;
|
|
1117
|
+
addons?: Array<SubscriptionPreviewParams.Addon>;
|
|
1181
1118
|
/**
|
|
1182
|
-
* Coupon
|
|
1119
|
+
* Coupon or discount to apply
|
|
1183
1120
|
*/
|
|
1184
|
-
appliedCoupon?:
|
|
1121
|
+
appliedCoupon?: SubscriptionPreviewParams.AppliedCoupon;
|
|
1185
1122
|
/**
|
|
1186
|
-
*
|
|
1123
|
+
* Billable features with quantities
|
|
1187
1124
|
*/
|
|
1188
|
-
|
|
1125
|
+
billableFeatures?: Array<SubscriptionPreviewParams.BillableFeature>;
|
|
1189
1126
|
/**
|
|
1190
|
-
*
|
|
1127
|
+
* ISO 3166-1 country code for localization
|
|
1191
1128
|
*/
|
|
1192
|
-
billingCountryCode?: string
|
|
1129
|
+
billingCountryCode?: string;
|
|
1193
1130
|
/**
|
|
1194
|
-
*
|
|
1131
|
+
* Billing and tax configuration
|
|
1195
1132
|
*/
|
|
1196
|
-
|
|
1197
|
-
billingInformation?: SubscriptionCreateParams.BillingInformation;
|
|
1133
|
+
billingInformation?: SubscriptionPreviewParams.BillingInformation;
|
|
1198
1134
|
/**
|
|
1199
1135
|
* Billing period (MONTHLY or ANNUALLY)
|
|
1200
1136
|
*/
|
|
1201
1137
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
1202
|
-
budget?: SubscriptionCreateParams.Budget | null;
|
|
1203
|
-
charges?: Array<SubscriptionCreateParams.Charge>;
|
|
1204
|
-
/**
|
|
1205
|
-
* Checkout page configuration for payment collection
|
|
1206
|
-
*/
|
|
1207
|
-
checkoutOptions?: SubscriptionCreateParams.CheckoutOptions;
|
|
1208
|
-
/**
|
|
1209
|
-
* Additional metadata for the subscription
|
|
1210
|
-
*/
|
|
1211
|
-
metadata?: {
|
|
1212
|
-
[key: string]: string;
|
|
1213
|
-
};
|
|
1214
|
-
minimumSpend?: SubscriptionCreateParams.MinimumSpend | null;
|
|
1215
|
-
/**
|
|
1216
|
-
* Optional paying customer ID for split billing scenarios
|
|
1217
|
-
*/
|
|
1218
|
-
payingCustomerId?: string | null;
|
|
1219
1138
|
/**
|
|
1220
|
-
*
|
|
1139
|
+
* One-time or recurring charges
|
|
1221
1140
|
*/
|
|
1222
|
-
|
|
1223
|
-
priceOverrides?: Array<SubscriptionCreateParams.PriceOverride>;
|
|
1141
|
+
charges?: Array<SubscriptionPreviewParams.Charge>;
|
|
1224
1142
|
/**
|
|
1225
|
-
*
|
|
1143
|
+
* Paying customer ID for delegated billing
|
|
1226
1144
|
*/
|
|
1227
|
-
|
|
1145
|
+
payingCustomerId?: string;
|
|
1228
1146
|
/**
|
|
1229
|
-
*
|
|
1147
|
+
* Resource ID for multi-instance subscriptions
|
|
1230
1148
|
*/
|
|
1231
|
-
|
|
1149
|
+
resourceId?: string;
|
|
1232
1150
|
/**
|
|
1233
|
-
*
|
|
1151
|
+
* When to apply subscription changes
|
|
1234
1152
|
*/
|
|
1235
1153
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
1236
1154
|
/**
|
|
1237
1155
|
* Subscription start date
|
|
1238
1156
|
*/
|
|
1239
1157
|
startDate?: string;
|
|
1240
|
-
subscriptionEntitlements?: Array<SubscriptionCreateParams.SubscriptionEntitlement>;
|
|
1241
1158
|
/**
|
|
1242
1159
|
* Trial period override settings
|
|
1243
1160
|
*/
|
|
1244
|
-
trialOverrideConfiguration?:
|
|
1161
|
+
trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
|
|
1162
|
+
/**
|
|
1163
|
+
* Unit quantity for per-unit pricing
|
|
1164
|
+
*/
|
|
1245
1165
|
unitQuantity?: number;
|
|
1246
1166
|
}
|
|
1247
|
-
export declare namespace
|
|
1167
|
+
export declare namespace SubscriptionPreviewParams {
|
|
1168
|
+
/**
|
|
1169
|
+
* Addon configuration
|
|
1170
|
+
*/
|
|
1248
1171
|
interface Addon {
|
|
1249
1172
|
/**
|
|
1250
|
-
* Addon
|
|
1173
|
+
* Addon ID
|
|
1251
1174
|
*/
|
|
1252
1175
|
addonId: string;
|
|
1253
1176
|
/**
|
|
1254
|
-
* Number of addon
|
|
1177
|
+
* Number of addon instances
|
|
1255
1178
|
*/
|
|
1256
1179
|
quantity?: number;
|
|
1257
1180
|
}
|
|
1258
1181
|
/**
|
|
1259
|
-
* Coupon
|
|
1182
|
+
* Coupon or discount to apply
|
|
1260
1183
|
*/
|
|
1261
1184
|
interface AppliedCoupon {
|
|
1262
1185
|
/**
|
|
@@ -1328,401 +1251,222 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1328
1251
|
}
|
|
1329
1252
|
}
|
|
1330
1253
|
}
|
|
1331
|
-
interface BillingInformation {
|
|
1332
|
-
/**
|
|
1333
|
-
* Billing address for the subscription
|
|
1334
|
-
*/
|
|
1335
|
-
billingAddress?: BillingInformation.BillingAddress;
|
|
1336
|
-
/**
|
|
1337
|
-
* Stripe Connect account to charge on behalf of
|
|
1338
|
-
*/
|
|
1339
|
-
chargeOnBehalfOfAccount?: string | null;
|
|
1340
|
-
/**
|
|
1341
|
-
* Billing integration identifier
|
|
1342
|
-
*/
|
|
1343
|
-
integrationId?: string | null;
|
|
1344
|
-
/**
|
|
1345
|
-
* Number of days until invoice is due
|
|
1346
|
-
*/
|
|
1347
|
-
invoiceDaysUntilDue?: number;
|
|
1348
|
-
/**
|
|
1349
|
-
* Whether the subscription is backdated
|
|
1350
|
-
*/
|
|
1351
|
-
isBackdated?: boolean;
|
|
1352
|
-
/**
|
|
1353
|
-
* Whether the invoice is marked as paid
|
|
1354
|
-
*/
|
|
1355
|
-
isInvoicePaid?: boolean;
|
|
1356
|
-
/**
|
|
1357
|
-
* Additional metadata for the subscription
|
|
1358
|
-
*/
|
|
1359
|
-
metadata?: {
|
|
1360
|
-
[key: string]: string;
|
|
1361
|
-
};
|
|
1362
|
-
/**
|
|
1363
|
-
* How to handle proration for billing changes
|
|
1364
|
-
*/
|
|
1365
|
-
prorationBehavior?: 'INVOICE_IMMEDIATELY' | 'CREATE_PRORATIONS' | 'NONE';
|
|
1366
|
-
/**
|
|
1367
|
-
* Customer tax identification numbers
|
|
1368
|
-
*/
|
|
1369
|
-
taxIds?: Array<BillingInformation.TaxID>;
|
|
1370
|
-
/**
|
|
1371
|
-
* Tax percentage (0-100)
|
|
1372
|
-
*/
|
|
1373
|
-
taxPercentage?: number;
|
|
1374
|
-
/**
|
|
1375
|
-
* Tax rate identifiers to apply
|
|
1376
|
-
*/
|
|
1377
|
-
taxRateIds?: Array<string>;
|
|
1378
|
-
}
|
|
1379
|
-
namespace BillingInformation {
|
|
1380
|
-
/**
|
|
1381
|
-
* Billing address for the subscription
|
|
1382
|
-
*/
|
|
1383
|
-
interface BillingAddress {
|
|
1384
|
-
city?: string;
|
|
1385
|
-
country?: string;
|
|
1386
|
-
line1?: string;
|
|
1387
|
-
line2?: string;
|
|
1388
|
-
postalCode?: string;
|
|
1389
|
-
state?: string;
|
|
1390
|
-
}
|
|
1391
|
-
interface TaxID {
|
|
1392
|
-
/**
|
|
1393
|
-
* The type of tax exemption identifier, such as VAT.
|
|
1394
|
-
*/
|
|
1395
|
-
type: string;
|
|
1396
|
-
/**
|
|
1397
|
-
* The actual tax identifier value
|
|
1398
|
-
*/
|
|
1399
|
-
value: string;
|
|
1400
|
-
}
|
|
1401
|
-
}
|
|
1402
|
-
interface Budget {
|
|
1403
|
-
/**
|
|
1404
|
-
* Whether the budget is a soft limit
|
|
1405
|
-
*/
|
|
1406
|
-
hasSoftLimit: boolean;
|
|
1407
|
-
/**
|
|
1408
|
-
* Maximum spending limit
|
|
1409
|
-
*/
|
|
1410
|
-
limit: number;
|
|
1411
|
-
}
|
|
1412
1254
|
/**
|
|
1413
|
-
*
|
|
1255
|
+
* Feature with quantity
|
|
1414
1256
|
*/
|
|
1415
|
-
interface
|
|
1257
|
+
interface BillableFeature {
|
|
1416
1258
|
/**
|
|
1417
|
-
*
|
|
1259
|
+
* Feature ID
|
|
1418
1260
|
*/
|
|
1419
|
-
|
|
1261
|
+
featureId: string;
|
|
1420
1262
|
/**
|
|
1421
|
-
*
|
|
1263
|
+
* Quantity of feature units
|
|
1422
1264
|
*/
|
|
1423
1265
|
quantity: number;
|
|
1424
|
-
/**
|
|
1425
|
-
* Charge type
|
|
1426
|
-
*/
|
|
1427
|
-
type: 'FEATURE' | 'CREDIT';
|
|
1428
1266
|
}
|
|
1429
1267
|
/**
|
|
1430
|
-
*
|
|
1268
|
+
* Billing and tax configuration
|
|
1431
1269
|
*/
|
|
1432
|
-
interface
|
|
1433
|
-
/**
|
|
1434
|
-
* URL to redirect to if checkout is canceled
|
|
1435
|
-
*/
|
|
1436
|
-
cancelUrl: string;
|
|
1437
|
-
/**
|
|
1438
|
-
* URL to redirect to after successful checkout
|
|
1439
|
-
*/
|
|
1440
|
-
successUrl: string;
|
|
1441
|
-
/**
|
|
1442
|
-
* Allow promotional codes during checkout
|
|
1443
|
-
*/
|
|
1444
|
-
allowPromoCodes?: boolean;
|
|
1445
|
-
/**
|
|
1446
|
-
* Allow tax ID collection during checkout
|
|
1447
|
-
*/
|
|
1448
|
-
allowTaxIdCollection?: boolean;
|
|
1270
|
+
interface BillingInformation {
|
|
1449
1271
|
/**
|
|
1450
|
-
*
|
|
1272
|
+
* Billing address
|
|
1451
1273
|
*/
|
|
1452
|
-
|
|
1274
|
+
billingAddress?: BillingInformation.BillingAddress;
|
|
1453
1275
|
/**
|
|
1454
|
-
*
|
|
1276
|
+
* Connected account ID for platform billing
|
|
1455
1277
|
*/
|
|
1456
|
-
|
|
1278
|
+
chargeOnBehalfOfAccount?: string;
|
|
1457
1279
|
/**
|
|
1458
|
-
*
|
|
1280
|
+
* Billing integration ID
|
|
1459
1281
|
*/
|
|
1460
|
-
|
|
1461
|
-
}
|
|
1462
|
-
interface MinimumSpend {
|
|
1282
|
+
integrationId?: string;
|
|
1463
1283
|
/**
|
|
1464
|
-
*
|
|
1284
|
+
* Days until invoice is due
|
|
1465
1285
|
*/
|
|
1466
|
-
|
|
1467
|
-
}
|
|
1468
|
-
namespace MinimumSpend {
|
|
1286
|
+
invoiceDaysUntilDue?: number;
|
|
1469
1287
|
/**
|
|
1470
|
-
*
|
|
1288
|
+
* Whether subscription is backdated
|
|
1471
1289
|
*/
|
|
1472
|
-
|
|
1473
|
-
/**
|
|
1474
|
-
* The price amount
|
|
1475
|
-
*/
|
|
1476
|
-
amount?: number;
|
|
1477
|
-
/**
|
|
1478
|
-
* The billing country code of the price
|
|
1479
|
-
*/
|
|
1480
|
-
billingCountryCode?: string | null;
|
|
1481
|
-
/**
|
|
1482
|
-
* The price currency
|
|
1483
|
-
*/
|
|
1484
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1485
|
-
}
|
|
1486
|
-
}
|
|
1487
|
-
interface PriceOverride {
|
|
1290
|
+
isBackdated?: boolean;
|
|
1488
1291
|
/**
|
|
1489
|
-
*
|
|
1292
|
+
* Whether invoice is already paid
|
|
1490
1293
|
*/
|
|
1491
|
-
|
|
1294
|
+
isInvoicePaid?: boolean;
|
|
1492
1295
|
/**
|
|
1493
|
-
*
|
|
1296
|
+
* Additional billing metadata
|
|
1494
1297
|
*/
|
|
1495
|
-
|
|
1298
|
+
metadata?: unknown;
|
|
1496
1299
|
/**
|
|
1497
|
-
*
|
|
1300
|
+
* Proration behavior
|
|
1498
1301
|
*/
|
|
1499
|
-
|
|
1500
|
-
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
1501
|
-
creditRate?: PriceOverride.CreditRate;
|
|
1302
|
+
prorationBehavior?: 'INVOICE_IMMEDIATELY' | 'CREATE_PRORATIONS' | 'NONE';
|
|
1502
1303
|
/**
|
|
1503
|
-
*
|
|
1304
|
+
* Customer tax IDs
|
|
1504
1305
|
*/
|
|
1505
|
-
|
|
1306
|
+
taxIds?: Array<BillingInformation.TaxID>;
|
|
1506
1307
|
/**
|
|
1507
|
-
*
|
|
1308
|
+
* Tax percentage to apply
|
|
1508
1309
|
*/
|
|
1509
|
-
|
|
1310
|
+
taxPercentage?: number;
|
|
1510
1311
|
/**
|
|
1511
|
-
*
|
|
1312
|
+
* Tax rate IDs from billing provider
|
|
1512
1313
|
*/
|
|
1513
|
-
|
|
1314
|
+
taxRateIds?: Array<string>;
|
|
1514
1315
|
}
|
|
1515
|
-
namespace
|
|
1516
|
-
interface CreditRate {
|
|
1517
|
-
/**
|
|
1518
|
-
* The credit rate amount
|
|
1519
|
-
*/
|
|
1520
|
-
amount: number;
|
|
1521
|
-
/**
|
|
1522
|
-
* The custom currency refId for the credit rate
|
|
1523
|
-
*/
|
|
1524
|
-
currencyId: string;
|
|
1525
|
-
/**
|
|
1526
|
-
* A custom formula for calculating cost based on single event dimensions
|
|
1527
|
-
*/
|
|
1528
|
-
costFormula?: string | null;
|
|
1529
|
-
}
|
|
1316
|
+
namespace BillingInformation {
|
|
1530
1317
|
/**
|
|
1531
|
-
*
|
|
1318
|
+
* Billing address
|
|
1532
1319
|
*/
|
|
1533
|
-
interface
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
*/
|
|
1541
|
-
billingCountryCode?: string | null;
|
|
1542
|
-
/**
|
|
1543
|
-
* The price currency
|
|
1544
|
-
*/
|
|
1545
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1546
|
-
}
|
|
1547
|
-
interface Tier {
|
|
1548
|
-
/**
|
|
1549
|
-
* The flat fee price of the price tier
|
|
1550
|
-
*/
|
|
1551
|
-
flatPrice?: Tier.FlatPrice;
|
|
1552
|
-
/**
|
|
1553
|
-
* The unit price of the price tier
|
|
1554
|
-
*/
|
|
1555
|
-
unitPrice?: Tier.UnitPrice;
|
|
1556
|
-
/**
|
|
1557
|
-
* The up to quantity of the price tier
|
|
1558
|
-
*/
|
|
1559
|
-
upTo?: number;
|
|
1320
|
+
interface BillingAddress {
|
|
1321
|
+
city?: string;
|
|
1322
|
+
country?: string;
|
|
1323
|
+
line1?: string;
|
|
1324
|
+
line2?: string;
|
|
1325
|
+
postalCode?: string;
|
|
1326
|
+
state?: string;
|
|
1560
1327
|
}
|
|
1561
|
-
|
|
1328
|
+
/**
|
|
1329
|
+
* Tax exemption identifier
|
|
1330
|
+
*/
|
|
1331
|
+
interface TaxID {
|
|
1562
1332
|
/**
|
|
1563
|
-
*
|
|
1333
|
+
* Tax exemption type (e.g., vat, gst)
|
|
1564
1334
|
*/
|
|
1565
|
-
|
|
1566
|
-
/**
|
|
1567
|
-
* The price amount
|
|
1568
|
-
*/
|
|
1569
|
-
amount?: number;
|
|
1570
|
-
/**
|
|
1571
|
-
* The billing country code of the price
|
|
1572
|
-
*/
|
|
1573
|
-
billingCountryCode?: string | null;
|
|
1574
|
-
/**
|
|
1575
|
-
* The price currency
|
|
1576
|
-
*/
|
|
1577
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1578
|
-
}
|
|
1335
|
+
type: string;
|
|
1579
1336
|
/**
|
|
1580
|
-
*
|
|
1337
|
+
* Tax exemption identifier value
|
|
1581
1338
|
*/
|
|
1582
|
-
|
|
1583
|
-
/**
|
|
1584
|
-
* The price amount
|
|
1585
|
-
*/
|
|
1586
|
-
amount?: number;
|
|
1587
|
-
/**
|
|
1588
|
-
* The billing country code of the price
|
|
1589
|
-
*/
|
|
1590
|
-
billingCountryCode?: string | null;
|
|
1591
|
-
/**
|
|
1592
|
-
* The price currency
|
|
1593
|
-
*/
|
|
1594
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1595
|
-
}
|
|
1339
|
+
value: string;
|
|
1596
1340
|
}
|
|
1597
1341
|
}
|
|
1598
|
-
|
|
1342
|
+
/**
|
|
1343
|
+
* Charge item
|
|
1344
|
+
*/
|
|
1345
|
+
interface Charge {
|
|
1599
1346
|
/**
|
|
1600
|
-
*
|
|
1347
|
+
* Charge ID
|
|
1601
1348
|
*/
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1349
|
+
id: string;
|
|
1350
|
+
/**
|
|
1351
|
+
* Charge quantity
|
|
1352
|
+
*/
|
|
1353
|
+
quantity: number;
|
|
1354
|
+
/**
|
|
1355
|
+
* Charge type
|
|
1356
|
+
*/
|
|
1357
|
+
type: 'FEATURE' | 'CREDIT';
|
|
1605
1358
|
}
|
|
1606
1359
|
/**
|
|
1607
1360
|
* Trial period override settings
|
|
1608
1361
|
*/
|
|
1609
1362
|
interface TrialOverrideConfiguration {
|
|
1610
1363
|
/**
|
|
1611
|
-
* Whether
|
|
1364
|
+
* Whether to start as trial
|
|
1612
1365
|
*/
|
|
1613
1366
|
isTrial: boolean;
|
|
1614
1367
|
/**
|
|
1615
|
-
* Behavior when trial ends
|
|
1368
|
+
* Behavior when trial ends
|
|
1616
1369
|
*/
|
|
1617
1370
|
trialEndBehavior?: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
|
|
1618
1371
|
/**
|
|
1619
|
-
*
|
|
1372
|
+
* Trial end date
|
|
1620
1373
|
*/
|
|
1621
1374
|
trialEndDate?: string;
|
|
1622
1375
|
}
|
|
1623
1376
|
}
|
|
1624
|
-
export interface
|
|
1377
|
+
export interface SubscriptionProvisionParams {
|
|
1625
1378
|
/**
|
|
1626
|
-
*
|
|
1627
|
-
*/
|
|
1628
|
-
customerId?: string;
|
|
1629
|
-
/**
|
|
1630
|
-
* Filter by status (comma-separated)
|
|
1379
|
+
* Customer ID to provision the subscription for
|
|
1631
1380
|
*/
|
|
1632
|
-
|
|
1633
|
-
}
|
|
1634
|
-
export interface SubscriptionDelegateParams {
|
|
1381
|
+
customerId: string;
|
|
1635
1382
|
/**
|
|
1636
|
-
*
|
|
1637
|
-
* this subscription. This customer must already exist in your Stigg account and
|
|
1638
|
-
* have a valid payment method if the subscription requires payment.
|
|
1383
|
+
* Plan ID to provision
|
|
1639
1384
|
*/
|
|
1640
|
-
|
|
1641
|
-
}
|
|
1642
|
-
export interface SubscriptionMigrateParams {
|
|
1385
|
+
planId: string;
|
|
1643
1386
|
/**
|
|
1644
|
-
*
|
|
1387
|
+
* Unique identifier for the subscription
|
|
1645
1388
|
*/
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
export interface SubscriptionPreviewParams {
|
|
1389
|
+
id?: string;
|
|
1390
|
+
addons?: Array<SubscriptionProvisionParams.Addon>;
|
|
1649
1391
|
/**
|
|
1650
|
-
*
|
|
1392
|
+
* Coupon configuration
|
|
1651
1393
|
*/
|
|
1652
|
-
|
|
1394
|
+
appliedCoupon?: SubscriptionProvisionParams.AppliedCoupon;
|
|
1653
1395
|
/**
|
|
1654
|
-
*
|
|
1396
|
+
* Whether to wait for payment confirmation before returning the subscription
|
|
1655
1397
|
*/
|
|
1656
|
-
|
|
1398
|
+
awaitPaymentConfirmation?: boolean;
|
|
1657
1399
|
/**
|
|
1658
|
-
*
|
|
1400
|
+
* The ISO 3166-1 alpha-2 country code for billing
|
|
1659
1401
|
*/
|
|
1660
|
-
|
|
1402
|
+
billingCountryCode?: string | null;
|
|
1661
1403
|
/**
|
|
1662
|
-
*
|
|
1404
|
+
* External billing system identifier
|
|
1663
1405
|
*/
|
|
1664
|
-
|
|
1406
|
+
billingId?: string | null;
|
|
1407
|
+
billingInformation?: SubscriptionProvisionParams.BillingInformation;
|
|
1665
1408
|
/**
|
|
1666
|
-
*
|
|
1409
|
+
* Billing period (MONTHLY or ANNUALLY)
|
|
1667
1410
|
*/
|
|
1668
|
-
|
|
1411
|
+
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
1412
|
+
budget?: SubscriptionProvisionParams.Budget | null;
|
|
1413
|
+
charges?: Array<SubscriptionProvisionParams.Charge>;
|
|
1669
1414
|
/**
|
|
1670
|
-
*
|
|
1415
|
+
* Checkout page configuration for payment collection
|
|
1671
1416
|
*/
|
|
1672
|
-
|
|
1417
|
+
checkoutOptions?: SubscriptionProvisionParams.CheckoutOptions;
|
|
1673
1418
|
/**
|
|
1674
|
-
*
|
|
1419
|
+
* Additional metadata for the subscription
|
|
1675
1420
|
*/
|
|
1676
|
-
|
|
1421
|
+
metadata?: {
|
|
1422
|
+
[key: string]: string;
|
|
1423
|
+
};
|
|
1424
|
+
minimumSpend?: SubscriptionProvisionParams.MinimumSpend | null;
|
|
1677
1425
|
/**
|
|
1678
|
-
*
|
|
1426
|
+
* Optional paying customer ID for split billing scenarios
|
|
1679
1427
|
*/
|
|
1680
|
-
|
|
1428
|
+
payingCustomerId?: string | null;
|
|
1681
1429
|
/**
|
|
1682
|
-
*
|
|
1430
|
+
* How payments should be collected for this subscription
|
|
1683
1431
|
*/
|
|
1684
|
-
|
|
1432
|
+
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE';
|
|
1433
|
+
priceOverrides?: Array<SubscriptionProvisionParams.PriceOverride>;
|
|
1685
1434
|
/**
|
|
1686
|
-
*
|
|
1435
|
+
* Optional resource ID for multi-instance subscriptions
|
|
1687
1436
|
*/
|
|
1688
|
-
|
|
1437
|
+
resourceId?: string | null;
|
|
1689
1438
|
/**
|
|
1690
|
-
*
|
|
1439
|
+
* Salesforce ID
|
|
1691
1440
|
*/
|
|
1692
|
-
|
|
1441
|
+
salesforceId?: string | null;
|
|
1693
1442
|
/**
|
|
1694
|
-
*
|
|
1443
|
+
* Strategy for scheduling subscription changes
|
|
1695
1444
|
*/
|
|
1696
1445
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
1697
1446
|
/**
|
|
1698
1447
|
* Subscription start date
|
|
1699
1448
|
*/
|
|
1700
1449
|
startDate?: string;
|
|
1450
|
+
subscriptionEntitlements?: Array<SubscriptionProvisionParams.SubscriptionEntitlement>;
|
|
1701
1451
|
/**
|
|
1702
1452
|
* Trial period override settings
|
|
1703
1453
|
*/
|
|
1704
|
-
trialOverrideConfiguration?:
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
unitQuantity?: number;
|
|
1709
|
-
}
|
|
1710
|
-
export declare namespace SubscriptionPreviewParams {
|
|
1711
|
-
/**
|
|
1712
|
-
* Addon configuration
|
|
1713
|
-
*/
|
|
1454
|
+
trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
|
|
1455
|
+
unitQuantity?: number;
|
|
1456
|
+
}
|
|
1457
|
+
export declare namespace SubscriptionProvisionParams {
|
|
1714
1458
|
interface Addon {
|
|
1715
1459
|
/**
|
|
1716
|
-
* Addon
|
|
1460
|
+
* Addon identifier
|
|
1717
1461
|
*/
|
|
1718
1462
|
addonId: string;
|
|
1719
1463
|
/**
|
|
1720
|
-
* Number of addon
|
|
1464
|
+
* Number of addon units
|
|
1721
1465
|
*/
|
|
1722
1466
|
quantity?: number;
|
|
1723
1467
|
}
|
|
1724
1468
|
/**
|
|
1725
|
-
* Coupon
|
|
1469
|
+
* Coupon configuration
|
|
1726
1470
|
*/
|
|
1727
1471
|
interface AppliedCoupon {
|
|
1728
1472
|
/**
|
|
@@ -1794,71 +1538,57 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
1794
1538
|
}
|
|
1795
1539
|
}
|
|
1796
1540
|
}
|
|
1797
|
-
/**
|
|
1798
|
-
* Feature with quantity
|
|
1799
|
-
*/
|
|
1800
|
-
interface BillableFeature {
|
|
1801
|
-
/**
|
|
1802
|
-
* Feature ID
|
|
1803
|
-
*/
|
|
1804
|
-
featureId: string;
|
|
1805
|
-
/**
|
|
1806
|
-
* Quantity of feature units
|
|
1807
|
-
*/
|
|
1808
|
-
quantity: number;
|
|
1809
|
-
}
|
|
1810
|
-
/**
|
|
1811
|
-
* Billing and tax configuration
|
|
1812
|
-
*/
|
|
1813
1541
|
interface BillingInformation {
|
|
1814
1542
|
/**
|
|
1815
|
-
* Billing address
|
|
1543
|
+
* Billing address for the subscription
|
|
1816
1544
|
*/
|
|
1817
1545
|
billingAddress?: BillingInformation.BillingAddress;
|
|
1818
1546
|
/**
|
|
1819
|
-
*
|
|
1547
|
+
* Stripe Connect account to charge on behalf of
|
|
1820
1548
|
*/
|
|
1821
|
-
chargeOnBehalfOfAccount?: string;
|
|
1549
|
+
chargeOnBehalfOfAccount?: string | null;
|
|
1822
1550
|
/**
|
|
1823
|
-
* Billing integration
|
|
1551
|
+
* Billing integration identifier
|
|
1824
1552
|
*/
|
|
1825
|
-
integrationId?: string;
|
|
1553
|
+
integrationId?: string | null;
|
|
1826
1554
|
/**
|
|
1827
|
-
*
|
|
1555
|
+
* Number of days until invoice is due
|
|
1828
1556
|
*/
|
|
1829
1557
|
invoiceDaysUntilDue?: number;
|
|
1830
1558
|
/**
|
|
1831
|
-
* Whether subscription is backdated
|
|
1559
|
+
* Whether the subscription is backdated
|
|
1832
1560
|
*/
|
|
1833
1561
|
isBackdated?: boolean;
|
|
1834
1562
|
/**
|
|
1835
|
-
* Whether invoice is
|
|
1563
|
+
* Whether the invoice is marked as paid
|
|
1836
1564
|
*/
|
|
1837
1565
|
isInvoicePaid?: boolean;
|
|
1838
1566
|
/**
|
|
1839
|
-
* Additional
|
|
1567
|
+
* Additional metadata for the subscription
|
|
1840
1568
|
*/
|
|
1841
|
-
metadata?:
|
|
1569
|
+
metadata?: {
|
|
1570
|
+
[key: string]: string;
|
|
1571
|
+
};
|
|
1842
1572
|
/**
|
|
1843
|
-
*
|
|
1573
|
+
* How to handle proration for billing changes
|
|
1844
1574
|
*/
|
|
1845
1575
|
prorationBehavior?: 'INVOICE_IMMEDIATELY' | 'CREATE_PRORATIONS' | 'NONE';
|
|
1846
1576
|
/**
|
|
1847
|
-
* Customer tax
|
|
1577
|
+
* Customer tax identification numbers
|
|
1848
1578
|
*/
|
|
1849
1579
|
taxIds?: Array<BillingInformation.TaxID>;
|
|
1850
1580
|
/**
|
|
1851
|
-
* Tax percentage
|
|
1581
|
+
* Tax percentage (0-100)
|
|
1852
1582
|
*/
|
|
1853
1583
|
taxPercentage?: number;
|
|
1854
1584
|
/**
|
|
1855
|
-
* Tax rate
|
|
1585
|
+
* Tax rate identifiers to apply
|
|
1856
1586
|
*/
|
|
1857
1587
|
taxRateIds?: Array<string>;
|
|
1858
1588
|
}
|
|
1859
1589
|
namespace BillingInformation {
|
|
1860
1590
|
/**
|
|
1861
|
-
* Billing address
|
|
1591
|
+
* Billing address for the subscription
|
|
1862
1592
|
*/
|
|
1863
1593
|
interface BillingAddress {
|
|
1864
1594
|
city?: string;
|
|
@@ -1868,20 +1598,27 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
1868
1598
|
postalCode?: string;
|
|
1869
1599
|
state?: string;
|
|
1870
1600
|
}
|
|
1871
|
-
/**
|
|
1872
|
-
* Tax exemption identifier
|
|
1873
|
-
*/
|
|
1874
1601
|
interface TaxID {
|
|
1875
1602
|
/**
|
|
1876
|
-
*
|
|
1603
|
+
* The type of tax exemption identifier, such as VAT.
|
|
1877
1604
|
*/
|
|
1878
1605
|
type: string;
|
|
1879
1606
|
/**
|
|
1880
|
-
*
|
|
1607
|
+
* The actual tax identifier value
|
|
1881
1608
|
*/
|
|
1882
1609
|
value: string;
|
|
1883
1610
|
}
|
|
1884
1611
|
}
|
|
1612
|
+
interface Budget {
|
|
1613
|
+
/**
|
|
1614
|
+
* Whether the budget is a soft limit
|
|
1615
|
+
*/
|
|
1616
|
+
hasSoftLimit: boolean;
|
|
1617
|
+
/**
|
|
1618
|
+
* Maximum spending limit
|
|
1619
|
+
*/
|
|
1620
|
+
limit: number;
|
|
1621
|
+
}
|
|
1885
1622
|
/**
|
|
1886
1623
|
* Charge item
|
|
1887
1624
|
*/
|
|
@@ -1899,20 +1636,197 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
1899
1636
|
*/
|
|
1900
1637
|
type: 'FEATURE' | 'CREDIT';
|
|
1901
1638
|
}
|
|
1639
|
+
/**
|
|
1640
|
+
* Checkout page configuration for payment collection
|
|
1641
|
+
*/
|
|
1642
|
+
interface CheckoutOptions {
|
|
1643
|
+
/**
|
|
1644
|
+
* URL to redirect to if checkout is canceled
|
|
1645
|
+
*/
|
|
1646
|
+
cancelUrl: string;
|
|
1647
|
+
/**
|
|
1648
|
+
* URL to redirect to after successful checkout
|
|
1649
|
+
*/
|
|
1650
|
+
successUrl: string;
|
|
1651
|
+
/**
|
|
1652
|
+
* Allow promotional codes during checkout
|
|
1653
|
+
*/
|
|
1654
|
+
allowPromoCodes?: boolean;
|
|
1655
|
+
/**
|
|
1656
|
+
* Allow tax ID collection during checkout
|
|
1657
|
+
*/
|
|
1658
|
+
allowTaxIdCollection?: boolean;
|
|
1659
|
+
/**
|
|
1660
|
+
* Collect billing address during checkout
|
|
1661
|
+
*/
|
|
1662
|
+
collectBillingAddress?: boolean;
|
|
1663
|
+
/**
|
|
1664
|
+
* Collect phone number during checkout
|
|
1665
|
+
*/
|
|
1666
|
+
collectPhoneNumber?: boolean;
|
|
1667
|
+
/**
|
|
1668
|
+
* Optional reference ID for the checkout session
|
|
1669
|
+
*/
|
|
1670
|
+
referenceId?: string | null;
|
|
1671
|
+
}
|
|
1672
|
+
interface MinimumSpend {
|
|
1673
|
+
/**
|
|
1674
|
+
* Minimum spend amount
|
|
1675
|
+
*/
|
|
1676
|
+
minimum?: MinimumSpend.Minimum | null;
|
|
1677
|
+
}
|
|
1678
|
+
namespace MinimumSpend {
|
|
1679
|
+
/**
|
|
1680
|
+
* Minimum spend amount
|
|
1681
|
+
*/
|
|
1682
|
+
interface Minimum {
|
|
1683
|
+
/**
|
|
1684
|
+
* The price amount
|
|
1685
|
+
*/
|
|
1686
|
+
amount?: number;
|
|
1687
|
+
/**
|
|
1688
|
+
* The billing country code of the price
|
|
1689
|
+
*/
|
|
1690
|
+
billingCountryCode?: string | null;
|
|
1691
|
+
/**
|
|
1692
|
+
* The price currency
|
|
1693
|
+
*/
|
|
1694
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1695
|
+
}
|
|
1696
|
+
}
|
|
1697
|
+
interface PriceOverride {
|
|
1698
|
+
/**
|
|
1699
|
+
* Addon identifier for the price override
|
|
1700
|
+
*/
|
|
1701
|
+
addonId?: string | null;
|
|
1702
|
+
/**
|
|
1703
|
+
* Whether this is a base charge override
|
|
1704
|
+
*/
|
|
1705
|
+
baseCharge?: boolean;
|
|
1706
|
+
/**
|
|
1707
|
+
* Block size for pricing
|
|
1708
|
+
*/
|
|
1709
|
+
blockSize?: number;
|
|
1710
|
+
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
1711
|
+
creditRate?: PriceOverride.CreditRate;
|
|
1712
|
+
/**
|
|
1713
|
+
* Feature identifier for the price override
|
|
1714
|
+
*/
|
|
1715
|
+
featureId?: string | null;
|
|
1716
|
+
/**
|
|
1717
|
+
* Override price amount
|
|
1718
|
+
*/
|
|
1719
|
+
price?: PriceOverride.Price;
|
|
1720
|
+
/**
|
|
1721
|
+
* Pricing tiers configuration
|
|
1722
|
+
*/
|
|
1723
|
+
tiers?: Array<PriceOverride.Tier>;
|
|
1724
|
+
}
|
|
1725
|
+
namespace PriceOverride {
|
|
1726
|
+
interface CreditRate {
|
|
1727
|
+
/**
|
|
1728
|
+
* The credit rate amount
|
|
1729
|
+
*/
|
|
1730
|
+
amount: number;
|
|
1731
|
+
/**
|
|
1732
|
+
* The custom currency refId for the credit rate
|
|
1733
|
+
*/
|
|
1734
|
+
currencyId: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* A custom formula for calculating cost based on single event dimensions
|
|
1737
|
+
*/
|
|
1738
|
+
costFormula?: string | null;
|
|
1739
|
+
}
|
|
1740
|
+
/**
|
|
1741
|
+
* Override price amount
|
|
1742
|
+
*/
|
|
1743
|
+
interface Price {
|
|
1744
|
+
/**
|
|
1745
|
+
* The price amount
|
|
1746
|
+
*/
|
|
1747
|
+
amount?: number;
|
|
1748
|
+
/**
|
|
1749
|
+
* The billing country code of the price
|
|
1750
|
+
*/
|
|
1751
|
+
billingCountryCode?: string | null;
|
|
1752
|
+
/**
|
|
1753
|
+
* The price currency
|
|
1754
|
+
*/
|
|
1755
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1756
|
+
}
|
|
1757
|
+
interface Tier {
|
|
1758
|
+
/**
|
|
1759
|
+
* The flat fee price of the price tier
|
|
1760
|
+
*/
|
|
1761
|
+
flatPrice?: Tier.FlatPrice;
|
|
1762
|
+
/**
|
|
1763
|
+
* The unit price of the price tier
|
|
1764
|
+
*/
|
|
1765
|
+
unitPrice?: Tier.UnitPrice;
|
|
1766
|
+
/**
|
|
1767
|
+
* The up to quantity of the price tier
|
|
1768
|
+
*/
|
|
1769
|
+
upTo?: number;
|
|
1770
|
+
}
|
|
1771
|
+
namespace Tier {
|
|
1772
|
+
/**
|
|
1773
|
+
* The flat fee price of the price tier
|
|
1774
|
+
*/
|
|
1775
|
+
interface FlatPrice {
|
|
1776
|
+
/**
|
|
1777
|
+
* The price amount
|
|
1778
|
+
*/
|
|
1779
|
+
amount?: number;
|
|
1780
|
+
/**
|
|
1781
|
+
* The billing country code of the price
|
|
1782
|
+
*/
|
|
1783
|
+
billingCountryCode?: string | null;
|
|
1784
|
+
/**
|
|
1785
|
+
* The price currency
|
|
1786
|
+
*/
|
|
1787
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1788
|
+
}
|
|
1789
|
+
/**
|
|
1790
|
+
* The unit price of the price tier
|
|
1791
|
+
*/
|
|
1792
|
+
interface UnitPrice {
|
|
1793
|
+
/**
|
|
1794
|
+
* The price amount
|
|
1795
|
+
*/
|
|
1796
|
+
amount?: number;
|
|
1797
|
+
/**
|
|
1798
|
+
* The billing country code of the price
|
|
1799
|
+
*/
|
|
1800
|
+
billingCountryCode?: string | null;
|
|
1801
|
+
/**
|
|
1802
|
+
* The price currency
|
|
1803
|
+
*/
|
|
1804
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1805
|
+
}
|
|
1806
|
+
}
|
|
1807
|
+
}
|
|
1808
|
+
interface SubscriptionEntitlement {
|
|
1809
|
+
/**
|
|
1810
|
+
* Feature ID
|
|
1811
|
+
*/
|
|
1812
|
+
featureId: string;
|
|
1813
|
+
usageLimit: number;
|
|
1814
|
+
isGranted?: boolean;
|
|
1815
|
+
}
|
|
1902
1816
|
/**
|
|
1903
1817
|
* Trial period override settings
|
|
1904
1818
|
*/
|
|
1905
1819
|
interface TrialOverrideConfiguration {
|
|
1906
1820
|
/**
|
|
1907
|
-
* Whether
|
|
1821
|
+
* Whether the subscription should start with a trial period
|
|
1908
1822
|
*/
|
|
1909
1823
|
isTrial: boolean;
|
|
1910
1824
|
/**
|
|
1911
|
-
* Behavior when trial ends
|
|
1825
|
+
* Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION
|
|
1912
1826
|
*/
|
|
1913
1827
|
trialEndBehavior?: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
|
|
1914
1828
|
/**
|
|
1915
|
-
*
|
|
1829
|
+
* Custom trial end date
|
|
1916
1830
|
*/
|
|
1917
1831
|
trialEndDate?: string;
|
|
1918
1832
|
}
|
|
@@ -1924,7 +1838,7 @@ export interface SubscriptionTransferParams {
|
|
|
1924
1838
|
destinationResourceId: string;
|
|
1925
1839
|
}
|
|
1926
1840
|
export declare namespace Subscriptions {
|
|
1927
|
-
export { type
|
|
1928
|
-
export { FutureUpdate as FutureUpdate, type
|
|
1841
|
+
export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
|
|
1842
|
+
export { FutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription };
|
|
1929
1843
|
}
|
|
1930
1844
|
//# sourceMappingURL=subscriptions.d.ts.map
|