You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: types/V2/Billing/Intents.d.ts
+276Lines changed: 276 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,11 @@ declare module 'stripe' {
28
28
*/
29
29
cadence?: string;
30
30
31
+
/**
32
+
* Data for creating a new Cadence.
33
+
*/
34
+
cadence_data?: Intent.CadenceData;
35
+
31
36
/**
32
37
* Time at which the object was created.
33
38
*/
@@ -87,6 +92,277 @@ declare module 'stripe' {
87
92
total: string;
88
93
}
89
94
95
+
interfaceCadenceData{
96
+
/**
97
+
* The billing cycle configuration for this Cadence.
98
+
*/
99
+
billing_cycle: CadenceData.BillingCycle;
100
+
101
+
/**
102
+
* Information about the payer for this Cadence.
103
+
*/
104
+
payer: CadenceData.Payer;
105
+
106
+
/**
107
+
* Settings for creating the Cadence.
108
+
*/
109
+
settings?: CadenceData.Settings;
110
+
}
111
+
112
+
namespaceCadenceData{
113
+
interfaceBillingCycle{
114
+
/**
115
+
* The number of intervals (specified in the interval attribute) between cadence billings. For example, type=month and interval_count=3 bills every 3 months.
116
+
*/
117
+
interval_count: number;
118
+
119
+
/**
120
+
* The frequency at which a cadence bills.
121
+
*/
122
+
type: BillingCycle.Type;
123
+
124
+
/**
125
+
* Specific configuration for determining billing dates when type=day.
126
+
*/
127
+
day?: BillingCycle.Day;
128
+
129
+
/**
130
+
* Specific configuration for determining billing dates when type=month.
131
+
*/
132
+
month?: BillingCycle.Month;
133
+
134
+
/**
135
+
* Specific configuration for determining billing dates when type=week.
136
+
*/
137
+
week?: BillingCycle.Week;
138
+
139
+
/**
140
+
* Specific configuration for determining billing dates when type=year.
141
+
*/
142
+
year?: BillingCycle.Year;
143
+
}
144
+
145
+
namespaceBillingCycle{
146
+
interfaceDay{
147
+
/**
148
+
* The time at which the billing cycle ends.
149
+
*/
150
+
time: Day.Time;
151
+
}
152
+
153
+
namespaceDay{
154
+
interfaceTime{
155
+
/**
156
+
* The hour at which the billing cycle ends.
157
+
* This must be an integer between 0 and 23, inclusive.
158
+
* 0 represents midnight, and 23 represents 11 PM.
159
+
*/
160
+
hour: number;
161
+
162
+
/**
163
+
* The minute at which the billing cycle ends.
164
+
* Must be an integer between 0 and 59, inclusive.
165
+
*/
166
+
minute: number;
167
+
168
+
/**
169
+
* The second at which the billing cycle ends.
170
+
* Must be an integer between 0 and 59, inclusive.
171
+
*/
172
+
second?: number;
173
+
}
174
+
}
175
+
176
+
interfaceMonth{
177
+
/**
178
+
* The day to anchor the billing on for a type="month" billing cycle from 1-31.
179
+
* If this number is greater than the number of days in the month being billed,
180
+
* this will anchor to the last day of the month.
181
+
*/
182
+
day_of_month: number;
183
+
184
+
/**
185
+
* The month to anchor the billing on for a type="month" billing cycle from
186
+
* 1-12. Occurrences are calculated from the month anchor.
187
+
*/
188
+
month_of_year?: number;
189
+
190
+
/**
191
+
* The time at which the billing cycle ends.
192
+
*/
193
+
time: Month.Time;
194
+
}
195
+
196
+
namespaceMonth{
197
+
interfaceTime{
198
+
/**
199
+
* The hour at which the billing cycle ends.
200
+
* This must be an integer between 0 and 23, inclusive.
201
+
* 0 represents midnight, and 23 represents 11 PM.
202
+
*/
203
+
hour: number;
204
+
205
+
/**
206
+
* The minute at which the billing cycle ends.
207
+
* Must be an integer between 0 and 59, inclusive.
208
+
*/
209
+
minute: number;
210
+
211
+
/**
212
+
* The second at which the billing cycle ends.
213
+
* Must be an integer between 0 and 59, inclusive.
214
+
*/
215
+
second?: number;
216
+
}
217
+
}
218
+
219
+
typeType='day'|'month'|'week'|'year';
220
+
221
+
interfaceWeek{
222
+
/**
223
+
* The day of the week to bill the type=week billing cycle on.
224
+
* Numbered from 1-7 for Monday to Sunday respectively, based on the ISO-8601 week day numbering.
225
+
*/
226
+
day_of_week: number;
227
+
228
+
/**
229
+
* The time at which the billing cycle ends.
230
+
*/
231
+
time: Week.Time;
232
+
}
233
+
234
+
namespaceWeek{
235
+
interfaceTime{
236
+
/**
237
+
* The hour at which the billing cycle ends.
238
+
* This must be an integer between 0 and 23, inclusive.
239
+
* 0 represents midnight, and 23 represents 11 PM.
240
+
*/
241
+
hour: number;
242
+
243
+
/**
244
+
* The minute at which the billing cycle ends.
245
+
* Must be an integer between 0 and 59, inclusive.
246
+
*/
247
+
minute: number;
248
+
249
+
/**
250
+
* The second at which the billing cycle ends.
251
+
* Must be an integer between 0 and 59, inclusive.
252
+
*/
253
+
second?: number;
254
+
}
255
+
}
256
+
257
+
interfaceYear{
258
+
/**
259
+
* The day to anchor the billing on for a type="month" billing cycle from 1-31.
260
+
* If this number is greater than the number of days in the month being billed,
261
+
* this will anchor to the last day of the month.
262
+
*/
263
+
day_of_month: number;
264
+
265
+
/**
266
+
* The month to bill on from 1-12. If not provided, this will default to the month the cadence was created.
267
+
*/
268
+
month_of_year: number;
269
+
270
+
/**
271
+
* The time at which the billing cycle ends.
272
+
*/
273
+
time: Year.Time;
274
+
}
275
+
276
+
namespaceYear{
277
+
interfaceTime{
278
+
/**
279
+
* The hour at which the billing cycle ends.
280
+
* This must be an integer between 0 and 23, inclusive.
281
+
* 0 represents midnight, and 23 represents 11 PM.
282
+
*/
283
+
hour: number;
284
+
285
+
/**
286
+
* The minute at which the billing cycle ends.
287
+
* Must be an integer between 0 and 59, inclusive.
288
+
*/
289
+
minute: number;
290
+
291
+
/**
292
+
* The second at which the billing cycle ends.
293
+
* Must be an integer between 0 and 59, inclusive.
294
+
*/
295
+
second?: number;
296
+
}
297
+
}
298
+
}
299
+
300
+
interfacePayer{
301
+
/**
302
+
* The ID of the Billing Profile object which determines how a bill will be paid.
303
+
*/
304
+
billing_profile?: string;
305
+
306
+
/**
307
+
* Data for creating a new profile.
308
+
*/
309
+
billing_profile_data?: Payer.BillingProfileData;
310
+
}
311
+
312
+
namespacePayer{
313
+
interfaceBillingProfileData{
314
+
/**
315
+
* The customer to associate with the profile.
316
+
*/
317
+
customer: string;
318
+
319
+
/**
320
+
* The default payment method to use when billing this profile.
321
+
* If none is provided, the customer `default_payment_method` will be used.
322
+
*/
323
+
default_payment_method?: string;
324
+
}
325
+
}
326
+
327
+
interfaceSettings{
328
+
/**
329
+
* Settings that configure bills generation, which includes calculating totals, tax, and presenting invoices.
330
+
*/
331
+
bill?: Settings.Bill;
332
+
333
+
/**
334
+
* Settings that configure and manage the behavior of collecting payments.
335
+
*/
336
+
collection?: Settings.Collection;
337
+
}
338
+
339
+
namespaceSettings{
340
+
interfaceBill{
341
+
/**
342
+
* The ID of the referenced settings object.
343
+
*/
344
+
id: string;
345
+
346
+
/**
347
+
* Returns the Settings Version when the cadence is pinned to a specific version.
348
+
*/
349
+
version?: string;
350
+
}
351
+
352
+
interfaceCollection{
353
+
/**
354
+
* The ID of the referenced settings object.
355
+
*/
356
+
id: string;
357
+
358
+
/**
359
+
* Returns the Settings Version when the cadence is pinned to a specific version.
![stripe-openapi[bot]](https://avatars.githubusercontent.com/in/200680?v=4&size=40){kind=avatar}
0 commit comments