@openmeter/client 1.0.0-beta-d30d21dce71a → 1.0.0-beta-c725b4d6b371
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/dist/models/operations/addons.d.ts +12 -1
- package/dist/models/operations/currencies.d.ts +20 -3
- package/dist/models/operations/customers.d.ts +43 -6
- package/dist/models/operations/events.d.ts +17 -2
- package/dist/models/operations/features.d.ts +17 -2
- package/dist/models/operations/llmCost.d.ts +12 -1
- package/dist/models/operations/meters.d.ts +17 -2
- package/dist/models/operations/plans.d.ts +9 -1
- package/dist/models/operations/subscriptions.d.ts +21 -1
- package/dist/models/types.d.ts +2422 -454
- package/package.json +1 -1
package/dist/models/types.d.ts
CHANGED
|
@@ -1,4 +1,10 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/**
|
|
2
|
+
* Labels store metadata of an entity that can be used for filtering an entity list
|
|
3
|
+
* or for searching across entity types.
|
|
4
|
+
*
|
|
5
|
+
* Keys must be of length 1-63 characters, and cannot start with "kong", "konnect",
|
|
6
|
+
* "mesh", "kic", or "\_".
|
|
7
|
+
*/
|
|
2
8
|
export type Labels = Record<string, string>;
|
|
3
9
|
/** Determines which page of the collection to retrieve. */
|
|
4
10
|
export interface CursorPaginationQueryPage {
|
|
@@ -9,7 +15,12 @@ export interface CursorPaginationQueryPage {
|
|
|
9
15
|
/** Request the previous page of data, starting with the item before this parameter. */
|
|
10
16
|
before?: string;
|
|
11
17
|
}
|
|
12
|
-
/**
|
|
18
|
+
/**
|
|
19
|
+
* Sort query.
|
|
20
|
+
*
|
|
21
|
+
* The `asc` suffix is optional as the default sort order is ascending. The `desc`
|
|
22
|
+
* suffix is used to specify a descending order.
|
|
23
|
+
*/
|
|
13
24
|
export interface SortQuery {
|
|
14
25
|
/** The attribute to sort by. */
|
|
15
26
|
by: string;
|
|
@@ -42,7 +53,10 @@ export interface CursorMetaPage {
|
|
|
42
53
|
export interface BaseError {
|
|
43
54
|
/** Type contains a URI that identifies the problem type. */
|
|
44
55
|
type: string;
|
|
45
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* The HTTP status code generated by the origin server for this occurrence of the
|
|
58
|
+
* problem.
|
|
59
|
+
*/
|
|
46
60
|
status: number;
|
|
47
61
|
/** A a short, human-readable summary of the problem type. */
|
|
48
62
|
title: string;
|
|
@@ -61,7 +75,10 @@ export interface PageMeta {
|
|
|
61
75
|
/** Total number of items in the collection. */
|
|
62
76
|
total: number;
|
|
63
77
|
}
|
|
64
|
-
/**
|
|
78
|
+
/**
|
|
79
|
+
* A query filter for a string attribute. Operators are mutually exclusive, only
|
|
80
|
+
* one operator is allowed at a time.
|
|
81
|
+
*/
|
|
65
82
|
export interface QueryFilterString {
|
|
66
83
|
/** The attribute equals the provided value. */
|
|
67
84
|
eq?: string;
|
|
@@ -101,14 +118,34 @@ export interface AppStripeCheckoutSessionCustomTextParams {
|
|
|
101
118
|
}
|
|
102
119
|
/** Request to create a Stripe Customer Portal Session. */
|
|
103
120
|
export interface AppStripeCreateCustomerPortalSessionOptions {
|
|
104
|
-
/**
|
|
121
|
+
/**
|
|
122
|
+
* The ID of an existing
|
|
123
|
+
* [Stripe configuration](https://docs.stripe.com/api/customer_portal/configurations)
|
|
124
|
+
* to use for this session, describing its functionality and features. If not
|
|
125
|
+
* specified, the session uses the default configuration.
|
|
126
|
+
*/
|
|
105
127
|
configuration_id?: string;
|
|
106
|
-
/**
|
|
128
|
+
/**
|
|
129
|
+
* The IETF
|
|
130
|
+
* [language tag](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-locale)
|
|
131
|
+
* of the locale customer portal is displayed in. If blank or `auto`, the
|
|
132
|
+
* customer's preferred_locales or browser's locale is used.
|
|
133
|
+
*/
|
|
107
134
|
locale?: string;
|
|
108
|
-
/**
|
|
135
|
+
/**
|
|
136
|
+
* The
|
|
137
|
+
* [URL to redirect](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url)
|
|
138
|
+
* the customer to after they have completed their requested actions.
|
|
139
|
+
*/
|
|
109
140
|
return_url?: string;
|
|
110
141
|
}
|
|
111
|
-
/**
|
|
142
|
+
/**
|
|
143
|
+
* Labels store metadata of an entity that can be used for filtering an entity list
|
|
144
|
+
* or for searching across entity types.
|
|
145
|
+
*
|
|
146
|
+
* Keys must be of length 1-63 characters, and cannot start with "kong", "konnect",
|
|
147
|
+
* "mesh", "kic", or "\_".
|
|
148
|
+
*/
|
|
112
149
|
export type CreateLabels = Record<string, string>;
|
|
113
150
|
/** The tax config for Stripe. */
|
|
114
151
|
export interface TaxConfigStripe {
|
|
@@ -120,7 +157,12 @@ export interface TaxConfigExternalInvoicing {
|
|
|
120
157
|
/** The tax code should be interpreted by the external invoicing provider. */
|
|
121
158
|
code: string;
|
|
122
159
|
}
|
|
123
|
-
/**
|
|
160
|
+
/**
|
|
161
|
+
* Discounts applicable to flat fee charges.
|
|
162
|
+
*
|
|
163
|
+
* This is the same as `ProductCatalog.Discounts` but without the `usage` field,
|
|
164
|
+
* which is not applicable to flat fee charges.
|
|
165
|
+
*/
|
|
124
166
|
export interface ChargeFlatFeeDiscounts {
|
|
125
167
|
/** Percentage discount applied to the price (0–100). */
|
|
126
168
|
percentage?: number;
|
|
@@ -130,21 +172,33 @@ export interface PriceFree {
|
|
|
130
172
|
/** The type of the price. */
|
|
131
173
|
type: 'free';
|
|
132
174
|
}
|
|
133
|
-
/**
|
|
175
|
+
/**
|
|
176
|
+
* BillingWorkflowCollectionAlignmentSubscription specifies the alignment for
|
|
177
|
+
* collecting the pending line items into an invoice.
|
|
178
|
+
*/
|
|
134
179
|
export interface WorkflowCollectionAlignmentSubscription {
|
|
135
180
|
/** The type of alignment. */
|
|
136
181
|
type: 'subscription';
|
|
137
182
|
}
|
|
138
|
-
/**
|
|
183
|
+
/**
|
|
184
|
+
* Payment settings for a billing workflow when the collection method is charge
|
|
185
|
+
* automatically.
|
|
186
|
+
*/
|
|
139
187
|
export interface WorkflowPaymentChargeAutomaticallySettings {
|
|
140
188
|
/** The collection method for the invoice. */
|
|
141
189
|
collection_method: 'charge_automatically';
|
|
142
190
|
}
|
|
143
|
-
/**
|
|
191
|
+
/**
|
|
192
|
+
* Payment settings for a billing workflow when the collection method is send
|
|
193
|
+
* invoice.
|
|
194
|
+
*/
|
|
144
195
|
export interface WorkflowPaymentSendInvoiceSettings {
|
|
145
196
|
/** The collection method for the invoice. */
|
|
146
197
|
collection_method: 'send_invoice';
|
|
147
|
-
/**
|
|
198
|
+
/**
|
|
199
|
+
* The period after which the invoice is due. With some payment solutions it's only
|
|
200
|
+
* applicable for manual collection method.
|
|
201
|
+
*/
|
|
148
202
|
due_after: string;
|
|
149
203
|
}
|
|
150
204
|
/** External identifiers assigned to an invoice by third-party systems. */
|
|
@@ -159,7 +213,13 @@ export interface InvoiceAvailableActionDetails {
|
|
|
159
213
|
/** The extended status the invoice will transition to after performing this action. */
|
|
160
214
|
resulting_state: string;
|
|
161
215
|
}
|
|
162
|
-
/**
|
|
216
|
+
/**
|
|
217
|
+
* Invoice-level invoicing settings.
|
|
218
|
+
*
|
|
219
|
+
* A subset of BillingWorkflowInvoicingSettings limited to fields that are
|
|
220
|
+
* meaningful per-invoice. progressive_billing is omitted as it is a gather-time /
|
|
221
|
+
* profile-level decision.
|
|
222
|
+
*/
|
|
163
223
|
export interface InvoiceWorkflowInvoicingSettings {
|
|
164
224
|
/** Whether to automatically issue the invoice after the draft_period has passed. */
|
|
165
225
|
auto_advance: boolean;
|
|
@@ -189,7 +249,11 @@ export interface LlmCostModel {
|
|
|
189
249
|
export interface RateCardStaticEntitlement {
|
|
190
250
|
/** The type of the entitlement template. */
|
|
191
251
|
type: 'static';
|
|
192
|
-
/**
|
|
252
|
+
/**
|
|
253
|
+
* The entitlement config as a JSON object. Returned when checking entitlement
|
|
254
|
+
* access; useful for configuring fine-grained access settings implemented in your
|
|
255
|
+
* own system.
|
|
256
|
+
*/
|
|
193
257
|
config: unknown;
|
|
194
258
|
}
|
|
195
259
|
/** The entitlement template of a boolean entitlement. */
|
|
@@ -210,15 +274,26 @@ export interface ProductCatalogValidationError {
|
|
|
210
274
|
}
|
|
211
275
|
/** List of customer identifiers to evaluate access for. */
|
|
212
276
|
export interface GovernanceQueryRequestCustomers {
|
|
213
|
-
/**
|
|
277
|
+
/**
|
|
278
|
+
* Each entry can be a customer `key` or a usage-attribution subject `key`.
|
|
279
|
+
* Identifiers that cannot be resolved to a customer are reported in the response
|
|
280
|
+
* `errors` array.
|
|
281
|
+
*/
|
|
214
282
|
keys: string[];
|
|
215
283
|
}
|
|
216
|
-
/**
|
|
284
|
+
/**
|
|
285
|
+
* Optional list of feature keys to evaluate access for. If omitted, all features
|
|
286
|
+
* available in the organization are returned. Providing this list is recommended
|
|
287
|
+
* to reduce the response size and the load on the backend services.
|
|
288
|
+
*/
|
|
217
289
|
export interface GovernanceQueryRequestFeatures {
|
|
218
290
|
/** List of feature keys to evaluate access for. */
|
|
219
291
|
keys: string[];
|
|
220
292
|
}
|
|
221
|
-
/**
|
|
293
|
+
/**
|
|
294
|
+
* A query filter for an integer attribute. Operators are mutually exclusive, only
|
|
295
|
+
* one operator is allowed at a time.
|
|
296
|
+
*/
|
|
222
297
|
export interface QueryFilterInteger {
|
|
223
298
|
/** The attribute equals the provided value. */
|
|
224
299
|
eq?: number;
|
|
@@ -241,7 +316,10 @@ export interface QueryFilterInteger {
|
|
|
241
316
|
/** Combines the provided filters with a logical OR. */
|
|
242
317
|
or?: QueryFilterInteger[];
|
|
243
318
|
}
|
|
244
|
-
/**
|
|
319
|
+
/**
|
|
320
|
+
* A query filter for a float attribute. Operators are mutually exclusive, only one
|
|
321
|
+
* operator is allowed at a time.
|
|
322
|
+
*/
|
|
245
323
|
export interface QueryFilterFloat {
|
|
246
324
|
/** The attribute is greater than the provided value. */
|
|
247
325
|
gt?: number;
|
|
@@ -256,7 +334,10 @@ export interface QueryFilterFloat {
|
|
|
256
334
|
/** Combines the provided filters with a logical OR. */
|
|
257
335
|
or?: QueryFilterFloat[];
|
|
258
336
|
}
|
|
259
|
-
/**
|
|
337
|
+
/**
|
|
338
|
+
* A query filter for a boolean attribute. Operators are mutually exclusive, only
|
|
339
|
+
* one operator is allowed at a time.
|
|
340
|
+
*/
|
|
260
341
|
export interface QueryFilterBoolean {
|
|
261
342
|
/** The attribute equals the provided value. */
|
|
262
343
|
eq?: boolean;
|
|
@@ -269,23 +350,35 @@ export interface PagePaginationQuery {
|
|
|
269
350
|
number?: number;
|
|
270
351
|
};
|
|
271
352
|
}
|
|
272
|
-
/**
|
|
353
|
+
/**
|
|
354
|
+
* Public labels store information about an entity that can be used for filtering a
|
|
355
|
+
* list of objects.
|
|
356
|
+
*/
|
|
273
357
|
export type PublicLabels = Record<string, string>;
|
|
274
|
-
/**
|
|
358
|
+
/**
|
|
359
|
+
* The system account access token is meant for automations and integrations that
|
|
360
|
+
* are not directly associated with a human identity.
|
|
361
|
+
*/
|
|
275
362
|
export interface SystemAccountAccessToken {
|
|
276
363
|
/** Http authentication */
|
|
277
364
|
type: 'http';
|
|
278
365
|
/** bearer auth scheme */
|
|
279
366
|
scheme: 'Bearer';
|
|
280
367
|
}
|
|
281
|
-
/**
|
|
368
|
+
/**
|
|
369
|
+
* The personal access token is meant to be used as an alternative to basic-auth
|
|
370
|
+
* when accessing Konnect via APIs.
|
|
371
|
+
*/
|
|
282
372
|
export interface PersonalAccessToken {
|
|
283
373
|
/** Http authentication */
|
|
284
374
|
type: 'http';
|
|
285
375
|
/** bearer auth scheme */
|
|
286
376
|
scheme: 'Bearer';
|
|
287
377
|
}
|
|
288
|
-
/**
|
|
378
|
+
/**
|
|
379
|
+
* The Konnect access token is meant to be used by the Konnect dashboard and the
|
|
380
|
+
* decK CLI authenticate with.
|
|
381
|
+
*/
|
|
289
382
|
export interface KonnectAccessToken {
|
|
290
383
|
/** Http authentication */
|
|
291
384
|
type: 'http';
|
|
@@ -294,12 +387,24 @@ export interface KonnectAccessToken {
|
|
|
294
387
|
}
|
|
295
388
|
/** Meter update request. */
|
|
296
389
|
export interface UpdateMeterRequest {
|
|
297
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* Display name of the resource.
|
|
392
|
+
*
|
|
393
|
+
* Between 1 and 256 characters.
|
|
394
|
+
*/
|
|
298
395
|
name?: string;
|
|
299
|
-
/**
|
|
396
|
+
/**
|
|
397
|
+
* Optional description of the resource.
|
|
398
|
+
*
|
|
399
|
+
* Maximum 1024 characters.
|
|
400
|
+
*/
|
|
300
401
|
description?: string;
|
|
301
402
|
labels?: Labels;
|
|
302
|
-
/**
|
|
403
|
+
/**
|
|
404
|
+
* Named JSONPath expressions to extract the group by values from the event data.
|
|
405
|
+
*
|
|
406
|
+
* Keys must be unique and consist only alphanumeric and underscore characters.
|
|
407
|
+
*/
|
|
303
408
|
dimensions?: Record<string, string>;
|
|
304
409
|
}
|
|
305
410
|
/** Stripe customer data. */
|
|
@@ -333,7 +438,12 @@ export interface PriceFlat {
|
|
|
333
438
|
/** The amount of the flat price. */
|
|
334
439
|
amount: string;
|
|
335
440
|
}
|
|
336
|
-
/**
|
|
441
|
+
/**
|
|
442
|
+
* Unit price.
|
|
443
|
+
*
|
|
444
|
+
* Charges a fixed rate per billing unit. When UnitConfig is present on the rate
|
|
445
|
+
* card, billing units are the converted quantities (e.g. GB instead of bytes).
|
|
446
|
+
*/
|
|
337
447
|
export interface PriceUnit {
|
|
338
448
|
/** The type of the price. */
|
|
339
449
|
type: 'unit';
|
|
@@ -344,7 +454,11 @@ export interface PriceUnit {
|
|
|
344
454
|
export interface RateCardDiscounts {
|
|
345
455
|
/** Percentage discount applied to the price (0–100). */
|
|
346
456
|
percentage?: number;
|
|
347
|
-
/**
|
|
457
|
+
/**
|
|
458
|
+
* Number of usage units granted free before billing starts. Only applies to
|
|
459
|
+
* usage-based lines (not flat fees). Usage is treated as zero until this amount is
|
|
460
|
+
* exhausted.
|
|
461
|
+
*/
|
|
348
462
|
usage?: string;
|
|
349
463
|
}
|
|
350
464
|
/** Totals contains the summaries of all calculations for a billing resource. */
|
|
@@ -406,14 +520,20 @@ export interface LlmCostModelPricing {
|
|
|
406
520
|
/** Reasoning output price per token (USD). */
|
|
407
521
|
reasoning_per_token?: string;
|
|
408
522
|
}
|
|
409
|
-
/**
|
|
523
|
+
/**
|
|
524
|
+
* Spend commitments for a rate card. The customer is committed to spend at least
|
|
525
|
+
* the minimum amount and at most the maximum amount.
|
|
526
|
+
*/
|
|
410
527
|
export interface SpendCommitments {
|
|
411
528
|
/** The customer is committed to spend at least the amount. */
|
|
412
529
|
minimum_amount?: string;
|
|
413
530
|
/** The customer is limited to spend at most the amount. */
|
|
414
531
|
maximum_amount?: string;
|
|
415
532
|
}
|
|
416
|
-
/**
|
|
533
|
+
/**
|
|
534
|
+
* A query filter for a numeric attribute. Operators are mutually exclusive, only
|
|
535
|
+
* one operator is allowed at a time.
|
|
536
|
+
*/
|
|
417
537
|
export interface QueryFilterNumeric {
|
|
418
538
|
/** The attribute is greater than the provided value. */
|
|
419
539
|
gt?: string;
|
|
@@ -529,7 +649,14 @@ export interface ListLlmCostPricesParamsFilter {
|
|
|
529
649
|
exists?: boolean;
|
|
530
650
|
};
|
|
531
651
|
}
|
|
532
|
-
/**
|
|
652
|
+
/**
|
|
653
|
+
* Filters on the resource's `labels` field.
|
|
654
|
+
*
|
|
655
|
+
* The schema is a map keyed by the label name; each value is a
|
|
656
|
+
* `StringFieldFilter`. Both deepObject forms are accepted:
|
|
657
|
+
* `filter[labels][key]=value` (nested) and `filter[labels.key]=value`
|
|
658
|
+
* (dot-notation).
|
|
659
|
+
*/
|
|
533
660
|
export type LabelsFieldFilter = Record<string, string | {
|
|
534
661
|
eq?: string;
|
|
535
662
|
neq?: string;
|
|
@@ -573,7 +700,10 @@ export interface BillingCustomerReference {
|
|
|
573
700
|
/** The ID of the customer. */
|
|
574
701
|
id: string;
|
|
575
702
|
}
|
|
576
|
-
/**
|
|
703
|
+
/**
|
|
704
|
+
* Subscription reference represents a reference to the specific subscription item
|
|
705
|
+
* this entity represents.
|
|
706
|
+
*/
|
|
577
707
|
export interface SubscriptionReference {
|
|
578
708
|
/** The ID of the subscription. */
|
|
579
709
|
id: string;
|
|
@@ -604,11 +734,17 @@ export interface CurrencyFiat {
|
|
|
604
734
|
id: string;
|
|
605
735
|
/** The type of the currency. */
|
|
606
736
|
type: 'fiat';
|
|
607
|
-
/**
|
|
737
|
+
/**
|
|
738
|
+
* The name of the currency. It should be a human-readable string that represents
|
|
739
|
+
* the name of the currency, such as "US Dollar" or "Euro".
|
|
740
|
+
*/
|
|
608
741
|
name: string;
|
|
609
742
|
/** Description of the currency. */
|
|
610
743
|
description?: string;
|
|
611
|
-
/**
|
|
744
|
+
/**
|
|
745
|
+
* The symbol of the currency. It should be a string that represents the symbol of
|
|
746
|
+
* the currency, such as "$" for US Dollar or "€" for Euro.
|
|
747
|
+
*/
|
|
612
748
|
symbol?: string;
|
|
613
749
|
code: string;
|
|
614
750
|
}
|
|
@@ -624,13 +760,22 @@ export interface Event {
|
|
|
624
760
|
source: string;
|
|
625
761
|
/** The version of the CloudEvents specification which the event uses. */
|
|
626
762
|
specversion: string;
|
|
627
|
-
/**
|
|
763
|
+
/**
|
|
764
|
+
* Contains a value describing the type of event related to the originating
|
|
765
|
+
* occurrence.
|
|
766
|
+
*/
|
|
628
767
|
type: string;
|
|
629
|
-
/**
|
|
768
|
+
/**
|
|
769
|
+
* Content type of the CloudEvents data value. Only the value "application/json" is
|
|
770
|
+
* allowed over HTTP.
|
|
771
|
+
*/
|
|
630
772
|
datacontenttype?: 'application/json' | null;
|
|
631
773
|
/** Identifies the schema that data adheres to. */
|
|
632
774
|
dataschema?: string | null;
|
|
633
|
-
/**
|
|
775
|
+
/**
|
|
776
|
+
* Describes the subject of the event in the context of the event producer
|
|
777
|
+
* (identified by source).
|
|
778
|
+
*/
|
|
634
779
|
subject: string;
|
|
635
780
|
/** Timestamp of when the occurrence happened. Must adhere to RFC 3339. */
|
|
636
781
|
time?: string | null;
|
|
@@ -645,33 +790,87 @@ export interface MeterQueryRow {
|
|
|
645
790
|
from: string;
|
|
646
791
|
/** The end of the time bucket the value is aggregated over. */
|
|
647
792
|
to: string;
|
|
648
|
-
/**
|
|
793
|
+
/**
|
|
794
|
+
* The dimensions the value is aggregated over. `subject` and `customer_id` are
|
|
795
|
+
* reserved dimensions.
|
|
796
|
+
*/
|
|
649
797
|
dimensions: Record<string, string>;
|
|
650
798
|
}
|
|
651
|
-
/**
|
|
799
|
+
/**
|
|
800
|
+
* Result of creating a
|
|
801
|
+
* [Stripe Customer Portal Session](https://docs.stripe.com/api/customer_portal/sessions/object).
|
|
802
|
+
*
|
|
803
|
+
* Contains all the information needed to redirect the customer to the Stripe
|
|
804
|
+
* Customer Portal.
|
|
805
|
+
*/
|
|
652
806
|
export interface AppStripeCreateCustomerPortalSessionResult {
|
|
653
|
-
/**
|
|
807
|
+
/**
|
|
808
|
+
* The ID of the customer portal session.
|
|
809
|
+
*
|
|
810
|
+
* See:
|
|
811
|
+
* https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id
|
|
812
|
+
*/
|
|
654
813
|
id: string;
|
|
655
814
|
/** The ID of the stripe customer. */
|
|
656
815
|
stripe_customer_id: string;
|
|
657
|
-
/**
|
|
816
|
+
/**
|
|
817
|
+
* Configuration used to customize the customer portal.
|
|
818
|
+
*
|
|
819
|
+
* See:
|
|
820
|
+
* https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration
|
|
821
|
+
*/
|
|
658
822
|
configuration_id: string;
|
|
659
|
-
/**
|
|
823
|
+
/**
|
|
824
|
+
* Livemode.
|
|
825
|
+
*
|
|
826
|
+
* See:
|
|
827
|
+
* https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode
|
|
828
|
+
*/
|
|
660
829
|
livemode: boolean;
|
|
661
|
-
/**
|
|
830
|
+
/**
|
|
831
|
+
* Created at.
|
|
832
|
+
*
|
|
833
|
+
* See:
|
|
834
|
+
* https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-created
|
|
835
|
+
*/
|
|
662
836
|
created_at: string;
|
|
663
|
-
/**
|
|
837
|
+
/**
|
|
838
|
+
* Return URL.
|
|
839
|
+
*
|
|
840
|
+
* See:
|
|
841
|
+
* https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url
|
|
842
|
+
*/
|
|
664
843
|
return_url: string;
|
|
665
|
-
/**
|
|
844
|
+
/**
|
|
845
|
+
* The IETF language tag of the locale customer portal is displayed in.
|
|
846
|
+
*
|
|
847
|
+
* See:
|
|
848
|
+
* https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale
|
|
849
|
+
*/
|
|
666
850
|
locale: string;
|
|
667
|
-
/**
|
|
851
|
+
/**
|
|
852
|
+
* The URL to redirect the customer to after they have completed their requested
|
|
853
|
+
* actions.
|
|
854
|
+
*/
|
|
668
855
|
url: string;
|
|
669
856
|
}
|
|
670
|
-
/**
|
|
857
|
+
/**
|
|
858
|
+
* A period with defined start and end dates.
|
|
859
|
+
*
|
|
860
|
+
* The period is always inclusive at the start and exclusive at the end.
|
|
861
|
+
*/
|
|
671
862
|
export interface ClosedPeriod {
|
|
672
|
-
/**
|
|
863
|
+
/**
|
|
864
|
+
* The start of the period.
|
|
865
|
+
*
|
|
866
|
+
* The period is inclusive at the start.
|
|
867
|
+
*/
|
|
673
868
|
from: string;
|
|
674
|
-
/**
|
|
869
|
+
/**
|
|
870
|
+
* The end of the period.
|
|
871
|
+
*
|
|
872
|
+
* The period is exclusive at the end.
|
|
873
|
+
*/
|
|
675
874
|
to: string;
|
|
676
875
|
}
|
|
677
876
|
/** Describes currency basis supported by billing system. */
|
|
@@ -681,7 +880,11 @@ export interface CostBasis {
|
|
|
681
880
|
fiat_code: string;
|
|
682
881
|
/** The cost rate for the currency. */
|
|
683
882
|
rate: string;
|
|
684
|
-
/**
|
|
883
|
+
/**
|
|
884
|
+
* An ISO-8601 timestamp representation of the date from which the cost basis is
|
|
885
|
+
* effective. If not provided, it will be effective immediately and will be set to
|
|
886
|
+
* `now` by the system.
|
|
887
|
+
*/
|
|
685
888
|
effective_from?: string;
|
|
686
889
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
687
890
|
created_at: string;
|
|
@@ -692,32 +895,53 @@ export interface CreateCostBasisRequest {
|
|
|
692
895
|
fiat_code: string;
|
|
693
896
|
/** The cost rate for the currency. */
|
|
694
897
|
rate: string;
|
|
695
|
-
/**
|
|
898
|
+
/**
|
|
899
|
+
* An ISO-8601 timestamp representation of the date from which the cost basis is
|
|
900
|
+
* effective. If not provided, it will be effective immediately and will be set to
|
|
901
|
+
* `now` by the system.
|
|
902
|
+
*/
|
|
696
903
|
effective_from?: string;
|
|
697
904
|
}
|
|
698
905
|
/** A row in the result of a feature cost query. */
|
|
699
906
|
export interface FeatureCostQueryRow {
|
|
700
907
|
/** The metered usage value for the period. */
|
|
701
908
|
usage: string;
|
|
702
|
-
/**
|
|
909
|
+
/**
|
|
910
|
+
* The computed cost amount (usage × unit cost). Null when pricing is not available
|
|
911
|
+
* for the given combination of dimensions.
|
|
912
|
+
*/
|
|
703
913
|
cost: string | null;
|
|
704
914
|
/** The currency code of the cost amount. */
|
|
705
915
|
currency: string;
|
|
706
|
-
/**
|
|
916
|
+
/**
|
|
917
|
+
* Detail message when cost amount is null, explaining why the cost could not be
|
|
918
|
+
* resolved.
|
|
919
|
+
*/
|
|
707
920
|
detail?: string;
|
|
708
921
|
/** The start of the time bucket the value is aggregated over. */
|
|
709
922
|
from: string;
|
|
710
923
|
/** The end of the time bucket the value is aggregated over. */
|
|
711
924
|
to: string;
|
|
712
|
-
/**
|
|
925
|
+
/**
|
|
926
|
+
* The dimensions the value is aggregated over. `subject` and `customer_id` are
|
|
927
|
+
* reserved dimensions.
|
|
928
|
+
*/
|
|
713
929
|
dimensions: Record<string, string>;
|
|
714
930
|
}
|
|
715
931
|
/** Represents common fields of resources. */
|
|
716
932
|
export interface Resource {
|
|
717
933
|
id: string;
|
|
718
|
-
/**
|
|
934
|
+
/**
|
|
935
|
+
* Display name of the resource.
|
|
936
|
+
*
|
|
937
|
+
* Between 1 and 256 characters.
|
|
938
|
+
*/
|
|
719
939
|
name: string;
|
|
720
|
-
/**
|
|
940
|
+
/**
|
|
941
|
+
* Optional description of the resource.
|
|
942
|
+
*
|
|
943
|
+
* Maximum 1024 characters.
|
|
944
|
+
*/
|
|
721
945
|
description?: string;
|
|
722
946
|
labels?: Labels;
|
|
723
947
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -730,15 +954,26 @@ export interface Resource {
|
|
|
730
954
|
/** Represents common fields of immutable resources. */
|
|
731
955
|
export interface ResourceImmutable {
|
|
732
956
|
id: string;
|
|
733
|
-
/**
|
|
957
|
+
/**
|
|
958
|
+
* Display name of the resource.
|
|
959
|
+
*
|
|
960
|
+
* Between 1 and 256 characters.
|
|
961
|
+
*/
|
|
734
962
|
name: string;
|
|
735
|
-
/**
|
|
963
|
+
/**
|
|
964
|
+
* Optional description of the resource.
|
|
965
|
+
*
|
|
966
|
+
* Maximum 1024 characters.
|
|
967
|
+
*/
|
|
736
968
|
description?: string;
|
|
737
969
|
labels?: Labels;
|
|
738
970
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
739
971
|
created_at: string;
|
|
740
972
|
}
|
|
741
|
-
/**
|
|
973
|
+
/**
|
|
974
|
+
* A query filter for a time attribute. Operators are mutually exclusive, only one
|
|
975
|
+
* operator is allowed at a time.
|
|
976
|
+
*/
|
|
742
977
|
export interface QueryFilterDateTime {
|
|
743
978
|
/** The attribute is greater than the provided value. */
|
|
744
979
|
gt?: string;
|
|
@@ -859,32 +1094,58 @@ export interface NotAvailable extends BaseError {
|
|
|
859
1094
|
}
|
|
860
1095
|
/** Filters for the credit grant. */
|
|
861
1096
|
export interface CreateCreditGrantFilters {
|
|
862
|
-
/**
|
|
1097
|
+
/**
|
|
1098
|
+
* Limit the credit grant to specific features. If no features are specified, the
|
|
1099
|
+
* credit grant can be used for any feature.
|
|
1100
|
+
*/
|
|
863
1101
|
features?: string[];
|
|
864
1102
|
}
|
|
865
1103
|
/** Filters for the credit grant. */
|
|
866
1104
|
export interface CreditGrantFilters {
|
|
867
|
-
/**
|
|
1105
|
+
/**
|
|
1106
|
+
* Limit the credit grant to specific features. If no features are specified, the
|
|
1107
|
+
* credit grant can be used for any feature.
|
|
1108
|
+
*/
|
|
868
1109
|
features?: string[];
|
|
869
1110
|
}
|
|
870
1111
|
/** PlanAddon upsert request. */
|
|
871
1112
|
export interface UpsertPlanAddonRequest {
|
|
872
|
-
/**
|
|
1113
|
+
/**
|
|
1114
|
+
* Display name of the resource.
|
|
1115
|
+
*
|
|
1116
|
+
* Between 1 and 256 characters.
|
|
1117
|
+
*/
|
|
873
1118
|
name: string;
|
|
874
|
-
/**
|
|
1119
|
+
/**
|
|
1120
|
+
* Optional description of the resource.
|
|
1121
|
+
*
|
|
1122
|
+
* Maximum 1024 characters.
|
|
1123
|
+
*/
|
|
875
1124
|
description?: string;
|
|
876
1125
|
labels?: Labels;
|
|
877
1126
|
/** The key of the plan phase from which the add-on becomes available for purchase. */
|
|
878
1127
|
from_plan_phase: string;
|
|
879
|
-
/**
|
|
1128
|
+
/**
|
|
1129
|
+
* The maximum number of times the add-on can be purchased for the plan. For
|
|
1130
|
+
* single-instance add-ons this field must be omitted. For multi-instance add-ons
|
|
1131
|
+
* when omitted, unlimited quantity can be purchased.
|
|
1132
|
+
*/
|
|
880
1133
|
max_quantity?: number;
|
|
881
1134
|
}
|
|
882
1135
|
/** Represents common fields of resources with a key. */
|
|
883
1136
|
export interface ResourceWithKey {
|
|
884
1137
|
id: string;
|
|
885
|
-
/**
|
|
1138
|
+
/**
|
|
1139
|
+
* Display name of the resource.
|
|
1140
|
+
*
|
|
1141
|
+
* Between 1 and 256 characters.
|
|
1142
|
+
*/
|
|
886
1143
|
name: string;
|
|
887
|
-
/**
|
|
1144
|
+
/**
|
|
1145
|
+
* Optional description of the resource.
|
|
1146
|
+
*
|
|
1147
|
+
* Maximum 1024 characters.
|
|
1148
|
+
*/
|
|
888
1149
|
description?: string;
|
|
889
1150
|
labels?: Labels;
|
|
890
1151
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -897,9 +1158,17 @@ export interface ResourceWithKey {
|
|
|
897
1158
|
}
|
|
898
1159
|
/** Meter create request. */
|
|
899
1160
|
export interface CreateMeterRequest {
|
|
900
|
-
/**
|
|
1161
|
+
/**
|
|
1162
|
+
* Display name of the resource.
|
|
1163
|
+
*
|
|
1164
|
+
* Between 1 and 256 characters.
|
|
1165
|
+
*/
|
|
901
1166
|
name: string;
|
|
902
|
-
/**
|
|
1167
|
+
/**
|
|
1168
|
+
* Optional description of the resource.
|
|
1169
|
+
*
|
|
1170
|
+
* Maximum 1024 characters.
|
|
1171
|
+
*/
|
|
903
1172
|
description?: string;
|
|
904
1173
|
labels?: Labels;
|
|
905
1174
|
key: string;
|
|
@@ -907,19 +1176,43 @@ export interface CreateMeterRequest {
|
|
|
907
1176
|
aggregation: 'sum' | 'count' | 'unique_count' | 'avg' | 'min' | 'max' | 'latest';
|
|
908
1177
|
/** The event type to include in the aggregation. */
|
|
909
1178
|
event_type: string;
|
|
910
|
-
/**
|
|
1179
|
+
/**
|
|
1180
|
+
* The date since the meter should include events. Useful to skip old events. If
|
|
1181
|
+
* not specified, all historical events are included.
|
|
1182
|
+
*/
|
|
911
1183
|
events_from?: string;
|
|
912
|
-
/**
|
|
1184
|
+
/**
|
|
1185
|
+
* JSONPath expression to extract the value from the ingested event's data
|
|
1186
|
+
* property.
|
|
1187
|
+
*
|
|
1188
|
+
* The ingested value for sum, avg, min, and max aggregations is a number or a
|
|
1189
|
+
* string that can be parsed to a number.
|
|
1190
|
+
*
|
|
1191
|
+
* For unique_count aggregation, the ingested value must be a string. For count
|
|
1192
|
+
* aggregation the value_property is ignored.
|
|
1193
|
+
*/
|
|
913
1194
|
value_property?: string;
|
|
914
|
-
/**
|
|
1195
|
+
/**
|
|
1196
|
+
* Named JSONPath expressions to extract the group by values from the event data.
|
|
1197
|
+
*
|
|
1198
|
+
* Keys must be unique and consist only alphanumeric and underscore characters.
|
|
1199
|
+
*/
|
|
915
1200
|
dimensions?: Record<string, string>;
|
|
916
1201
|
}
|
|
917
1202
|
/** A meter is a configuration that defines how to match and aggregate events. */
|
|
918
1203
|
export interface Meter {
|
|
919
1204
|
id: string;
|
|
920
|
-
/**
|
|
1205
|
+
/**
|
|
1206
|
+
* Display name of the resource.
|
|
1207
|
+
*
|
|
1208
|
+
* Between 1 and 256 characters.
|
|
1209
|
+
*/
|
|
921
1210
|
name: string;
|
|
922
|
-
/**
|
|
1211
|
+
/**
|
|
1212
|
+
* Optional description of the resource.
|
|
1213
|
+
*
|
|
1214
|
+
* Maximum 1024 characters.
|
|
1215
|
+
*/
|
|
923
1216
|
description?: string;
|
|
924
1217
|
labels?: Labels;
|
|
925
1218
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -933,11 +1226,27 @@ export interface Meter {
|
|
|
933
1226
|
aggregation: 'sum' | 'count' | 'unique_count' | 'avg' | 'min' | 'max' | 'latest';
|
|
934
1227
|
/** The event type to include in the aggregation. */
|
|
935
1228
|
event_type: string;
|
|
936
|
-
/**
|
|
1229
|
+
/**
|
|
1230
|
+
* The date since the meter should include events. Useful to skip old events. If
|
|
1231
|
+
* not specified, all historical events are included.
|
|
1232
|
+
*/
|
|
937
1233
|
events_from?: string;
|
|
938
|
-
/**
|
|
1234
|
+
/**
|
|
1235
|
+
* JSONPath expression to extract the value from the ingested event's data
|
|
1236
|
+
* property.
|
|
1237
|
+
*
|
|
1238
|
+
* The ingested value for sum, avg, min, and max aggregations is a number or a
|
|
1239
|
+
* string that can be parsed to a number.
|
|
1240
|
+
*
|
|
1241
|
+
* For unique_count aggregation, the ingested value must be a string. For count
|
|
1242
|
+
* aggregation the value_property is ignored.
|
|
1243
|
+
*/
|
|
939
1244
|
value_property?: string;
|
|
940
|
-
/**
|
|
1245
|
+
/**
|
|
1246
|
+
* Named JSONPath expressions to extract the group by values from the event data.
|
|
1247
|
+
*
|
|
1248
|
+
* Keys must be unique and consist only alphanumeric and underscore characters.
|
|
1249
|
+
*/
|
|
941
1250
|
dimensions?: Record<string, string>;
|
|
942
1251
|
}
|
|
943
1252
|
/** Pagination metadata. */
|
|
@@ -945,7 +1254,10 @@ export interface PaginatedMeta {
|
|
|
945
1254
|
/** Page metadata. */
|
|
946
1255
|
page: PageMeta;
|
|
947
1256
|
}
|
|
948
|
-
/**
|
|
1257
|
+
/**
|
|
1258
|
+
* A query filter for an item in a string map attribute. Operators are mutually
|
|
1259
|
+
* exclusive, only one operator is allowed at a time.
|
|
1260
|
+
*/
|
|
949
1261
|
export interface QueryFilterStringMapItem {
|
|
950
1262
|
/** The attribute exists. */
|
|
951
1263
|
exists?: boolean;
|
|
@@ -971,14 +1283,23 @@ export interface CustomerKeyReference {
|
|
|
971
1283
|
/** The external key of the customer. */
|
|
972
1284
|
key: string;
|
|
973
1285
|
}
|
|
974
|
-
/**
|
|
1286
|
+
/**
|
|
1287
|
+
* Mapping to attribute metered usage to the customer. One customer can have zero
|
|
1288
|
+
* or more subjects, but one subject can only belong to one customer.
|
|
1289
|
+
*/
|
|
975
1290
|
export interface CustomerUsageAttribution {
|
|
976
|
-
/**
|
|
1291
|
+
/**
|
|
1292
|
+
* The subjects that are attributed to the customer. Can be empty when no usage
|
|
1293
|
+
* event subjects are associated with the customer.
|
|
1294
|
+
*/
|
|
977
1295
|
subject_keys: string[];
|
|
978
1296
|
}
|
|
979
1297
|
/** Address */
|
|
980
1298
|
export interface Address {
|
|
981
|
-
/**
|
|
1299
|
+
/**
|
|
1300
|
+
* Country code in [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html)
|
|
1301
|
+
* alpha-2 format.
|
|
1302
|
+
*/
|
|
982
1303
|
country?: string;
|
|
983
1304
|
/** Postal code. */
|
|
984
1305
|
postal_code?: string;
|
|
@@ -995,11 +1316,23 @@ export interface Address {
|
|
|
995
1316
|
}
|
|
996
1317
|
/** Controls which customer fields can be updated by the checkout session. */
|
|
997
1318
|
export interface AppStripeCreateCheckoutSessionCustomerUpdate {
|
|
998
|
-
/**
|
|
1319
|
+
/**
|
|
1320
|
+
* Whether to save the billing address to customer.address.
|
|
1321
|
+
*
|
|
1322
|
+
* Defaults to "never".
|
|
1323
|
+
*/
|
|
999
1324
|
address: 'auto' | 'never';
|
|
1000
|
-
/**
|
|
1325
|
+
/**
|
|
1326
|
+
* Whether to save the customer name to customer.name.
|
|
1327
|
+
*
|
|
1328
|
+
* Defaults to "never".
|
|
1329
|
+
*/
|
|
1001
1330
|
name: 'auto' | 'never';
|
|
1002
|
-
/**
|
|
1331
|
+
/**
|
|
1332
|
+
* Whether to save shipping information to customer.shipping.
|
|
1333
|
+
*
|
|
1334
|
+
* Defaults to "never".
|
|
1335
|
+
*/
|
|
1003
1336
|
shipping: 'auto' | 'never';
|
|
1004
1337
|
}
|
|
1005
1338
|
/** Payment method reuse agreement configuration. */
|
|
@@ -1009,12 +1342,25 @@ export interface AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReu
|
|
|
1009
1342
|
}
|
|
1010
1343
|
/** Tax ID collection configuration for checkout sessions. */
|
|
1011
1344
|
export interface AppStripeCreateCheckoutSessionTaxIdCollection {
|
|
1012
|
-
/**
|
|
1345
|
+
/**
|
|
1346
|
+
* Enable tax ID collection during checkout.
|
|
1347
|
+
*
|
|
1348
|
+
* Defaults to false.
|
|
1349
|
+
*/
|
|
1013
1350
|
enabled: boolean;
|
|
1014
|
-
/**
|
|
1351
|
+
/**
|
|
1352
|
+
* Whether tax ID collection is required.
|
|
1353
|
+
*
|
|
1354
|
+
* Defaults to "never".
|
|
1355
|
+
*/
|
|
1015
1356
|
required: 'if_supported' | 'never';
|
|
1016
1357
|
}
|
|
1017
|
-
/**
|
|
1358
|
+
/**
|
|
1359
|
+
* Result of creating a Stripe Checkout Session.
|
|
1360
|
+
*
|
|
1361
|
+
* Contains all the information needed to redirect customers to the checkout or
|
|
1362
|
+
* initialize an embedded checkout flow.
|
|
1363
|
+
*/
|
|
1018
1364
|
export interface AppStripeCreateCheckoutSessionResult {
|
|
1019
1365
|
/** The customer ID in the billing system. */
|
|
1020
1366
|
customer_id: string;
|
|
@@ -1024,9 +1370,18 @@ export interface AppStripeCreateCheckoutSessionResult {
|
|
|
1024
1370
|
session_id: string;
|
|
1025
1371
|
/** The setup intent ID created for collecting the payment method. */
|
|
1026
1372
|
setup_intent_id: string;
|
|
1027
|
-
/**
|
|
1373
|
+
/**
|
|
1374
|
+
* Client secret for initializing Stripe.js on the client side.
|
|
1375
|
+
*
|
|
1376
|
+
* Required for embedded checkout sessions. See:
|
|
1377
|
+
* https://docs.stripe.com/payments/checkout/custom-success-page
|
|
1378
|
+
*/
|
|
1028
1379
|
client_secret?: string;
|
|
1029
|
-
/**
|
|
1380
|
+
/**
|
|
1381
|
+
* The client reference ID provided in the request.
|
|
1382
|
+
*
|
|
1383
|
+
* Useful for reconciling the session with your internal systems.
|
|
1384
|
+
*/
|
|
1030
1385
|
client_reference_id?: string;
|
|
1031
1386
|
/** Customer's email address if provided to Stripe. */
|
|
1032
1387
|
customer_email?: string;
|
|
@@ -1038,11 +1393,20 @@ export interface AppStripeCreateCheckoutSessionResult {
|
|
|
1038
1393
|
expires_at?: string;
|
|
1039
1394
|
/** Metadata attached to the checkout session. */
|
|
1040
1395
|
metadata?: Record<string, string>;
|
|
1041
|
-
/**
|
|
1396
|
+
/**
|
|
1397
|
+
* The status of the checkout session.
|
|
1398
|
+
*
|
|
1399
|
+
* See:
|
|
1400
|
+
* https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-status
|
|
1401
|
+
*/
|
|
1042
1402
|
status?: string;
|
|
1043
1403
|
/** URL to redirect customers to the checkout page (for hosted mode). */
|
|
1044
1404
|
url?: string;
|
|
1045
|
-
/**
|
|
1405
|
+
/**
|
|
1406
|
+
* Mode of the checkout session.
|
|
1407
|
+
*
|
|
1408
|
+
* Currently only "setup" mode is supported for collecting payment methods.
|
|
1409
|
+
*/
|
|
1046
1410
|
mode: 'setup';
|
|
1047
1411
|
/** The cancel URL where customers are redirected if they cancel. */
|
|
1048
1412
|
cancel_url?: string;
|
|
@@ -1051,7 +1415,14 @@ export interface AppStripeCreateCheckoutSessionResult {
|
|
|
1051
1415
|
/** The return URL for embedded sessions after authentication. */
|
|
1052
1416
|
return_url?: string;
|
|
1053
1417
|
}
|
|
1054
|
-
/**
|
|
1418
|
+
/**
|
|
1419
|
+
* Request to create a Stripe Customer Portal Session for the customer.
|
|
1420
|
+
*
|
|
1421
|
+
* Useful to redirect the customer to the Stripe Customer Portal to manage their
|
|
1422
|
+
* payment methods, change their billing address and access their invoice history.
|
|
1423
|
+
* Only returns URL if the customer billing profile is linked to a stripe app and
|
|
1424
|
+
* customer.
|
|
1425
|
+
*/
|
|
1055
1426
|
export interface CustomerStripeCreateCustomerPortalSessionRequest {
|
|
1056
1427
|
/** Options for configuring the Stripe Customer Portal Session. */
|
|
1057
1428
|
stripe_options: AppStripeCreateCustomerPortalSessionOptions;
|
|
@@ -1062,18 +1433,36 @@ export interface EntitlementAccessResult {
|
|
|
1062
1433
|
type: 'metered' | 'static' | 'boolean';
|
|
1063
1434
|
/** The feature key of the entitlement. */
|
|
1064
1435
|
feature_key: string;
|
|
1065
|
-
/**
|
|
1436
|
+
/**
|
|
1437
|
+
* Whether the customer has access to the feature. Always true for `boolean` and
|
|
1438
|
+
* `static` entitlements. Depends on balance for `metered` entitlements.
|
|
1439
|
+
*/
|
|
1066
1440
|
has_access: boolean;
|
|
1067
|
-
/**
|
|
1441
|
+
/**
|
|
1442
|
+
* Only available for static entitlements. Config is the JSON parsable
|
|
1443
|
+
* configuration of the entitlement. Useful to describe per customer configuration.
|
|
1444
|
+
*/
|
|
1068
1445
|
config?: string;
|
|
1069
1446
|
}
|
|
1070
1447
|
/** Purchase and payment terms of the grant. */
|
|
1071
1448
|
export interface CreateCreditGrantPurchase {
|
|
1072
1449
|
/** Currency of the purchase amount. */
|
|
1073
1450
|
currency: string;
|
|
1074
|
-
/**
|
|
1451
|
+
/**
|
|
1452
|
+
* Cost basis per credit unit used to calculate the purchase amount.
|
|
1453
|
+
*
|
|
1454
|
+
* If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
|
|
1455
|
+
* is $50.00. The value must be greater than 0. If the cost basis is 0, use
|
|
1456
|
+
* `funding_method=none` instead.
|
|
1457
|
+
*
|
|
1458
|
+
* Defaults to 1.0.
|
|
1459
|
+
*/
|
|
1075
1460
|
per_unit_cost_basis: string;
|
|
1076
|
-
/**
|
|
1461
|
+
/**
|
|
1462
|
+
* Controls when credits become available for consumption.
|
|
1463
|
+
*
|
|
1464
|
+
* Defaults to `on_creation`.
|
|
1465
|
+
*/
|
|
1077
1466
|
availability_policy: 'on_creation';
|
|
1078
1467
|
}
|
|
1079
1468
|
/** Recurring period with an anchor and an interval. */
|
|
@@ -1087,27 +1476,53 @@ export interface RecurringPeriod {
|
|
|
1087
1476
|
export interface RateCardMeteredEntitlement {
|
|
1088
1477
|
/** The type of the entitlement template. */
|
|
1089
1478
|
type: 'metered';
|
|
1090
|
-
/**
|
|
1479
|
+
/**
|
|
1480
|
+
* If soft limit is true, the subject can use the feature even if the entitlement
|
|
1481
|
+
* is exhausted; access remains granted.
|
|
1482
|
+
*/
|
|
1091
1483
|
is_soft_limit: boolean;
|
|
1092
|
-
/**
|
|
1484
|
+
/**
|
|
1485
|
+
* The amount of usage granted each usage period, in the feature's unit. Usage is
|
|
1486
|
+
* counted against this allowance and the balance resets every usage period. When
|
|
1487
|
+
* `is_soft_limit` is true the subject keeps access after the limit is reached;
|
|
1488
|
+
* otherwise access is denied once the allowance is exhausted.
|
|
1489
|
+
*/
|
|
1093
1490
|
limit?: number;
|
|
1094
|
-
/**
|
|
1491
|
+
/**
|
|
1492
|
+
* The reset interval of the metered entitlement in ISO8601 format. Defaults to the
|
|
1493
|
+
* billing cadence of the rate card.
|
|
1494
|
+
*/
|
|
1095
1495
|
usage_period?: string;
|
|
1096
1496
|
}
|
|
1097
1497
|
/** Purchase and payment terms of the grant. */
|
|
1098
1498
|
export interface CreditGrantPurchase {
|
|
1099
1499
|
/** Currency of the purchase amount. */
|
|
1100
1500
|
currency: string;
|
|
1101
|
-
/**
|
|
1501
|
+
/**
|
|
1502
|
+
* Cost basis per credit unit used to calculate the purchase amount.
|
|
1503
|
+
*
|
|
1504
|
+
* If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
|
|
1505
|
+
* is $50.00. The value must be greater than 0. If the cost basis is 0, use
|
|
1506
|
+
* `funding_method=none` instead.
|
|
1507
|
+
*
|
|
1508
|
+
* Defaults to 1.0.
|
|
1509
|
+
*/
|
|
1102
1510
|
per_unit_cost_basis: string;
|
|
1103
1511
|
/** The purchase amount. Calculated from `per_unit_cost_basis` and credit `amount`. */
|
|
1104
1512
|
amount: string;
|
|
1105
|
-
/**
|
|
1513
|
+
/**
|
|
1514
|
+
* Controls when credits become available for consumption.
|
|
1515
|
+
*
|
|
1516
|
+
* Defaults to `on_creation`.
|
|
1517
|
+
*/
|
|
1106
1518
|
availability_policy: 'on_creation';
|
|
1107
1519
|
/** Current payment settlement status. */
|
|
1108
1520
|
settlement_status?: 'pending' | 'authorized' | 'settled';
|
|
1109
1521
|
}
|
|
1110
|
-
/**
|
|
1522
|
+
/**
|
|
1523
|
+
* Request body for updating the external payment settlement status of a credit
|
|
1524
|
+
* grant.
|
|
1525
|
+
*/
|
|
1111
1526
|
export interface UpdateCreditGrantExternalSettlementRequest {
|
|
1112
1527
|
/** The new payment settlement status. */
|
|
1113
1528
|
status: 'pending' | 'authorized' | 'settled';
|
|
@@ -1127,7 +1542,10 @@ export interface GetCreditBalanceParamsFilter {
|
|
|
1127
1542
|
oeq?: string[];
|
|
1128
1543
|
neq?: string;
|
|
1129
1544
|
};
|
|
1130
|
-
/**
|
|
1545
|
+
/**
|
|
1546
|
+
* Filter credit balance by feature key. Omit to return the total portfolio value.
|
|
1547
|
+
* Use `exists=false` to return only unrestricted balance.
|
|
1548
|
+
*/
|
|
1131
1549
|
feature_key?: string | {
|
|
1132
1550
|
eq?: string;
|
|
1133
1551
|
neq?: string;
|
|
@@ -1143,7 +1561,18 @@ export interface GetCreditBalanceParamsFilter {
|
|
|
1143
1561
|
}
|
|
1144
1562
|
/** Filter options for listing charges. */
|
|
1145
1563
|
export interface ListChargesParamsFilter {
|
|
1146
|
-
/**
|
|
1564
|
+
/**
|
|
1565
|
+
* Filter charges by status.
|
|
1566
|
+
*
|
|
1567
|
+
* Supported statuses are:
|
|
1568
|
+
*
|
|
1569
|
+
* - `created`
|
|
1570
|
+
* - `active`
|
|
1571
|
+
* - `final`
|
|
1572
|
+
* - `deleted`
|
|
1573
|
+
*
|
|
1574
|
+
* If omitted, all statuses are returned except for `deleted`.
|
|
1575
|
+
*/
|
|
1147
1576
|
status?: string | {
|
|
1148
1577
|
eq?: string;
|
|
1149
1578
|
oeq?: string[];
|
|
@@ -1190,7 +1619,15 @@ export interface ListPlansParamsFilter {
|
|
|
1190
1619
|
/** Subscription create request. */
|
|
1191
1620
|
export interface SubscriptionCreate {
|
|
1192
1621
|
labels?: Labels;
|
|
1193
|
-
/**
|
|
1622
|
+
/**
|
|
1623
|
+
* Settlement mode for billing.
|
|
1624
|
+
*
|
|
1625
|
+
* Values:
|
|
1626
|
+
*
|
|
1627
|
+
* - `credit_then_invoice`: Credits are applied first, then any remainder is
|
|
1628
|
+
* invoiced.
|
|
1629
|
+
* - `credit_only`: Usage is settled exclusively against credits.
|
|
1630
|
+
*/
|
|
1194
1631
|
settlement_mode?: 'credit_then_invoice' | 'credit_only';
|
|
1195
1632
|
/** The customer to create the subscription for. */
|
|
1196
1633
|
customer: {
|
|
@@ -1203,7 +1640,18 @@ export interface SubscriptionCreate {
|
|
|
1203
1640
|
key?: string;
|
|
1204
1641
|
version?: number;
|
|
1205
1642
|
};
|
|
1206
|
-
/**
|
|
1643
|
+
/**
|
|
1644
|
+
* A billing anchor is the fixed point in time that determines the subscription's
|
|
1645
|
+
* recurring billing cycle. It affects when charges occur and how prorations are
|
|
1646
|
+
* calculated. Common anchors:
|
|
1647
|
+
*
|
|
1648
|
+
* - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
|
|
1649
|
+
* - Subscription anniversary (day customer signed up)
|
|
1650
|
+
* - Custom date (customer-specified day)
|
|
1651
|
+
*
|
|
1652
|
+
* If not provided, the subscription will be created with the subscription's
|
|
1653
|
+
* creation time as the billing anchor.
|
|
1654
|
+
*/
|
|
1207
1655
|
billing_anchor?: string;
|
|
1208
1656
|
}
|
|
1209
1657
|
/** The proration configuration of the rate card. */
|
|
@@ -1225,14 +1673,35 @@ export interface Subscription {
|
|
|
1225
1673
|
customer_id: string;
|
|
1226
1674
|
/** The plan ID of the subscription. Set if subscription is created from a plan. */
|
|
1227
1675
|
plan_id?: string;
|
|
1228
|
-
/**
|
|
1676
|
+
/**
|
|
1677
|
+
* A billing anchor is the fixed point in time that determines the subscription's
|
|
1678
|
+
* recurring billing cycle. It affects when charges occur and how prorations are
|
|
1679
|
+
* calculated. Common anchors:
|
|
1680
|
+
*
|
|
1681
|
+
* - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
|
|
1682
|
+
* - Subscription anniversary (day customer signed up)
|
|
1683
|
+
* - Custom date (customer-specified day)
|
|
1684
|
+
*/
|
|
1229
1685
|
billing_anchor: string;
|
|
1230
1686
|
/** The status of the subscription. */
|
|
1231
1687
|
status: 'active' | 'inactive' | 'canceled' | 'scheduled';
|
|
1232
|
-
/**
|
|
1688
|
+
/**
|
|
1689
|
+
* Settlement mode for billing.
|
|
1690
|
+
*
|
|
1691
|
+
* Values:
|
|
1692
|
+
*
|
|
1693
|
+
* - `credit_then_invoice`: Credits are applied first, then any remainder is
|
|
1694
|
+
* invoiced.
|
|
1695
|
+
* - `credit_only`: Usage is settled exclusively against credits.
|
|
1696
|
+
*/
|
|
1233
1697
|
settlement_mode?: 'credit_then_invoice' | 'credit_only';
|
|
1234
1698
|
}
|
|
1235
|
-
/**
|
|
1699
|
+
/**
|
|
1700
|
+
* Available apps for billing integrations to connect with third-party services.
|
|
1701
|
+
* Apps can have various capabilities like syncing data from or to external
|
|
1702
|
+
* systems, integrating with third-party services for tax calculation, delivery of
|
|
1703
|
+
* invoices, collection of payments, etc.
|
|
1704
|
+
*/
|
|
1236
1705
|
export interface AppCatalogItem {
|
|
1237
1706
|
/** Type of the app. */
|
|
1238
1707
|
type: 'sandbox' | 'stripe' | 'external_invoicing';
|
|
@@ -1248,7 +1717,10 @@ export interface TaxCodeAppMapping {
|
|
|
1248
1717
|
/** Tax code. */
|
|
1249
1718
|
tax_code: string;
|
|
1250
1719
|
}
|
|
1251
|
-
/**
|
|
1720
|
+
/**
|
|
1721
|
+
* Identity stores the details required to identify an entity for tax purposes in a
|
|
1722
|
+
* specific country.
|
|
1723
|
+
*/
|
|
1252
1724
|
export interface PartyTaxIdentity {
|
|
1253
1725
|
/** Normalized tax identification code shown on the original identity document. */
|
|
1254
1726
|
code?: string;
|
|
@@ -1264,7 +1736,13 @@ export interface WorkflowInvoicingSettings {
|
|
|
1264
1736
|
/** Controls how subscription-ending shortened service periods are billed. */
|
|
1265
1737
|
subscription_end_proration_mode: 'bill_full_period' | 'bill_actual_period';
|
|
1266
1738
|
}
|
|
1267
|
-
/**
|
|
1739
|
+
/**
|
|
1740
|
+
* A validation issue found during invoice processing.
|
|
1741
|
+
*
|
|
1742
|
+
* Converges on the same structure used by plan and subscription validation errors:
|
|
1743
|
+
* a machine-readable `code`, a human-readable `message`, optional structured
|
|
1744
|
+
* `attributes`, plus a `severity` and optional `field` path.
|
|
1745
|
+
*/
|
|
1268
1746
|
export interface InvoiceValidationIssue {
|
|
1269
1747
|
/** Machine-readable error code. */
|
|
1270
1748
|
code: string;
|
|
@@ -1274,10 +1752,19 @@ export interface InvoiceValidationIssue {
|
|
|
1274
1752
|
attributes?: Record<string, unknown>;
|
|
1275
1753
|
/** Severity of the validation issue. */
|
|
1276
1754
|
severity: 'critical' | 'warning';
|
|
1277
|
-
/**
|
|
1755
|
+
/**
|
|
1756
|
+
* JSON path to the field that caused this validation issue, if applicable.
|
|
1757
|
+
*
|
|
1758
|
+
* For example: `lines/0/rate_card/price`.
|
|
1759
|
+
*/
|
|
1278
1760
|
field?: string;
|
|
1279
1761
|
}
|
|
1280
|
-
/**
|
|
1762
|
+
/**
|
|
1763
|
+
* The set of state-transition actions available for an invoice in its current
|
|
1764
|
+
* status.
|
|
1765
|
+
*
|
|
1766
|
+
* A field is present only when that action is permitted from the current state.
|
|
1767
|
+
*/
|
|
1281
1768
|
export interface InvoiceAvailableActions {
|
|
1282
1769
|
/** Advance the invoice to the next workflow step. */
|
|
1283
1770
|
advance?: InvoiceAvailableActionDetails;
|
|
@@ -1348,11 +1835,17 @@ export interface CurrencyCustom {
|
|
|
1348
1835
|
id: string;
|
|
1349
1836
|
/** The type of the currency. */
|
|
1350
1837
|
type: 'custom';
|
|
1351
|
-
/**
|
|
1838
|
+
/**
|
|
1839
|
+
* The name of the currency. It should be a human-readable string that represents
|
|
1840
|
+
* the name of the currency, such as "US Dollar" or "Euro".
|
|
1841
|
+
*/
|
|
1352
1842
|
name: string;
|
|
1353
1843
|
/** Description of the currency. */
|
|
1354
1844
|
description?: string;
|
|
1355
|
-
/**
|
|
1845
|
+
/**
|
|
1846
|
+
* The symbol of the currency. It should be a string that represents the symbol of
|
|
1847
|
+
* the currency, such as "$" for US Dollar or "€" for Euro.
|
|
1848
|
+
*/
|
|
1356
1849
|
symbol?: string;
|
|
1357
1850
|
code: string;
|
|
1358
1851
|
/** An ISO-8601 timestamp representation of the custom currency creation date. */
|
|
@@ -1360,30 +1853,86 @@ export interface CurrencyCustom {
|
|
|
1360
1853
|
}
|
|
1361
1854
|
/** CurrencyCustom create request. */
|
|
1362
1855
|
export interface CreateCurrencyCustomRequest {
|
|
1363
|
-
/**
|
|
1856
|
+
/**
|
|
1857
|
+
* The name of the currency. It should be a human-readable string that represents
|
|
1858
|
+
* the name of the currency, such as "US Dollar" or "Euro".
|
|
1859
|
+
*/
|
|
1364
1860
|
name: string;
|
|
1365
1861
|
/** Description of the currency. */
|
|
1366
1862
|
description?: string;
|
|
1367
|
-
/**
|
|
1863
|
+
/**
|
|
1864
|
+
* The symbol of the currency. It should be a string that represents the symbol of
|
|
1865
|
+
* the currency, such as "$" for US Dollar or "€" for Euro.
|
|
1866
|
+
*/
|
|
1368
1867
|
symbol?: string;
|
|
1369
1868
|
code: string;
|
|
1370
1869
|
}
|
|
1371
|
-
/**
|
|
1870
|
+
/**
|
|
1871
|
+
* Unit conversion configuration.
|
|
1872
|
+
*
|
|
1873
|
+
* Transforms raw metered quantities into billing-ready units before pricing and
|
|
1874
|
+
* entitlement evaluation. Applied at the rate card level so the same feature can
|
|
1875
|
+
* be billed in different units across plans.
|
|
1876
|
+
*
|
|
1877
|
+
* Examples:
|
|
1878
|
+
*
|
|
1879
|
+
* - Meter bytes, bill GB: operation=divide, conversionFactor=1e9,
|
|
1880
|
+
* rounding=ceiling, displayUnit="GB"
|
|
1881
|
+
* - Meter seconds, bill hours: operation=divide, conversionFactor=3600,
|
|
1882
|
+
* rounding=ceiling, displayUnit="hours"
|
|
1883
|
+
* - Cost + 20% margin: operation=multiply, conversionFactor=1.2
|
|
1884
|
+
* - Bill per million tokens: operation=divide, conversionFactor=1e6,
|
|
1885
|
+
* rounding=ceiling, displayUnit="M"
|
|
1886
|
+
*
|
|
1887
|
+
* v1 equivalents:
|
|
1888
|
+
*
|
|
1889
|
+
* - DynamicPrice(multiplier): operation=multiply, conversionFactor=multiplier +
|
|
1890
|
+
* UnitPrice(amount=1)
|
|
1891
|
+
* - PackagePrice(amount, quantityPerPkg): operation=divide,
|
|
1892
|
+
* conversionFactor=quantityPerPkg, rounding=ceiling + UnitPrice(amount)
|
|
1893
|
+
*/
|
|
1372
1894
|
export interface UnitConfig {
|
|
1373
1895
|
/** The arithmetic operation to apply to the raw metered quantity. */
|
|
1374
1896
|
operation: 'divide' | 'multiply';
|
|
1375
|
-
/**
|
|
1897
|
+
/**
|
|
1898
|
+
* The factor used in the conversion operation.
|
|
1899
|
+
*
|
|
1900
|
+
* - For `divide`: `converted = raw / conversionFactor`.
|
|
1901
|
+
* - For `multiply`: `converted = raw × conversionFactor`.
|
|
1902
|
+
*
|
|
1903
|
+
* Must be a positive non-zero value.
|
|
1904
|
+
*/
|
|
1376
1905
|
conversion_factor: string;
|
|
1377
|
-
/**
|
|
1906
|
+
/**
|
|
1907
|
+
* The rounding mode applied to the converted quantity for invoicing.
|
|
1908
|
+
*
|
|
1909
|
+
* Defaults to none (no rounding). Entitlement checks always use the precise
|
|
1910
|
+
* (unrounded) value.
|
|
1911
|
+
*/
|
|
1378
1912
|
rounding: 'ceiling' | 'floor' | 'half_up' | 'none';
|
|
1379
|
-
/**
|
|
1913
|
+
/**
|
|
1914
|
+
* The number of decimal places to retain after rounding.
|
|
1915
|
+
*
|
|
1916
|
+
* Only meaningful when rounding is not "none". Defaults to 0 (round to whole
|
|
1917
|
+
* numbers).
|
|
1918
|
+
*/
|
|
1380
1919
|
precision: number;
|
|
1381
|
-
/**
|
|
1920
|
+
/**
|
|
1921
|
+
* A human-readable label for the converted unit shown on invoices and in the
|
|
1922
|
+
* customer portal (e.g., "GB", "hours", "M tokens").
|
|
1923
|
+
*
|
|
1924
|
+
* Optional. When omitted, no unit label is rendered.
|
|
1925
|
+
*/
|
|
1382
1926
|
display_unit?: string;
|
|
1383
1927
|
}
|
|
1384
1928
|
/** Query to evaluate feature access for a list of customers. */
|
|
1385
1929
|
export interface GovernanceQueryRequest {
|
|
1386
|
-
/**
|
|
1930
|
+
/**
|
|
1931
|
+
* Whether to include credit balance availability for each resolved customer. When
|
|
1932
|
+
* true, each feature evaluation includes credit balance checks.
|
|
1933
|
+
*
|
|
1934
|
+
* Defaults to `false`.
|
|
1935
|
+
*/
|
|
1387
1936
|
include_credits: boolean;
|
|
1388
1937
|
customer: GovernanceQueryRequestCustomers;
|
|
1389
1938
|
feature?: GovernanceQueryRequestFeatures;
|
|
@@ -1422,11 +1971,26 @@ export interface UpsertAppCustomerDataRequest {
|
|
|
1422
1971
|
/** Used if the customer has a linked external invoicing app. */
|
|
1423
1972
|
external_invoicing?: AppCustomerDataExternalInvoicing;
|
|
1424
1973
|
}
|
|
1425
|
-
/**
|
|
1974
|
+
/**
|
|
1975
|
+
* A credit adjustment can be used to make manual adjustments to a customer's
|
|
1976
|
+
* credit balance.
|
|
1977
|
+
*
|
|
1978
|
+
* Supported use-cases:
|
|
1979
|
+
*
|
|
1980
|
+
* - Usage correction
|
|
1981
|
+
*/
|
|
1426
1982
|
export interface CreditAdjustment {
|
|
1427
|
-
/**
|
|
1983
|
+
/**
|
|
1984
|
+
* Display name of the resource.
|
|
1985
|
+
*
|
|
1986
|
+
* Between 1 and 256 characters.
|
|
1987
|
+
*/
|
|
1428
1988
|
name: string;
|
|
1429
|
-
/**
|
|
1989
|
+
/**
|
|
1990
|
+
* Optional description of the resource.
|
|
1991
|
+
*
|
|
1992
|
+
* Maximum 1024 characters.
|
|
1993
|
+
*/
|
|
1430
1994
|
description?: string;
|
|
1431
1995
|
labels?: Labels;
|
|
1432
1996
|
/** The currency of the granted credits. */
|
|
@@ -1437,16 +2001,30 @@ export interface CreditAdjustment {
|
|
|
1437
2001
|
/** The credit balance by currency. */
|
|
1438
2002
|
export interface CreditBalance {
|
|
1439
2003
|
currency: string;
|
|
1440
|
-
/**
|
|
2004
|
+
/**
|
|
2005
|
+
* Credits that have been granted but cannot yet be consumed. Includes grants
|
|
2006
|
+
* awaiting payment clearance or with a future effective date.
|
|
2007
|
+
*/
|
|
1441
2008
|
pending: string;
|
|
1442
|
-
/**
|
|
2009
|
+
/**
|
|
2010
|
+
* Credits that can be consumed right now. Derived from cleared grants after
|
|
2011
|
+
* applying eligibility and restriction rules.
|
|
2012
|
+
*/
|
|
1443
2013
|
available: string;
|
|
1444
2014
|
}
|
|
1445
2015
|
/** CreditAdjustment create request. */
|
|
1446
2016
|
export interface CreateCreditAdjustmentRequest {
|
|
1447
|
-
/**
|
|
2017
|
+
/**
|
|
2018
|
+
* Display name of the resource.
|
|
2019
|
+
*
|
|
2020
|
+
* Between 1 and 256 characters.
|
|
2021
|
+
*/
|
|
1448
2022
|
name: string;
|
|
1449
|
-
/**
|
|
2023
|
+
/**
|
|
2024
|
+
* Optional description of the resource.
|
|
2025
|
+
*
|
|
2026
|
+
* Maximum 1024 characters.
|
|
2027
|
+
*/
|
|
1450
2028
|
description?: string;
|
|
1451
2029
|
labels?: Labels;
|
|
1452
2030
|
/** The currency of the granted credits. */
|
|
@@ -1460,7 +2038,11 @@ export interface ListCreditTransactionsParamsFilter {
|
|
|
1460
2038
|
type?: 'funded' | 'consumed' | 'expired';
|
|
1461
2039
|
/** Filter credit transactions by currency. */
|
|
1462
2040
|
currency?: string;
|
|
1463
|
-
/**
|
|
2041
|
+
/**
|
|
2042
|
+
* Filter credit transactions by feature key. Omit to return all credit
|
|
2043
|
+
* transactions. Use `exists=false` to return only unrestricted credit
|
|
2044
|
+
* transactions.
|
|
2045
|
+
*/
|
|
1464
2046
|
feature_key?: string | {
|
|
1465
2047
|
eq?: string;
|
|
1466
2048
|
neq?: string;
|
|
@@ -1474,12 +2056,25 @@ export interface ListCreditTransactionsParamsFilter {
|
|
|
1474
2056
|
exists?: boolean;
|
|
1475
2057
|
};
|
|
1476
2058
|
}
|
|
1477
|
-
/**
|
|
2059
|
+
/**
|
|
2060
|
+
* A credit transaction represents a single credit movement on the customer's
|
|
2061
|
+
* balance.
|
|
2062
|
+
*
|
|
2063
|
+
* Credit transactions are immutable.
|
|
2064
|
+
*/
|
|
1478
2065
|
export interface CreditTransaction {
|
|
1479
2066
|
id: string;
|
|
1480
|
-
/**
|
|
2067
|
+
/**
|
|
2068
|
+
* Display name of the resource.
|
|
2069
|
+
*
|
|
2070
|
+
* Between 1 and 256 characters.
|
|
2071
|
+
*/
|
|
1481
2072
|
name: string;
|
|
1482
|
-
/**
|
|
2073
|
+
/**
|
|
2074
|
+
* Optional description of the resource.
|
|
2075
|
+
*
|
|
2076
|
+
* Maximum 1024 characters.
|
|
2077
|
+
*/
|
|
1483
2078
|
description?: string;
|
|
1484
2079
|
labels?: Labels;
|
|
1485
2080
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -1490,7 +2085,10 @@ export interface CreditTransaction {
|
|
|
1490
2085
|
type: 'funded' | 'consumed' | 'expired';
|
|
1491
2086
|
/** Currency of the balance affected by the transaction. */
|
|
1492
2087
|
currency: string;
|
|
1493
|
-
/**
|
|
2088
|
+
/**
|
|
2089
|
+
* Signed amount of the credit movement. Positive values add balance, negative
|
|
2090
|
+
* values reduce balance.
|
|
2091
|
+
*/
|
|
1494
2092
|
amount: string;
|
|
1495
2093
|
/** The available balance before and after the transaction. */
|
|
1496
2094
|
available_balance: {
|
|
@@ -1498,42 +2096,89 @@ export interface CreditTransaction {
|
|
|
1498
2096
|
after: string;
|
|
1499
2097
|
};
|
|
1500
2098
|
}
|
|
1501
|
-
/**
|
|
2099
|
+
/**
|
|
2100
|
+
* A price tier used in graduated and volume pricing.
|
|
2101
|
+
*
|
|
2102
|
+
* At least one price component (flat_price or unit_price) must be set. When
|
|
2103
|
+
* UnitConfig is present on the rate card, up_to_amount is expressed in converted
|
|
2104
|
+
* billing units.
|
|
2105
|
+
*/
|
|
1502
2106
|
export interface PriceTier {
|
|
1503
|
-
/**
|
|
2107
|
+
/**
|
|
2108
|
+
* Up to and including this quantity will be contained in the tier. If undefined,
|
|
2109
|
+
* the tier is open-ended (the last tier).
|
|
2110
|
+
*/
|
|
1504
2111
|
up_to_amount?: string;
|
|
1505
2112
|
/** The flat price component of the tier. Charged once when the tier is entered. */
|
|
1506
2113
|
flat_price?: PriceFlat;
|
|
1507
2114
|
/** The unit price component of the tier. Charged per billing unit within the tier. */
|
|
1508
2115
|
unit_price?: PriceUnit;
|
|
1509
2116
|
}
|
|
1510
|
-
/**
|
|
2117
|
+
/**
|
|
2118
|
+
* The totals of a change.
|
|
2119
|
+
*
|
|
2120
|
+
* RealTime is only expanded when the `real_time_usage` expand is used.
|
|
2121
|
+
*/
|
|
1511
2122
|
export interface ChargeTotals {
|
|
1512
2123
|
/** The amount of the charge already booked to the internal accounting system. */
|
|
1513
2124
|
booked: Totals;
|
|
1514
|
-
/**
|
|
2125
|
+
/**
|
|
2126
|
+
* The realtime amount of the charge.
|
|
2127
|
+
*
|
|
2128
|
+
* Requires the `realtime_usage` expand.
|
|
2129
|
+
*/
|
|
1515
2130
|
realtime?: Totals;
|
|
1516
2131
|
}
|
|
1517
|
-
/**
|
|
2132
|
+
/**
|
|
2133
|
+
* LLM cost lookup configuration. Each dimension (provider, model, token type) can
|
|
2134
|
+
* be specified as either a static value or a meter group-by property name
|
|
2135
|
+
* (mutually exclusive).
|
|
2136
|
+
*/
|
|
1518
2137
|
export interface FeatureLlmUnitCost {
|
|
1519
2138
|
/** The type discriminator for LLM unit cost. */
|
|
1520
2139
|
type: 'llm';
|
|
1521
|
-
/**
|
|
2140
|
+
/**
|
|
2141
|
+
* Meter group-by property that holds the LLM provider. Use this when the meter has
|
|
2142
|
+
* a group-by dimension for provider. Mutually exclusive with `provider`.
|
|
2143
|
+
*/
|
|
1522
2144
|
provider_property?: string;
|
|
1523
|
-
/**
|
|
2145
|
+
/**
|
|
2146
|
+
* Static LLM provider value (e.g., "openai", "anthropic"). Use this when the
|
|
2147
|
+
* feature tracks a single provider. Mutually exclusive with `provider_property`.
|
|
2148
|
+
*/
|
|
1524
2149
|
provider?: string;
|
|
1525
|
-
/**
|
|
2150
|
+
/**
|
|
2151
|
+
* Meter group-by property that holds the model ID. Use this when the meter has a
|
|
2152
|
+
* group-by dimension for model. Mutually exclusive with `model`.
|
|
2153
|
+
*/
|
|
1526
2154
|
model_property?: string;
|
|
1527
|
-
/**
|
|
2155
|
+
/**
|
|
2156
|
+
* Static model ID value (e.g., "gpt-4", "claude-3-5-sonnet"). Use this when the
|
|
2157
|
+
* feature tracks a single model. Mutually exclusive with `model_property`.
|
|
2158
|
+
*/
|
|
1528
2159
|
model?: string;
|
|
1529
|
-
/**
|
|
2160
|
+
/**
|
|
2161
|
+
* Meter group-by property that holds the token type. Use this when the meter has a
|
|
2162
|
+
* group-by dimension for token type. Mutually exclusive with `token_type`.
|
|
2163
|
+
*/
|
|
1530
2164
|
token_type_property?: string;
|
|
1531
|
-
/**
|
|
2165
|
+
/**
|
|
2166
|
+
* Static token type value. Use this when the feature tracks a single token type
|
|
2167
|
+
* (e.g., only input tokens). `request` is an alias for `input`, `response` is an
|
|
2168
|
+
* alias for `output`. Mutually exclusive with `token_type_property`.
|
|
2169
|
+
*/
|
|
1532
2170
|
token_type?: 'input' | 'output' | 'cache_read' | 'cache_write' | 'reasoning' | 'request' | 'response';
|
|
1533
|
-
/**
|
|
2171
|
+
/**
|
|
2172
|
+
* Resolved per-token pricing from the LLM cost database. Populated in responses
|
|
2173
|
+
* when the provider and model can be determined, either from static values or from
|
|
2174
|
+
* meter group-by filters with exact matches.
|
|
2175
|
+
*/
|
|
1534
2176
|
pricing?: FeatureLlmUnitCostPricing;
|
|
1535
2177
|
}
|
|
1536
|
-
/**
|
|
2178
|
+
/**
|
|
2179
|
+
* An LLM cost price record, representing the cost per token for a specific model
|
|
2180
|
+
* from a specific provider.
|
|
2181
|
+
*/
|
|
1537
2182
|
export interface LlmCostPrice {
|
|
1538
2183
|
/** Unique identifier. */
|
|
1539
2184
|
id: string;
|
|
@@ -1556,7 +2201,11 @@ export interface LlmCostPrice {
|
|
|
1556
2201
|
/** Last update timestamp. */
|
|
1557
2202
|
updated_at: string;
|
|
1558
2203
|
}
|
|
1559
|
-
/**
|
|
2204
|
+
/**
|
|
2205
|
+
* Input for creating a per-namespace price override. Unique per provider, model
|
|
2206
|
+
* and currency. If an override already exists for the given provider, model and
|
|
2207
|
+
* currency, it will be updated. If an override does not exist, it will be created.
|
|
2208
|
+
*/
|
|
1560
2209
|
export interface LlmCostOverrideCreate {
|
|
1561
2210
|
/** Provider/vendor of the model. */
|
|
1562
2211
|
provider: string;
|
|
@@ -1743,14 +2392,24 @@ export interface ListAddonsParamsFilter {
|
|
|
1743
2392
|
neq?: string;
|
|
1744
2393
|
};
|
|
1745
2394
|
}
|
|
1746
|
-
/**
|
|
2395
|
+
/**
|
|
2396
|
+
* Tax configuration for a credit grant.
|
|
2397
|
+
*
|
|
2398
|
+
* Tax configuration should be provided to ensure correct revenue recognition,
|
|
2399
|
+
* including for externally funded grants.
|
|
2400
|
+
*/
|
|
1747
2401
|
export interface CreateCreditGrantTaxConfig {
|
|
1748
2402
|
/** Tax behavior applied to the invoice line item. */
|
|
1749
2403
|
behavior?: 'inclusive' | 'exclusive';
|
|
1750
2404
|
/** Tax code applied to the invoice line item. */
|
|
1751
2405
|
tax_code?: CreateResourceReference;
|
|
1752
2406
|
}
|
|
1753
|
-
/**
|
|
2407
|
+
/**
|
|
2408
|
+
* Tax configuration for a credit grant.
|
|
2409
|
+
*
|
|
2410
|
+
* Tax configuration should be provided to ensure correct revenue recognition,
|
|
2411
|
+
* including for externally funded grants.
|
|
2412
|
+
*/
|
|
1754
2413
|
export interface CreditGrantTaxConfig {
|
|
1755
2414
|
/** Tax behavior applied to the invoice line item. */
|
|
1756
2415
|
behavior?: 'inclusive' | 'exclusive';
|
|
@@ -1759,7 +2418,12 @@ export interface CreditGrantTaxConfig {
|
|
|
1759
2418
|
}
|
|
1760
2419
|
/** Set of provider specific tax configs. */
|
|
1761
2420
|
export interface TaxConfig {
|
|
1762
|
-
/**
|
|
2421
|
+
/**
|
|
2422
|
+
* Tax behavior.
|
|
2423
|
+
*
|
|
2424
|
+
* If not specified the billing profile is used to determine the tax behavior. If
|
|
2425
|
+
* not specified in the billing profile, the provider's default behavior is used.
|
|
2426
|
+
*/
|
|
1763
2427
|
behavior?: 'inclusive' | 'exclusive';
|
|
1764
2428
|
/** Stripe tax config. */
|
|
1765
2429
|
stripe?: TaxConfigStripe;
|
|
@@ -1767,7 +2431,13 @@ export interface TaxConfig {
|
|
|
1767
2431
|
external_invoicing?: TaxConfigExternalInvoicing;
|
|
1768
2432
|
/** Tax code ID. */
|
|
1769
2433
|
tax_code_id?: string;
|
|
1770
|
-
/**
|
|
2434
|
+
/**
|
|
2435
|
+
* Tax code reference.
|
|
2436
|
+
*
|
|
2437
|
+
* When both `tax_code` and `tax_code_id` are provided, `tax_code` takes
|
|
2438
|
+
* precedence. When `stripe.code` is also provided, `tax_code` still wins and
|
|
2439
|
+
* `stripe.code` is ignored.
|
|
2440
|
+
*/
|
|
1771
2441
|
tax_code?: TaxCodeReference;
|
|
1772
2442
|
}
|
|
1773
2443
|
/** The tax config of the rate card. */
|
|
@@ -1775,7 +2445,12 @@ export interface RateCardTaxConfig {
|
|
|
1775
2445
|
behavior?: 'inclusive' | 'exclusive';
|
|
1776
2446
|
code: TaxCodeReference;
|
|
1777
2447
|
}
|
|
1778
|
-
/**
|
|
2448
|
+
/**
|
|
2449
|
+
* Organization-level default tax code references.
|
|
2450
|
+
*
|
|
2451
|
+
* Stores the default tax codes applied to specific billing contexts for this
|
|
2452
|
+
* organization. Provisioned automatically when the organization is created.
|
|
2453
|
+
*/
|
|
1779
2454
|
export interface OrganizationDefaultTaxCodes {
|
|
1780
2455
|
/** Default tax code for invoicing. */
|
|
1781
2456
|
invoicing_tax_code: TaxCodeReference;
|
|
@@ -1796,9 +2471,17 @@ export interface UpdateOrganizationDefaultTaxCodesRequest {
|
|
|
1796
2471
|
/** Addon purchased with a subscription. */
|
|
1797
2472
|
export interface SubscriptionAddon {
|
|
1798
2473
|
id: string;
|
|
1799
|
-
/**
|
|
2474
|
+
/**
|
|
2475
|
+
* Display name of the resource.
|
|
2476
|
+
*
|
|
2477
|
+
* Between 1 and 256 characters.
|
|
2478
|
+
*/
|
|
1800
2479
|
name: string;
|
|
1801
|
-
/**
|
|
2480
|
+
/**
|
|
2481
|
+
* Optional description of the resource.
|
|
2482
|
+
*
|
|
2483
|
+
* Maximum 1024 characters.
|
|
2484
|
+
*/
|
|
1802
2485
|
description?: string;
|
|
1803
2486
|
labels?: Labels;
|
|
1804
2487
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -1811,19 +2494,33 @@ export interface SubscriptionAddon {
|
|
|
1811
2494
|
addon: AddonReference;
|
|
1812
2495
|
/** The quantity of the add-on. Always 1 for single instance add-ons. */
|
|
1813
2496
|
quantity: number;
|
|
1814
|
-
/**
|
|
2497
|
+
/**
|
|
2498
|
+
* An ISO-8601 timestamp representation of which point in time the quantity was
|
|
2499
|
+
* resolved to.
|
|
2500
|
+
*/
|
|
1815
2501
|
quantity_at: string;
|
|
1816
2502
|
/** An ISO-8601 timestamp representation of the cadence start of the resource. */
|
|
1817
2503
|
active_from: string;
|
|
1818
2504
|
/** An ISO-8601 timestamp representation of the cadence end of the resource. */
|
|
1819
2505
|
active_to?: string;
|
|
1820
2506
|
}
|
|
1821
|
-
/**
|
|
2507
|
+
/**
|
|
2508
|
+
* PlanAddon represents an association between a plan and an add-on, controlling
|
|
2509
|
+
* which add-ons are available for purchase within a plan.
|
|
2510
|
+
*/
|
|
1822
2511
|
export interface PlanAddon {
|
|
1823
2512
|
id: string;
|
|
1824
|
-
/**
|
|
2513
|
+
/**
|
|
2514
|
+
* Display name of the resource.
|
|
2515
|
+
*
|
|
2516
|
+
* Between 1 and 256 characters.
|
|
2517
|
+
*/
|
|
1825
2518
|
name: string;
|
|
1826
|
-
/**
|
|
2519
|
+
/**
|
|
2520
|
+
* Optional description of the resource.
|
|
2521
|
+
*
|
|
2522
|
+
* Maximum 1024 characters.
|
|
2523
|
+
*/
|
|
1827
2524
|
description?: string;
|
|
1828
2525
|
labels?: Labels;
|
|
1829
2526
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -1836,23 +2533,39 @@ export interface PlanAddon {
|
|
|
1836
2533
|
addon: AddonReference;
|
|
1837
2534
|
/** The key of the plan phase from which the add-on becomes available for purchase. */
|
|
1838
2535
|
from_plan_phase: string;
|
|
1839
|
-
/**
|
|
2536
|
+
/**
|
|
2537
|
+
* The maximum number of times the add-on can be purchased for the plan. For
|
|
2538
|
+
* single-instance add-ons this field must be omitted. For multi-instance add-ons
|
|
2539
|
+
* when omitted, unlimited quantity can be purchased.
|
|
2540
|
+
*/
|
|
1840
2541
|
max_quantity?: number;
|
|
1841
2542
|
/** List of validation errors. */
|
|
1842
2543
|
validation_errors?: ProductCatalogValidationError[];
|
|
1843
2544
|
}
|
|
1844
2545
|
/** PlanAddon create request. */
|
|
1845
2546
|
export interface CreatePlanAddonRequest {
|
|
1846
|
-
/**
|
|
2547
|
+
/**
|
|
2548
|
+
* Display name of the resource.
|
|
2549
|
+
*
|
|
2550
|
+
* Between 1 and 256 characters.
|
|
2551
|
+
*/
|
|
1847
2552
|
name: string;
|
|
1848
|
-
/**
|
|
2553
|
+
/**
|
|
2554
|
+
* Optional description of the resource.
|
|
2555
|
+
*
|
|
2556
|
+
* Maximum 1024 characters.
|
|
2557
|
+
*/
|
|
1849
2558
|
description?: string;
|
|
1850
2559
|
labels?: Labels;
|
|
1851
2560
|
/** The add-on associated with the plan. */
|
|
1852
2561
|
addon: AddonReference;
|
|
1853
2562
|
/** The key of the plan phase from which the add-on becomes available for purchase. */
|
|
1854
2563
|
from_plan_phase: string;
|
|
1855
|
-
/**
|
|
2564
|
+
/**
|
|
2565
|
+
* The maximum number of times the add-on can be purchased for the plan. For
|
|
2566
|
+
* single-instance add-ons this field must be omitted. For multi-instance add-ons
|
|
2567
|
+
* when omitted, unlimited quantity can be purchased.
|
|
2568
|
+
*/
|
|
1856
2569
|
max_quantity?: number;
|
|
1857
2570
|
}
|
|
1858
2571
|
/** References to the applications used by a billing profile. */
|
|
@@ -1864,7 +2577,10 @@ export interface ProfileAppReferences {
|
|
|
1864
2577
|
/** The payment app used for this workflow. */
|
|
1865
2578
|
payment: AppReference;
|
|
1866
2579
|
}
|
|
1867
|
-
/**
|
|
2580
|
+
/**
|
|
2581
|
+
* BillingInvoiceWorkflowAppsReferences represents the references (id) to the apps
|
|
2582
|
+
* used by a billing profile
|
|
2583
|
+
*/
|
|
1868
2584
|
export interface InvoiceWorkflowAppsReferences {
|
|
1869
2585
|
/** The tax app used for this workflow */
|
|
1870
2586
|
tax: AppReference;
|
|
@@ -2084,7 +2800,10 @@ export interface CostBasisPagePaginatedResponse {
|
|
|
2084
2800
|
}
|
|
2085
2801
|
/** Filters to apply to a meter query. */
|
|
2086
2802
|
export interface MeterQueryFilters {
|
|
2087
|
-
/**
|
|
2803
|
+
/**
|
|
2804
|
+
* Filters to apply to the dimensions of the query. For `subject` and `customer_id`
|
|
2805
|
+
* only equals ("eq", "in") comparisons are supported.
|
|
2806
|
+
*/
|
|
2088
2807
|
dimensions?: Record<string, QueryFilterStringMapItem>;
|
|
2089
2808
|
}
|
|
2090
2809
|
/** Reference to a meter associated with a feature. */
|
|
@@ -2096,9 +2815,17 @@ export interface FeatureMeterReference {
|
|
|
2096
2815
|
}
|
|
2097
2816
|
/** Customer create request. */
|
|
2098
2817
|
export interface CreateCustomerRequest {
|
|
2099
|
-
/**
|
|
2818
|
+
/**
|
|
2819
|
+
* Display name of the resource.
|
|
2820
|
+
*
|
|
2821
|
+
* Between 1 and 256 characters.
|
|
2822
|
+
*/
|
|
2100
2823
|
name: string;
|
|
2101
|
-
/**
|
|
2824
|
+
/**
|
|
2825
|
+
* Optional description of the resource.
|
|
2826
|
+
*
|
|
2827
|
+
* Maximum 1024 characters.
|
|
2828
|
+
*/
|
|
2102
2829
|
description?: string;
|
|
2103
2830
|
labels?: Labels;
|
|
2104
2831
|
key: string;
|
|
@@ -2111,12 +2838,23 @@ export interface CreateCustomerRequest {
|
|
|
2111
2838
|
/** The billing address of the customer. Used for tax and invoicing. */
|
|
2112
2839
|
billing_address?: Address;
|
|
2113
2840
|
}
|
|
2114
|
-
/**
|
|
2841
|
+
/**
|
|
2842
|
+
* Customers can be individuals or organizations that can subscribe to plans and
|
|
2843
|
+
* have access to features.
|
|
2844
|
+
*/
|
|
2115
2845
|
export interface Customer {
|
|
2116
2846
|
id: string;
|
|
2117
|
-
/**
|
|
2847
|
+
/**
|
|
2848
|
+
* Display name of the resource.
|
|
2849
|
+
*
|
|
2850
|
+
* Between 1 and 256 characters.
|
|
2851
|
+
*/
|
|
2118
2852
|
name: string;
|
|
2119
|
-
/**
|
|
2853
|
+
/**
|
|
2854
|
+
* Optional description of the resource.
|
|
2855
|
+
*
|
|
2856
|
+
* Maximum 1024 characters.
|
|
2857
|
+
*/
|
|
2120
2858
|
description?: string;
|
|
2121
2859
|
labels?: Labels;
|
|
2122
2860
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2137,9 +2875,17 @@ export interface Customer {
|
|
|
2137
2875
|
}
|
|
2138
2876
|
/** Customer upsert request. */
|
|
2139
2877
|
export interface UpsertCustomerRequest {
|
|
2140
|
-
/**
|
|
2878
|
+
/**
|
|
2879
|
+
* Display name of the resource.
|
|
2880
|
+
*
|
|
2881
|
+
* Between 1 and 256 characters.
|
|
2882
|
+
*/
|
|
2141
2883
|
name: string;
|
|
2142
|
-
/**
|
|
2884
|
+
/**
|
|
2885
|
+
* Optional description of the resource.
|
|
2886
|
+
*
|
|
2887
|
+
* Maximum 1024 characters.
|
|
2888
|
+
*/
|
|
2143
2889
|
description?: string;
|
|
2144
2890
|
labels?: Labels;
|
|
2145
2891
|
/** Mapping to attribute metered usage to the customer by the event subject. */
|
|
@@ -2159,22 +2905,41 @@ export interface PartyAddresses {
|
|
|
2159
2905
|
/** Snapshot of the customer's information at the time the invoice was issued. */
|
|
2160
2906
|
export interface InvoiceCustomer {
|
|
2161
2907
|
id: string;
|
|
2162
|
-
/**
|
|
2908
|
+
/**
|
|
2909
|
+
* Display name of the resource.
|
|
2910
|
+
*
|
|
2911
|
+
* Between 1 and 256 characters.
|
|
2912
|
+
*/
|
|
2163
2913
|
name: string;
|
|
2164
2914
|
/** Mapping to attribute metered usage to the customer by the event subject. */
|
|
2165
2915
|
usage_attribution?: CustomerUsageAttribution;
|
|
2166
2916
|
/** The billing address of the customer. Used for tax and invoicing. */
|
|
2167
2917
|
billing_address?: Address;
|
|
2168
|
-
/**
|
|
2918
|
+
/**
|
|
2919
|
+
* Optional external resource key for the customer.
|
|
2920
|
+
*
|
|
2921
|
+
* Omitted when the customer was created without a key. Unlike on the customer
|
|
2922
|
+
* resource itself, the key is optional here because the invoice snapshot may
|
|
2923
|
+
* predate or omit it.
|
|
2924
|
+
*/
|
|
2169
2925
|
key?: string;
|
|
2170
2926
|
}
|
|
2171
2927
|
/** Checkout Session consent collection configuration. */
|
|
2172
2928
|
export interface AppStripeCreateCheckoutSessionConsentCollection {
|
|
2173
2929
|
/** Controls the visibility of payment method reuse agreement. */
|
|
2174
2930
|
payment_method_reuse_agreement?: AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement;
|
|
2175
|
-
/**
|
|
2931
|
+
/**
|
|
2932
|
+
* Enables collection of promotional communication consent.
|
|
2933
|
+
*
|
|
2934
|
+
* Only available to US merchants. When set to "auto", Checkout determines whether
|
|
2935
|
+
* to show the option based on the customer's locale.
|
|
2936
|
+
*/
|
|
2176
2937
|
promotions?: 'auto' | 'none';
|
|
2177
|
-
/**
|
|
2938
|
+
/**
|
|
2939
|
+
* Requires customers to accept terms of service before payment.
|
|
2940
|
+
*
|
|
2941
|
+
* Requires a valid terms of service URL in your Stripe Dashboard settings.
|
|
2942
|
+
*/
|
|
2178
2943
|
terms_of_service?: 'none' | 'required';
|
|
2179
2944
|
}
|
|
2180
2945
|
/** List customer entitlement access response data. */
|
|
@@ -2182,7 +2947,10 @@ export interface ListCustomerEntitlementAccessResponseData {
|
|
|
2182
2947
|
/** The list of entitlement access results. */
|
|
2183
2948
|
data: EntitlementAccessResult[];
|
|
2184
2949
|
}
|
|
2185
|
-
/**
|
|
2950
|
+
/**
|
|
2951
|
+
* BillingWorkflowCollectionAlignmentAnchored specifies the alignment for
|
|
2952
|
+
* collecting the pending line items into an invoice.
|
|
2953
|
+
*/
|
|
2186
2954
|
export interface WorkflowCollectionAlignmentAnchored {
|
|
2187
2955
|
/** The type of alignment. */
|
|
2188
2956
|
type: 'anchored';
|
|
@@ -2209,7 +2977,15 @@ export interface SubscriptionCancel {
|
|
|
2209
2977
|
/** Request for changing a subscription. */
|
|
2210
2978
|
export interface SubscriptionChange {
|
|
2211
2979
|
labels?: Labels;
|
|
2212
|
-
/**
|
|
2980
|
+
/**
|
|
2981
|
+
* Settlement mode for billing.
|
|
2982
|
+
*
|
|
2983
|
+
* Values:
|
|
2984
|
+
*
|
|
2985
|
+
* - `credit_then_invoice`: Credits are applied first, then any remainder is
|
|
2986
|
+
* invoiced.
|
|
2987
|
+
* - `credit_only`: Usage is settled exclusively against credits.
|
|
2988
|
+
*/
|
|
2213
2989
|
settlement_mode?: 'credit_then_invoice' | 'credit_only';
|
|
2214
2990
|
/** The customer to create the subscription for. */
|
|
2215
2991
|
customer: {
|
|
@@ -2222,17 +2998,40 @@ export interface SubscriptionChange {
|
|
|
2222
2998
|
key?: string;
|
|
2223
2999
|
version?: number;
|
|
2224
3000
|
};
|
|
2225
|
-
/**
|
|
3001
|
+
/**
|
|
3002
|
+
* A billing anchor is the fixed point in time that determines the subscription's
|
|
3003
|
+
* recurring billing cycle. It affects when charges occur and how prorations are
|
|
3004
|
+
* calculated. Common anchors:
|
|
3005
|
+
*
|
|
3006
|
+
* - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
|
|
3007
|
+
* - Subscription anniversary (day customer signed up)
|
|
3008
|
+
* - Custom date (customer-specified day)
|
|
3009
|
+
*
|
|
3010
|
+
* If not provided, the subscription will be created with the subscription's
|
|
3011
|
+
* creation time as the billing anchor.
|
|
3012
|
+
*/
|
|
2226
3013
|
billing_anchor?: string;
|
|
2227
|
-
/**
|
|
3014
|
+
/**
|
|
3015
|
+
* Timing configuration for the change, when the change should take effect. For
|
|
3016
|
+
* changing a subscription, the accepted values depend on the subscription
|
|
3017
|
+
* configuration.
|
|
3018
|
+
*/
|
|
2228
3019
|
timing: 'immediate' | 'next_billing_cycle' | string;
|
|
2229
3020
|
}
|
|
2230
3021
|
/** Stripe app. */
|
|
2231
3022
|
export interface AppStripe {
|
|
2232
3023
|
id: string;
|
|
2233
|
-
/**
|
|
3024
|
+
/**
|
|
3025
|
+
* Display name of the resource.
|
|
3026
|
+
*
|
|
3027
|
+
* Between 1 and 256 characters.
|
|
3028
|
+
*/
|
|
2234
3029
|
name: string;
|
|
2235
|
-
/**
|
|
3030
|
+
/**
|
|
3031
|
+
* Optional description of the resource.
|
|
3032
|
+
*
|
|
3033
|
+
* Maximum 1024 characters.
|
|
3034
|
+
*/
|
|
2236
3035
|
description?: string;
|
|
2237
3036
|
labels?: Labels;
|
|
2238
3037
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2259,9 +3058,17 @@ export interface AppStripe {
|
|
|
2259
3058
|
/** Sandbox app can be used for testing billing features. */
|
|
2260
3059
|
export interface AppSandbox {
|
|
2261
3060
|
id: string;
|
|
2262
|
-
/**
|
|
3061
|
+
/**
|
|
3062
|
+
* Display name of the resource.
|
|
3063
|
+
*
|
|
3064
|
+
* Between 1 and 256 characters.
|
|
3065
|
+
*/
|
|
2263
3066
|
name: string;
|
|
2264
|
-
/**
|
|
3067
|
+
/**
|
|
3068
|
+
* Optional description of the resource.
|
|
3069
|
+
*
|
|
3070
|
+
* Maximum 1024 characters.
|
|
3071
|
+
*/
|
|
2265
3072
|
description?: string;
|
|
2266
3073
|
labels?: Labels;
|
|
2267
3074
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2277,12 +3084,38 @@ export interface AppSandbox {
|
|
|
2277
3084
|
/** Status of the app connection. */
|
|
2278
3085
|
status: 'ready' | 'unauthorized';
|
|
2279
3086
|
}
|
|
2280
|
-
/**
|
|
3087
|
+
/**
|
|
3088
|
+
* External Invoicing app enables integration with third-party invoicing or payment
|
|
3089
|
+
* system.
|
|
3090
|
+
*
|
|
3091
|
+
* The app supports a bi-directional synchronization pattern where OpenMeter
|
|
3092
|
+
* Billing manages the invoice lifecycle while the external system handles invoice
|
|
3093
|
+
* presentation and payment collection.
|
|
3094
|
+
*
|
|
3095
|
+
* Integration workflow:
|
|
3096
|
+
*
|
|
3097
|
+
* 1. The billing system creates invoices and transitions them through lifecycle
|
|
3098
|
+
* states (draft → issuing → issued)
|
|
3099
|
+
* 2. The integration receives webhook notifications about invoice state changes
|
|
3100
|
+
* 3. The integration calls back to provide external system IDs and metadata
|
|
3101
|
+
* 4. The integration reports payment events back via the payment status API
|
|
3102
|
+
*
|
|
3103
|
+
* State synchronization is controlled by hooks that pause invoice progression
|
|
3104
|
+
* until the external system confirms synchronization via API callbacks.
|
|
3105
|
+
*/
|
|
2281
3106
|
export interface AppExternalInvoicing {
|
|
2282
3107
|
id: string;
|
|
2283
|
-
/**
|
|
3108
|
+
/**
|
|
3109
|
+
* Display name of the resource.
|
|
3110
|
+
*
|
|
3111
|
+
* Between 1 and 256 characters.
|
|
3112
|
+
*/
|
|
2284
3113
|
name: string;
|
|
2285
|
-
/**
|
|
3114
|
+
/**
|
|
3115
|
+
* Optional description of the resource.
|
|
3116
|
+
*
|
|
3117
|
+
* Maximum 1024 characters.
|
|
3118
|
+
*/
|
|
2286
3119
|
description?: string;
|
|
2287
3120
|
labels?: Labels;
|
|
2288
3121
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2297,16 +3130,44 @@ export interface AppExternalInvoicing {
|
|
|
2297
3130
|
definition: AppCatalogItem;
|
|
2298
3131
|
/** Status of the app connection. */
|
|
2299
3132
|
status: 'ready' | 'unauthorized';
|
|
2300
|
-
/**
|
|
3133
|
+
/**
|
|
3134
|
+
* Enable draft synchronization hook.
|
|
3135
|
+
*
|
|
3136
|
+
* When enabled, invoices will pause at the draft state and wait for the
|
|
3137
|
+
* integration to call the draft synchronized endpoint before progressing to the
|
|
3138
|
+
* issuing state. This allows the external system to validate and prepare the
|
|
3139
|
+
* invoice data.
|
|
3140
|
+
*
|
|
3141
|
+
* When disabled, invoices automatically progress through the draft state based on
|
|
3142
|
+
* the configured workflow timing.
|
|
3143
|
+
*/
|
|
2301
3144
|
enable_draft_sync_hook: boolean;
|
|
2302
|
-
/**
|
|
3145
|
+
/**
|
|
3146
|
+
* Enable issuing synchronization hook.
|
|
3147
|
+
*
|
|
3148
|
+
* When enabled, invoices will pause at the issuing state and wait for the
|
|
3149
|
+
* integration to call the issuing synchronized endpoint before progressing to the
|
|
3150
|
+
* issued state. This ensures the external invoicing system has successfully
|
|
3151
|
+
* created and finalized the invoice before it is marked as issued.
|
|
3152
|
+
*
|
|
3153
|
+
* When disabled, invoices automatically progress through the issuing state and are
|
|
3154
|
+
* immediately marked as issued.
|
|
3155
|
+
*/
|
|
2303
3156
|
enable_issuing_sync_hook: boolean;
|
|
2304
3157
|
}
|
|
2305
3158
|
/** TaxCode create request. */
|
|
2306
3159
|
export interface CreateTaxCodeRequest {
|
|
2307
|
-
/**
|
|
3160
|
+
/**
|
|
3161
|
+
* Display name of the resource.
|
|
3162
|
+
*
|
|
3163
|
+
* Between 1 and 256 characters.
|
|
3164
|
+
*/
|
|
2308
3165
|
name: string;
|
|
2309
|
-
/**
|
|
3166
|
+
/**
|
|
3167
|
+
* Optional description of the resource.
|
|
3168
|
+
*
|
|
3169
|
+
* Maximum 1024 characters.
|
|
3170
|
+
*/
|
|
2310
3171
|
description?: string;
|
|
2311
3172
|
labels?: Labels;
|
|
2312
3173
|
key: string;
|
|
@@ -2316,9 +3177,17 @@ export interface CreateTaxCodeRequest {
|
|
|
2316
3177
|
/** Tax codes by provider. */
|
|
2317
3178
|
export interface TaxCode {
|
|
2318
3179
|
id: string;
|
|
2319
|
-
/**
|
|
3180
|
+
/**
|
|
3181
|
+
* Display name of the resource.
|
|
3182
|
+
*
|
|
3183
|
+
* Between 1 and 256 characters.
|
|
3184
|
+
*/
|
|
2320
3185
|
name: string;
|
|
2321
|
-
/**
|
|
3186
|
+
/**
|
|
3187
|
+
* Optional description of the resource.
|
|
3188
|
+
*
|
|
3189
|
+
* Maximum 1024 characters.
|
|
3190
|
+
*/
|
|
2322
3191
|
description?: string;
|
|
2323
3192
|
labels?: Labels;
|
|
2324
3193
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2333,15 +3202,29 @@ export interface TaxCode {
|
|
|
2333
3202
|
}
|
|
2334
3203
|
/** TaxCode upsert request. */
|
|
2335
3204
|
export interface UpsertTaxCodeRequest {
|
|
2336
|
-
/**
|
|
3205
|
+
/**
|
|
3206
|
+
* Display name of the resource.
|
|
3207
|
+
*
|
|
3208
|
+
* Between 1 and 256 characters.
|
|
3209
|
+
*/
|
|
2337
3210
|
name: string;
|
|
2338
|
-
/**
|
|
3211
|
+
/**
|
|
3212
|
+
* Optional description of the resource.
|
|
3213
|
+
*
|
|
3214
|
+
* Maximum 1024 characters.
|
|
3215
|
+
*/
|
|
2339
3216
|
description?: string;
|
|
2340
3217
|
labels?: Labels;
|
|
2341
3218
|
/** Mapping of app types to tax codes. */
|
|
2342
3219
|
app_mappings: TaxCodeAppMapping[];
|
|
2343
3220
|
}
|
|
2344
|
-
/**
|
|
3221
|
+
/**
|
|
3222
|
+
* Invoice-level snapshot of the workflow configuration.
|
|
3223
|
+
*
|
|
3224
|
+
* Contains only the settings that are meaningful for an already-created invoice:
|
|
3225
|
+
* invoicing behaviour and payment settings. Collection alignment and tax policy
|
|
3226
|
+
* are gather-time / profile-wide concerns and are not included.
|
|
3227
|
+
*/
|
|
2345
3228
|
export interface InvoiceWorkflow {
|
|
2346
3229
|
/** Invoicing settings for this invoice. */
|
|
2347
3230
|
invoicing?: InvoiceWorkflowInvoicingSettings;
|
|
@@ -2354,7 +3237,10 @@ export interface InvoiceStatusDetails {
|
|
|
2354
3237
|
immutable: boolean;
|
|
2355
3238
|
/** Whether the invoice is in a failed state. */
|
|
2356
3239
|
failed: boolean;
|
|
2357
|
-
/**
|
|
3240
|
+
/**
|
|
3241
|
+
* Fine-grained internal status string providing additional workflow detail beyond
|
|
3242
|
+
* the top-level status enum.
|
|
3243
|
+
*/
|
|
2358
3244
|
extended_status: string;
|
|
2359
3245
|
/** The set of state-transition actions currently available for this invoice. */
|
|
2360
3246
|
available_actions: InvoiceAvailableActions;
|
|
@@ -2366,36 +3252,64 @@ export interface InvoiceLineDiscounts {
|
|
|
2366
3252
|
/** Usage quantity discounts (e.g. free tier usage allowances). */
|
|
2367
3253
|
usage?: InvoiceLineUsageDiscount[];
|
|
2368
3254
|
}
|
|
2369
|
-
/**
|
|
3255
|
+
/**
|
|
3256
|
+
* Usage quantity details on an invoice line item when UnitConfig is in effect.
|
|
3257
|
+
*
|
|
3258
|
+
* Provides the full audit trail from raw meter output to the invoiced amount.
|
|
3259
|
+
*/
|
|
2370
3260
|
export interface InvoiceUsageQuantityDetail {
|
|
2371
3261
|
/** The raw quantity as reported by the meter (native units). */
|
|
2372
3262
|
raw_quantity: string;
|
|
2373
|
-
/**
|
|
3263
|
+
/**
|
|
3264
|
+
* The precise decimal value after applying the conversion operation and factor,
|
|
3265
|
+
* before rounding.
|
|
3266
|
+
*/
|
|
2374
3267
|
converted_quantity: string;
|
|
2375
3268
|
/** The quantity after rounding, used for pricing. */
|
|
2376
3269
|
invoiced_quantity: string;
|
|
2377
3270
|
/** The display unit label (e.g., "GB", "hours", "M tokens"). */
|
|
2378
3271
|
display_unit?: string;
|
|
2379
|
-
/**
|
|
3272
|
+
/**
|
|
3273
|
+
* Snapshot of the UnitConfig that was in effect at billing time. Ensures
|
|
3274
|
+
* historical invoices reflect the config that was actually applied.
|
|
3275
|
+
*/
|
|
2380
3276
|
applied_unit_config: UnitConfig;
|
|
2381
3277
|
}
|
|
2382
3278
|
/** Access status for a single feature. */
|
|
2383
3279
|
export interface GovernanceFeatureAccess {
|
|
2384
|
-
/**
|
|
3280
|
+
/**
|
|
3281
|
+
* Whether the customer currently has access to the feature.
|
|
3282
|
+
*
|
|
3283
|
+
* `true` for boolean and static entitlements that are available, and for metered
|
|
3284
|
+
* entitlements with remaining balance. `false` when the feature is unavailable,
|
|
3285
|
+
* the usage limit has been reached, or (when applicable) credits have been
|
|
3286
|
+
* exhausted.
|
|
3287
|
+
*/
|
|
2385
3288
|
has_access: boolean;
|
|
2386
|
-
/**
|
|
3289
|
+
/**
|
|
3290
|
+
* Optional reason when the customer does not have access to the feature. Populated
|
|
3291
|
+
* when `has_access` is `false`.
|
|
3292
|
+
*/
|
|
2387
3293
|
reason?: GovernanceFeatureAccessReason;
|
|
2388
3294
|
}
|
|
2389
3295
|
/** Billing customer data. */
|
|
2390
3296
|
export interface CustomerData {
|
|
2391
|
-
/**
|
|
3297
|
+
/**
|
|
3298
|
+
* The billing profile for the customer.
|
|
3299
|
+
*
|
|
3300
|
+
* If not provided, the default billing profile will be used.
|
|
3301
|
+
*/
|
|
2392
3302
|
billing_profile?: ProfileReference;
|
|
2393
3303
|
/** App customer data. */
|
|
2394
3304
|
app_data?: AppCustomerData;
|
|
2395
3305
|
}
|
|
2396
3306
|
/** CustomerBillingData upsert request. */
|
|
2397
3307
|
export interface UpsertCustomerBillingDataRequest {
|
|
2398
|
-
/**
|
|
3308
|
+
/**
|
|
3309
|
+
* The billing profile for the customer.
|
|
3310
|
+
*
|
|
3311
|
+
* If not provided, the default billing profile will be used.
|
|
3312
|
+
*/
|
|
2399
3313
|
billing_profile?: ProfileReference;
|
|
2400
3314
|
/** App customer data. */
|
|
2401
3315
|
app_data?: AppCustomerData;
|
|
@@ -2412,14 +3326,30 @@ export interface CreditTransactionPaginatedResponse {
|
|
|
2412
3326
|
data: CreditTransaction[];
|
|
2413
3327
|
meta: CursorMeta;
|
|
2414
3328
|
}
|
|
2415
|
-
/**
|
|
3329
|
+
/**
|
|
3330
|
+
* Graduated tiered price.
|
|
3331
|
+
*
|
|
3332
|
+
* Each tier's rate applies only to the usage within that tier. Pricing can change
|
|
3333
|
+
* as cumulative usage crosses tier boundaries.
|
|
3334
|
+
*
|
|
3335
|
+
* When UnitConfig is present on the rate card, tier boundaries (up_to_amount) are
|
|
3336
|
+
* expressed in converted billing units.
|
|
3337
|
+
*/
|
|
2416
3338
|
export interface PriceGraduated {
|
|
2417
3339
|
/** The type of the price. */
|
|
2418
3340
|
type: 'graduated';
|
|
2419
3341
|
/** The tiers of the graduated price. At least one tier is required. */
|
|
2420
3342
|
tiers: PriceTier[];
|
|
2421
3343
|
}
|
|
2422
|
-
/**
|
|
3344
|
+
/**
|
|
3345
|
+
* Volume tiered price.
|
|
3346
|
+
*
|
|
3347
|
+
* The maximum quantity within a period determines the per-unit price for all units
|
|
3348
|
+
* in that period.
|
|
3349
|
+
*
|
|
3350
|
+
* When UnitConfig is present on the rate card, tier boundaries (up_to_amount) are
|
|
3351
|
+
* expressed in converted billing units.
|
|
3352
|
+
*/
|
|
2423
3353
|
export interface PriceVolume {
|
|
2424
3354
|
/** The type of the price. */
|
|
2425
3355
|
type: 'volume';
|
|
@@ -2433,9 +3363,17 @@ export interface PricePagePaginatedResponse {
|
|
|
2433
3363
|
}
|
|
2434
3364
|
/** CreditGrant create request. */
|
|
2435
3365
|
export interface CreateCreditGrantRequest {
|
|
2436
|
-
/**
|
|
3366
|
+
/**
|
|
3367
|
+
* Display name of the resource.
|
|
3368
|
+
*
|
|
3369
|
+
* Between 1 and 256 characters.
|
|
3370
|
+
*/
|
|
2437
3371
|
name: string;
|
|
2438
|
-
/**
|
|
3372
|
+
/**
|
|
3373
|
+
* Optional description of the resource.
|
|
3374
|
+
*
|
|
3375
|
+
* Maximum 1024 characters.
|
|
3376
|
+
*/
|
|
2439
3377
|
description?: string;
|
|
2440
3378
|
labels?: CreateLabels;
|
|
2441
3379
|
/** Funding method of the grant. */
|
|
@@ -2446,20 +3384,44 @@ export interface CreateCreditGrantRequest {
|
|
|
2446
3384
|
amount: string;
|
|
2447
3385
|
/** Present when a funding workflow applies (funding_method is not `none`). */
|
|
2448
3386
|
purchase?: CreateCreditGrantPurchase;
|
|
2449
|
-
/**
|
|
3387
|
+
/**
|
|
3388
|
+
* Tax configuration for the grant.
|
|
3389
|
+
*
|
|
3390
|
+
* For `invoice` and `external` funding methods, tax configuration should be
|
|
3391
|
+
* provided to ensure correct revenue recognition. When not provided, the default
|
|
3392
|
+
* credit grant tax code is applied, if that's not set the global default taxcode
|
|
3393
|
+
* is used.
|
|
3394
|
+
*/
|
|
2450
3395
|
tax_config?: CreateCreditGrantTaxConfig;
|
|
2451
3396
|
filters?: CreateCreditGrantFilters;
|
|
2452
3397
|
/** Draw-down priority of the grant. Lower values have higher priority. */
|
|
2453
3398
|
priority: number;
|
|
2454
|
-
/**
|
|
3399
|
+
/**
|
|
3400
|
+
* The duration after which the credit grant expires.
|
|
3401
|
+
*
|
|
3402
|
+
* Defaults to never expiring.
|
|
3403
|
+
*/
|
|
2455
3404
|
expires_after?: string;
|
|
2456
3405
|
}
|
|
2457
|
-
/**
|
|
3406
|
+
/**
|
|
3407
|
+
* A credit grant allocates credits to a customer.
|
|
3408
|
+
*
|
|
3409
|
+
* Credits are drawn down against charges according to the settlement mode
|
|
3410
|
+
* configured on the rate card.
|
|
3411
|
+
*/
|
|
2458
3412
|
export interface CreditGrant {
|
|
2459
3413
|
id: string;
|
|
2460
|
-
/**
|
|
3414
|
+
/**
|
|
3415
|
+
* Display name of the resource.
|
|
3416
|
+
*
|
|
3417
|
+
* Between 1 and 256 characters.
|
|
3418
|
+
*/
|
|
2461
3419
|
name: string;
|
|
2462
|
-
/**
|
|
3420
|
+
/**
|
|
3421
|
+
* Optional description of the resource.
|
|
3422
|
+
*
|
|
3423
|
+
* Maximum 1024 characters.
|
|
3424
|
+
*/
|
|
2463
3425
|
description?: string;
|
|
2464
3426
|
labels?: Labels;
|
|
2465
3427
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2476,16 +3438,31 @@ export interface CreditGrant {
|
|
|
2476
3438
|
amount: string;
|
|
2477
3439
|
/** Present when a funding workflow applies (funding_method is not `none`). */
|
|
2478
3440
|
purchase?: CreditGrantPurchase;
|
|
2479
|
-
/**
|
|
3441
|
+
/**
|
|
3442
|
+
* Tax configuration for the grant.
|
|
3443
|
+
*
|
|
3444
|
+
* For `invoice` and `external` funding methods, tax configuration should be
|
|
3445
|
+
* provided to ensure correct revenue recognition. When not provided, the default
|
|
3446
|
+
* credit grant tax code is applied, if that's not set the global default taxcode
|
|
3447
|
+
* is used.
|
|
3448
|
+
*/
|
|
2480
3449
|
tax_config?: CreditGrantTaxConfig;
|
|
2481
3450
|
/** Available when `funding_method` is `invoice`. */
|
|
2482
3451
|
invoice?: CreditGrantInvoiceReference;
|
|
2483
3452
|
filters?: CreditGrantFilters;
|
|
2484
3453
|
/** Draw-down priority of the grant. Lower values have higher priority. */
|
|
2485
3454
|
priority: number;
|
|
2486
|
-
/**
|
|
3455
|
+
/**
|
|
3456
|
+
* The duration after which the credit grant expires.
|
|
3457
|
+
*
|
|
3458
|
+
* Defaults to never expiring.
|
|
3459
|
+
*/
|
|
2487
3460
|
expires_after?: string;
|
|
2488
|
-
/**
|
|
3461
|
+
/**
|
|
3462
|
+
* The timestamp when the credit grant expires.
|
|
3463
|
+
*
|
|
3464
|
+
* Calculated from the grant effective time and `expires_after` if provided.
|
|
3465
|
+
*/
|
|
2489
3466
|
expires_at?: string;
|
|
2490
3467
|
/** Timestamp when the grant was voided. */
|
|
2491
3468
|
voided_at?: string;
|
|
@@ -2494,9 +3471,17 @@ export interface CreditGrant {
|
|
|
2494
3471
|
}
|
|
2495
3472
|
/** Flat fee charge create request. */
|
|
2496
3473
|
export interface CreateChargeFlatFeeRequest {
|
|
2497
|
-
/**
|
|
3474
|
+
/**
|
|
3475
|
+
* Display name of the resource.
|
|
3476
|
+
*
|
|
3477
|
+
* Between 1 and 256 characters.
|
|
3478
|
+
*/
|
|
2498
3479
|
name: string;
|
|
2499
|
-
/**
|
|
3480
|
+
/**
|
|
3481
|
+
* Optional description of the resource.
|
|
3482
|
+
*
|
|
3483
|
+
* Maximum 1024 characters.
|
|
3484
|
+
*/
|
|
2500
3485
|
description?: string;
|
|
2501
3486
|
labels?: Labels;
|
|
2502
3487
|
/** The type of the charge. */
|
|
@@ -2530,11 +3515,26 @@ export interface CreateChargeFlatFeeRequest {
|
|
|
2530
3515
|
}
|
|
2531
3516
|
/** Tax settings for a billing workflow. */
|
|
2532
3517
|
export interface WorkflowTaxSettings {
|
|
2533
|
-
/**
|
|
3518
|
+
/**
|
|
3519
|
+
* Enable automatic tax calculation when tax is supported by the app. For example,
|
|
3520
|
+
* with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.
|
|
3521
|
+
*/
|
|
2534
3522
|
enabled: boolean;
|
|
2535
|
-
/**
|
|
3523
|
+
/**
|
|
3524
|
+
* Enforce tax calculation when tax is supported by the app. When enabled, the
|
|
3525
|
+
* billing system will not allow to create an invoice without tax calculation.
|
|
3526
|
+
* Enforcement is different per apps, for example, Stripe app requires customer to
|
|
3527
|
+
* have a tax location when starting a paid subscription.
|
|
3528
|
+
*/
|
|
2536
3529
|
enforced: boolean;
|
|
2537
|
-
/**
|
|
3530
|
+
/**
|
|
3531
|
+
* Default tax configuration to apply to the invoices for line items.
|
|
3532
|
+
*
|
|
3533
|
+
* Setting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax
|
|
3534
|
+
* config is deprecated and can no longer be added or changed: the organization
|
|
3535
|
+
* default tax code is used instead. Existing tax-code values may still be removed,
|
|
3536
|
+
* and `behavior` remains fully supported.
|
|
3537
|
+
*/
|
|
2538
3538
|
default_tax_config?: TaxConfig;
|
|
2539
3539
|
}
|
|
2540
3540
|
/** Page paginated response. */
|
|
@@ -2560,9 +3560,16 @@ export interface MeterQueryRequest {
|
|
|
2560
3560
|
from?: string;
|
|
2561
3561
|
/** The end of the period the usage is queried to. */
|
|
2562
3562
|
to?: string;
|
|
2563
|
-
/**
|
|
3563
|
+
/**
|
|
3564
|
+
* The size of the time buckets to group the usage into. If not specified, the
|
|
3565
|
+
* usage is aggregated over the entire period.
|
|
3566
|
+
*/
|
|
2564
3567
|
granularity?: 'PT1M' | 'PT1H' | 'P1D' | 'P1M';
|
|
2565
|
-
/**
|
|
3568
|
+
/**
|
|
3569
|
+
* The value is the name of the time zone as defined in the IANA Time Zone Database
|
|
3570
|
+
* (http://www.iana.org/time-zones). The time zone is used to determine the start
|
|
3571
|
+
* and end of the time buckets. If not specified, the UTC timezone will be used.
|
|
3572
|
+
*/
|
|
2566
3573
|
time_zone: string;
|
|
2567
3574
|
/** The dimensions to group the results by. */
|
|
2568
3575
|
group_by_dimensions?: string[];
|
|
@@ -2582,53 +3589,123 @@ export interface Party {
|
|
|
2582
3589
|
key?: string;
|
|
2583
3590
|
/** Legal name or representation of the party. */
|
|
2584
3591
|
name?: string;
|
|
2585
|
-
/**
|
|
3592
|
+
/**
|
|
3593
|
+
* The entity's legal identification used for tax purposes. They may have other
|
|
3594
|
+
* numbers, but we're only interested in those valid for tax purposes.
|
|
3595
|
+
*/
|
|
2586
3596
|
tax_id?: PartyTaxIdentity;
|
|
2587
3597
|
/** Address for where information should be sent if needed. */
|
|
2588
3598
|
addresses?: PartyAddresses;
|
|
2589
3599
|
}
|
|
2590
|
-
/**
|
|
3600
|
+
/**
|
|
3601
|
+
* Snapshot of the supplier's information at the time the invoice was issued.
|
|
3602
|
+
*
|
|
3603
|
+
* Structurally a read-only subset of `BillingParty` (the type configured on the
|
|
3604
|
+
* billing profile), so the snapshot stays aligned with the source. `key` is
|
|
3605
|
+
* omitted because it is not part of the snapshotted supplier data.
|
|
3606
|
+
*/
|
|
2591
3607
|
export interface Supplier {
|
|
2592
3608
|
/** Unique identifier for the party. */
|
|
2593
3609
|
id?: string;
|
|
2594
3610
|
/** Legal name or representation of the party. */
|
|
2595
3611
|
name?: string;
|
|
2596
|
-
/**
|
|
3612
|
+
/**
|
|
3613
|
+
* The entity's legal identification used for tax purposes. They may have other
|
|
3614
|
+
* numbers, but we're only interested in those valid for tax purposes.
|
|
3615
|
+
*/
|
|
2597
3616
|
tax_id?: PartyTaxIdentity;
|
|
2598
3617
|
/** Address for where information should be sent if needed. */
|
|
2599
3618
|
addresses?: PartyAddresses;
|
|
2600
3619
|
}
|
|
2601
|
-
/**
|
|
3620
|
+
/**
|
|
3621
|
+
* Configuration options for creating a Stripe Checkout Session.
|
|
3622
|
+
*
|
|
3623
|
+
* Based on Stripe's
|
|
3624
|
+
* [Checkout Session API parameters](https://docs.stripe.com/api/checkout/sessions/create).
|
|
3625
|
+
*/
|
|
2602
3626
|
export interface AppStripeCreateCheckoutSessionRequestOptions {
|
|
2603
|
-
/**
|
|
3627
|
+
/**
|
|
3628
|
+
* Whether to collect the customer's billing address.
|
|
3629
|
+
*
|
|
3630
|
+
* Defaults to auto, which only collects the address when necessary for tax
|
|
3631
|
+
* calculation.
|
|
3632
|
+
*/
|
|
2604
3633
|
billing_address_collection: 'auto' | 'required';
|
|
2605
|
-
/**
|
|
3634
|
+
/**
|
|
3635
|
+
* URL to redirect customers who cancel the checkout session.
|
|
3636
|
+
*
|
|
3637
|
+
* Not allowed when ui_mode is "embedded".
|
|
3638
|
+
*/
|
|
2606
3639
|
cancel_url?: string;
|
|
2607
|
-
/**
|
|
3640
|
+
/**
|
|
3641
|
+
* Unique reference string for reconciling sessions with internal systems.
|
|
3642
|
+
*
|
|
3643
|
+
* Can be a customer ID, cart ID, or any other identifier.
|
|
3644
|
+
*/
|
|
2608
3645
|
client_reference_id?: string;
|
|
2609
3646
|
/** Controls which customer fields can be updated by the checkout session. */
|
|
2610
3647
|
customer_update?: AppStripeCreateCheckoutSessionCustomerUpdate;
|
|
2611
3648
|
/** Configuration for collecting customer consent during checkout. */
|
|
2612
3649
|
consent_collection?: AppStripeCreateCheckoutSessionConsentCollection;
|
|
2613
|
-
/**
|
|
3650
|
+
/**
|
|
3651
|
+
* Three-letter ISO 4217 currency code in uppercase.
|
|
3652
|
+
*
|
|
3653
|
+
* Required for payment mode sessions. Optional for setup mode sessions.
|
|
3654
|
+
*/
|
|
2614
3655
|
currency?: string;
|
|
2615
3656
|
/** Custom text to display during checkout at various stages. */
|
|
2616
3657
|
custom_text?: AppStripeCheckoutSessionCustomTextParams;
|
|
2617
|
-
/**
|
|
3658
|
+
/**
|
|
3659
|
+
* Unix timestamp when the checkout session expires.
|
|
3660
|
+
*
|
|
3661
|
+
* Can be 30 minutes to 24 hours from creation. Defaults to 24 hours.
|
|
3662
|
+
*/
|
|
2618
3663
|
expires_at?: bigint;
|
|
2619
|
-
/**
|
|
3664
|
+
/**
|
|
3665
|
+
* IETF language tag for the checkout UI locale.
|
|
3666
|
+
*
|
|
3667
|
+
* If blank or "auto", uses the browser's locale. Example: "en", "fr", "de".
|
|
3668
|
+
*/
|
|
2620
3669
|
locale?: string;
|
|
2621
|
-
/**
|
|
3670
|
+
/**
|
|
3671
|
+
* Set of key-value pairs to attach to the checkout session.
|
|
3672
|
+
*
|
|
3673
|
+
* Useful for storing additional structured information.
|
|
3674
|
+
*/
|
|
2622
3675
|
metadata?: Record<string, string>;
|
|
2623
|
-
/**
|
|
3676
|
+
/**
|
|
3677
|
+
* Return URL for embedded checkout sessions after payment authentication.
|
|
3678
|
+
*
|
|
3679
|
+
* Required if ui_mode is "embedded" and redirect-based payment methods are
|
|
3680
|
+
* enabled.
|
|
3681
|
+
*/
|
|
2624
3682
|
return_url?: string;
|
|
2625
|
-
/**
|
|
3683
|
+
/**
|
|
3684
|
+
* Success URL to redirect customers after completing payment or setup.
|
|
3685
|
+
*
|
|
3686
|
+
* Not allowed when ui_mode is "embedded". See:
|
|
3687
|
+
* https://docs.stripe.com/payments/checkout/custom-success-page
|
|
3688
|
+
*/
|
|
2626
3689
|
success_url?: string;
|
|
2627
|
-
/**
|
|
3690
|
+
/**
|
|
3691
|
+
* The UI mode for the checkout session.
|
|
3692
|
+
*
|
|
3693
|
+
* "hosted" displays a Stripe-hosted page. "embedded" integrates directly into your
|
|
3694
|
+
* app. Defaults to "hosted".
|
|
3695
|
+
*/
|
|
2628
3696
|
ui_mode: 'embedded' | 'hosted';
|
|
2629
|
-
/**
|
|
3697
|
+
/**
|
|
3698
|
+
* List of payment method types to enable (e.g., "card", "us_bank_account").
|
|
3699
|
+
*
|
|
3700
|
+
* If not specified, Stripe enables all relevant payment methods.
|
|
3701
|
+
*/
|
|
2630
3702
|
payment_method_types?: string[];
|
|
2631
|
-
/**
|
|
3703
|
+
/**
|
|
3704
|
+
* Redirect behavior for embedded checkout sessions.
|
|
3705
|
+
*
|
|
3706
|
+
* Controls when to redirect users after completion. See:
|
|
3707
|
+
* https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form
|
|
3708
|
+
*/
|
|
2632
3709
|
redirect_on_completion?: 'always' | 'if_required' | 'never';
|
|
2633
3710
|
/** Configuration for collecting tax IDs during checkout. */
|
|
2634
3711
|
tax_id_collection?: AppStripeCreateCheckoutSessionTaxIdCollection;
|
|
@@ -2644,15 +3721,35 @@ export interface InvoiceWorkflowSettings {
|
|
|
2644
3721
|
apps?: InvoiceWorkflowAppsReferences;
|
|
2645
3722
|
/** The billing profile that was the source of this workflow snapshot. */
|
|
2646
3723
|
source_billing_profile: ProfileReference;
|
|
2647
|
-
/**
|
|
3724
|
+
/**
|
|
3725
|
+
* The workflow configuration that was active when the invoice was created.
|
|
3726
|
+
*
|
|
3727
|
+
* Only the fields that are meaningful at the per-invoice level are included:
|
|
3728
|
+
* invoicing behaviour (auto-advance, draft period) and payment settings
|
|
3729
|
+
* (collection method, due date). Profile-wide settings such as collection
|
|
3730
|
+
* alignment, progressive billing, and tax policy are omitted.
|
|
3731
|
+
*/
|
|
2648
3732
|
workflow: InvoiceWorkflow;
|
|
2649
3733
|
}
|
|
2650
|
-
/**
|
|
3734
|
+
/**
|
|
3735
|
+
* A detailed (child) sub-line belonging to a parent invoice line.
|
|
3736
|
+
*
|
|
3737
|
+
* Detailed lines represent the individual flat-fee components that make up a
|
|
3738
|
+
* usage-based parent line after quantity snapshotting.
|
|
3739
|
+
*/
|
|
2651
3740
|
export interface InvoiceDetailedLine {
|
|
2652
3741
|
id: string;
|
|
2653
|
-
/**
|
|
3742
|
+
/**
|
|
3743
|
+
* Display name of the resource.
|
|
3744
|
+
*
|
|
3745
|
+
* Between 1 and 256 characters.
|
|
3746
|
+
*/
|
|
2654
3747
|
name: string;
|
|
2655
|
-
/**
|
|
3748
|
+
/**
|
|
3749
|
+
* Optional description of the resource.
|
|
3750
|
+
*
|
|
3751
|
+
* Maximum 1024 characters.
|
|
3752
|
+
*/
|
|
2656
3753
|
description?: string;
|
|
2657
3754
|
labels?: Labels;
|
|
2658
3755
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2685,21 +3782,44 @@ export interface CurrencyPagePaginatedResponse {
|
|
|
2685
3782
|
}
|
|
2686
3783
|
/** Access evaluation result for a single resolved customer. */
|
|
2687
3784
|
export interface GovernanceQueryResult {
|
|
2688
|
-
/**
|
|
3785
|
+
/**
|
|
3786
|
+
* The list of identifiers from the request that resolved to this customer. Each
|
|
3787
|
+
* entry is either the customer `key` or one of its usage-attribution subject
|
|
3788
|
+
* `key`s.
|
|
3789
|
+
*
|
|
3790
|
+
* Duplicate or aliased identifiers that resolve to the same customer collapse to a
|
|
3791
|
+
* single result entry, with every requested identifier listed here.
|
|
3792
|
+
*/
|
|
2689
3793
|
matched: string[];
|
|
2690
3794
|
/** The customer the matched identifiers resolved to. */
|
|
2691
3795
|
customer: Customer;
|
|
2692
|
-
/**
|
|
3796
|
+
/**
|
|
3797
|
+
* Map of features with their access status.
|
|
3798
|
+
*
|
|
3799
|
+
* Map keys are the feature keys requested in `feature.keys`, or every feature
|
|
3800
|
+
* `key` available in the organization when the feature filter was omitted.
|
|
3801
|
+
*/
|
|
2693
3802
|
features: Record<string, GovernanceFeatureAccess>;
|
|
2694
|
-
/**
|
|
3803
|
+
/**
|
|
3804
|
+
* Timestamp of the most recent change to the customer's access state reflected in
|
|
3805
|
+
* this result.
|
|
3806
|
+
*/
|
|
2695
3807
|
updated_at: string;
|
|
2696
3808
|
}
|
|
2697
3809
|
/** A capability or billable dimension offered by a provider. */
|
|
2698
3810
|
export interface Feature {
|
|
2699
3811
|
id: string;
|
|
2700
|
-
/**
|
|
3812
|
+
/**
|
|
3813
|
+
* Display name of the resource.
|
|
3814
|
+
*
|
|
3815
|
+
* Between 1 and 256 characters.
|
|
3816
|
+
*/
|
|
2701
3817
|
name: string;
|
|
2702
|
-
/**
|
|
3818
|
+
/**
|
|
3819
|
+
* Optional description of the resource.
|
|
3820
|
+
*
|
|
3821
|
+
* Maximum 1024 characters.
|
|
3822
|
+
*/
|
|
2703
3823
|
description?: string;
|
|
2704
3824
|
labels?: Labels;
|
|
2705
3825
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2709,27 +3829,57 @@ export interface Feature {
|
|
|
2709
3829
|
/** An ISO-8601 timestamp representation of entity deletion date. */
|
|
2710
3830
|
deleted_at?: string;
|
|
2711
3831
|
key: string;
|
|
2712
|
-
/**
|
|
3832
|
+
/**
|
|
3833
|
+
* The meter that the feature is associated with and based on which usage is
|
|
3834
|
+
* calculated. If not specified, the feature is static.
|
|
3835
|
+
*/
|
|
2713
3836
|
meter?: FeatureMeterReference;
|
|
2714
|
-
/**
|
|
3837
|
+
/**
|
|
3838
|
+
* Optional per-unit cost configuration. Use "manual" for a fixed per-unit cost, or
|
|
3839
|
+
* "llm" to look up cost from the LLM cost database based on meter group-by
|
|
3840
|
+
* properties.
|
|
3841
|
+
*/
|
|
2715
3842
|
unit_cost?: FeatureManualUnitCost | FeatureLlmUnitCost;
|
|
2716
3843
|
}
|
|
2717
3844
|
/** Feature create request. */
|
|
2718
3845
|
export interface CreateFeatureRequest {
|
|
2719
|
-
/**
|
|
3846
|
+
/**
|
|
3847
|
+
* Display name of the resource.
|
|
3848
|
+
*
|
|
3849
|
+
* Between 1 and 256 characters.
|
|
3850
|
+
*/
|
|
2720
3851
|
name: string;
|
|
2721
|
-
/**
|
|
3852
|
+
/**
|
|
3853
|
+
* Optional description of the resource.
|
|
3854
|
+
*
|
|
3855
|
+
* Maximum 1024 characters.
|
|
3856
|
+
*/
|
|
2722
3857
|
description?: string;
|
|
2723
3858
|
labels?: Labels;
|
|
2724
3859
|
key: string;
|
|
2725
|
-
/**
|
|
3860
|
+
/**
|
|
3861
|
+
* The meter that the feature is associated with and based on which usage is
|
|
3862
|
+
* calculated. If not specified, the feature is static.
|
|
3863
|
+
*/
|
|
2726
3864
|
meter?: FeatureMeterReference;
|
|
2727
|
-
/**
|
|
3865
|
+
/**
|
|
3866
|
+
* Optional per-unit cost configuration. Use "manual" for a fixed per-unit cost, or
|
|
3867
|
+
* "llm" to look up cost from the LLM cost database based on meter group-by
|
|
3868
|
+
* properties.
|
|
3869
|
+
*/
|
|
2728
3870
|
unit_cost?: FeatureManualUnitCost | FeatureLlmUnitCost;
|
|
2729
3871
|
}
|
|
2730
|
-
/**
|
|
3872
|
+
/**
|
|
3873
|
+
* Request body for updating a feature. Currently only the unit_cost field can be
|
|
3874
|
+
* updated.
|
|
3875
|
+
*/
|
|
2731
3876
|
export interface UpdateFeatureRequest {
|
|
2732
|
-
/**
|
|
3877
|
+
/**
|
|
3878
|
+
* Optional per-unit cost configuration. Use "manual" for a fixed per-unit cost, or
|
|
3879
|
+
* "llm" to look up cost from the LLM cost database based on meter group-by
|
|
3880
|
+
* properties. Set to `null` to clear the existing unit cost; omit to leave it
|
|
3881
|
+
* unchanged.
|
|
3882
|
+
*/
|
|
2733
3883
|
unit_cost?: FeatureManualUnitCost | FeatureLlmUnitCost | null;
|
|
2734
3884
|
}
|
|
2735
3885
|
/** Page paginated response. */
|
|
@@ -2742,10 +3892,18 @@ export interface BadRequest extends BaseError {
|
|
|
2742
3892
|
/** The list of parameters that failed validation. */
|
|
2743
3893
|
invalid_parameters: (InvalidParameterStandard | InvalidParameterMinimumLength | InvalidParameterMaximumLength | InvalidParameterChoiceItem | InvalidParameterDependentItem)[];
|
|
2744
3894
|
}
|
|
2745
|
-
/**
|
|
3895
|
+
/**
|
|
3896
|
+
* Base fields shared by all invoice types.
|
|
3897
|
+
*
|
|
3898
|
+
* Spread this model into each concrete invoice variant.
|
|
3899
|
+
*/
|
|
2746
3900
|
export interface InvoiceBase {
|
|
2747
3901
|
id: string;
|
|
2748
|
-
/**
|
|
3902
|
+
/**
|
|
3903
|
+
* Optional description of the resource.
|
|
3904
|
+
*
|
|
3905
|
+
* Maximum 1024 characters.
|
|
3906
|
+
*/
|
|
2749
3907
|
description?: string;
|
|
2750
3908
|
labels?: Labels;
|
|
2751
3909
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2758,29 +3916,63 @@ export interface InvoiceBase {
|
|
|
2758
3916
|
number: string;
|
|
2759
3917
|
/** Three-letter ISO 4217 currency code for the invoice. */
|
|
2760
3918
|
currency: string;
|
|
2761
|
-
/**
|
|
3919
|
+
/**
|
|
3920
|
+
* Snapshot of the supplier's contact information at the time the invoice was
|
|
3921
|
+
* issued.
|
|
3922
|
+
*/
|
|
2762
3923
|
supplier: Supplier;
|
|
2763
3924
|
/** Snapshot of the customer's information at the time the invoice was issued. */
|
|
2764
3925
|
customer: InvoiceCustomer;
|
|
2765
3926
|
/** Aggregated financial totals for the invoice. */
|
|
2766
3927
|
totals: Totals;
|
|
2767
|
-
/**
|
|
3928
|
+
/**
|
|
3929
|
+
* The service period covered by this invoice.
|
|
3930
|
+
*
|
|
3931
|
+
* For flat fee the service period can be empty which means `from` will be equals
|
|
3932
|
+
* to `to`. In other cases those fields will be filled with the actual service
|
|
3933
|
+
* period.
|
|
3934
|
+
*/
|
|
2768
3935
|
service_period: ClosedPeriod;
|
|
2769
|
-
/**
|
|
3936
|
+
/**
|
|
3937
|
+
* Validation issues found during invoice processing.
|
|
3938
|
+
*
|
|
3939
|
+
* Present only when there are one or more validation findings. An empty list is
|
|
3940
|
+
* omitted.
|
|
3941
|
+
*/
|
|
2770
3942
|
validation_issues?: InvoiceValidationIssue[];
|
|
2771
3943
|
/** External identifiers assigned to this invoice by third-party systems. */
|
|
2772
3944
|
external_references?: InvoiceExternalReferences;
|
|
2773
3945
|
}
|
|
2774
|
-
/**
|
|
3946
|
+
/**
|
|
3947
|
+
* Request to create a Stripe Checkout Session for the customer.
|
|
3948
|
+
*
|
|
3949
|
+
* Checkout Sessions are used to collect payment method information from customers
|
|
3950
|
+
* in a secure, Stripe-hosted interface. This integration uses setup mode to
|
|
3951
|
+
* collect payment methods that can be charged later for subscription billing.
|
|
3952
|
+
*/
|
|
2775
3953
|
export interface CustomerStripeCreateCheckoutSessionRequest {
|
|
2776
|
-
/**
|
|
3954
|
+
/**
|
|
3955
|
+
* Options for configuring the Stripe Checkout Session.
|
|
3956
|
+
*
|
|
3957
|
+
* These options are passed directly to Stripe's
|
|
3958
|
+
* [checkout session creation API](https://docs.stripe.com/api/checkout/sessions/create).
|
|
3959
|
+
*/
|
|
2777
3960
|
stripe_options: AppStripeCreateCheckoutSessionRequestOptions;
|
|
2778
3961
|
}
|
|
2779
|
-
/**
|
|
3962
|
+
/**
|
|
3963
|
+
* Workflow collection specifies how to collect the pending line items for an
|
|
3964
|
+
* invoice.
|
|
3965
|
+
*/
|
|
2780
3966
|
export interface WorkflowCollectionSettings {
|
|
2781
3967
|
/** The alignment for collecting the pending line items into an invoice. */
|
|
2782
3968
|
alignment: WorkflowCollectionAlignmentSubscription | WorkflowCollectionAlignmentAnchored;
|
|
2783
|
-
/**
|
|
3969
|
+
/**
|
|
3970
|
+
* This grace period can be used to delay the collection of the pending line items
|
|
3971
|
+
* specified in alignment.
|
|
3972
|
+
*
|
|
3973
|
+
* This is useful, in case of multiple subscriptions having slightly different
|
|
3974
|
+
* billing periods.
|
|
3975
|
+
*/
|
|
2784
3976
|
interval: string;
|
|
2785
3977
|
}
|
|
2786
3978
|
/** Page paginated response. */
|
|
@@ -2803,15 +3995,26 @@ export interface GovernanceQueryResponse {
|
|
|
2803
3995
|
data: GovernanceQueryResult[];
|
|
2804
3996
|
/** Partial errors encountered while processing the request. */
|
|
2805
3997
|
errors: GovernanceQueryError[];
|
|
2806
|
-
/**
|
|
3998
|
+
/**
|
|
3999
|
+
* Pagination metadata. The endpoint may return a partial response if the full
|
|
4000
|
+
* response would exceed server-side limits.
|
|
4001
|
+
*/
|
|
2807
4002
|
meta: CursorMeta;
|
|
2808
4003
|
}
|
|
2809
4004
|
/** A flat fee charge for a customer. */
|
|
2810
4005
|
export interface ChargeFlatFee {
|
|
2811
4006
|
id: string;
|
|
2812
|
-
/**
|
|
4007
|
+
/**
|
|
4008
|
+
* Display name of the resource.
|
|
4009
|
+
*
|
|
4010
|
+
* Between 1 and 256 characters.
|
|
4011
|
+
*/
|
|
2813
4012
|
name: string;
|
|
2814
|
-
/**
|
|
4013
|
+
/**
|
|
4014
|
+
* Optional description of the resource.
|
|
4015
|
+
*
|
|
4016
|
+
* Maximum 1024 characters.
|
|
4017
|
+
*/
|
|
2815
4018
|
description?: string;
|
|
2816
4019
|
labels?: Labels;
|
|
2817
4020
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2824,9 +4027,15 @@ export interface ChargeFlatFee {
|
|
|
2824
4027
|
type: 'flat_fee';
|
|
2825
4028
|
/** The customer owning the charge. */
|
|
2826
4029
|
customer: BillingCustomerReference;
|
|
2827
|
-
/**
|
|
4030
|
+
/**
|
|
4031
|
+
* Indicates whether the charge lifecycle is controlled by OpenMeter or manually
|
|
4032
|
+
* overridden by the API user.
|
|
4033
|
+
*/
|
|
2828
4034
|
lifecycle_controller: 'system' | 'manual';
|
|
2829
|
-
/**
|
|
4035
|
+
/**
|
|
4036
|
+
* The subscription that originated the charge, when the charge was created from a
|
|
4037
|
+
* subscription item.
|
|
4038
|
+
*/
|
|
2830
4039
|
subscription?: SubscriptionReference;
|
|
2831
4040
|
/** The currency of the charge. */
|
|
2832
4041
|
currency: string;
|
|
@@ -2840,7 +4049,10 @@ export interface ChargeFlatFee {
|
|
|
2840
4049
|
full_service_period: ClosedPeriod;
|
|
2841
4050
|
/** The billing period the charge belongs to. */
|
|
2842
4051
|
billing_period: ClosedPeriod;
|
|
2843
|
-
/**
|
|
4052
|
+
/**
|
|
4053
|
+
* The earliest time when the charge should be advanced again by background
|
|
4054
|
+
* processing.
|
|
4055
|
+
*/
|
|
2844
4056
|
advance_after?: string;
|
|
2845
4057
|
/** Unique reference ID of the charge. */
|
|
2846
4058
|
unique_reference_id?: string;
|
|
@@ -2866,9 +4078,17 @@ export interface ChargeFlatFee {
|
|
|
2866
4078
|
/** A usage-based charge for a customer. */
|
|
2867
4079
|
export interface ChargeUsageBased {
|
|
2868
4080
|
id: string;
|
|
2869
|
-
/**
|
|
4081
|
+
/**
|
|
4082
|
+
* Display name of the resource.
|
|
4083
|
+
*
|
|
4084
|
+
* Between 1 and 256 characters.
|
|
4085
|
+
*/
|
|
2870
4086
|
name: string;
|
|
2871
|
-
/**
|
|
4087
|
+
/**
|
|
4088
|
+
* Optional description of the resource.
|
|
4089
|
+
*
|
|
4090
|
+
* Maximum 1024 characters.
|
|
4091
|
+
*/
|
|
2872
4092
|
description?: string;
|
|
2873
4093
|
labels?: Labels;
|
|
2874
4094
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -2881,9 +4101,15 @@ export interface ChargeUsageBased {
|
|
|
2881
4101
|
type: 'usage_based';
|
|
2882
4102
|
/** The customer owning the charge. */
|
|
2883
4103
|
customer: BillingCustomerReference;
|
|
2884
|
-
/**
|
|
4104
|
+
/**
|
|
4105
|
+
* Indicates whether the charge lifecycle is controlled by OpenMeter or manually
|
|
4106
|
+
* overridden by the API user.
|
|
4107
|
+
*/
|
|
2885
4108
|
lifecycle_controller: 'system' | 'manual';
|
|
2886
|
-
/**
|
|
4109
|
+
/**
|
|
4110
|
+
* The subscription that originated the charge, when the charge was created from a
|
|
4111
|
+
* subscription item.
|
|
4112
|
+
*/
|
|
2887
4113
|
subscription?: SubscriptionReference;
|
|
2888
4114
|
/** The currency of the charge. */
|
|
2889
4115
|
currency: string;
|
|
@@ -2897,7 +4123,10 @@ export interface ChargeUsageBased {
|
|
|
2897
4123
|
full_service_period: ClosedPeriod;
|
|
2898
4124
|
/** The billing period the charge belongs to. */
|
|
2899
4125
|
billing_period: ClosedPeriod;
|
|
2900
|
-
/**
|
|
4126
|
+
/**
|
|
4127
|
+
* The earliest time when the charge should be advanced again by background
|
|
4128
|
+
* processing.
|
|
4129
|
+
*/
|
|
2901
4130
|
advance_after?: string;
|
|
2902
4131
|
/** Unique reference ID of the charge. */
|
|
2903
4132
|
unique_reference_id?: string;
|
|
@@ -2916,9 +4145,17 @@ export interface ChargeUsageBased {
|
|
|
2916
4145
|
}
|
|
2917
4146
|
/** Usage-based charge create request. */
|
|
2918
4147
|
export interface CreateChargeUsageBasedRequest {
|
|
2919
|
-
/**
|
|
4148
|
+
/**
|
|
4149
|
+
* Display name of the resource.
|
|
4150
|
+
*
|
|
4151
|
+
* Between 1 and 256 characters.
|
|
4152
|
+
*/
|
|
2920
4153
|
name: string;
|
|
2921
|
-
/**
|
|
4154
|
+
/**
|
|
4155
|
+
* Optional description of the resource.
|
|
4156
|
+
*
|
|
4157
|
+
* Maximum 1024 characters.
|
|
4158
|
+
*/
|
|
2922
4159
|
description?: string;
|
|
2923
4160
|
labels?: Labels;
|
|
2924
4161
|
/** The type of the charge. */
|
|
@@ -2959,29 +4196,58 @@ export interface InvoiceLineRateCard {
|
|
|
2959
4196
|
}
|
|
2960
4197
|
/** A rate card defines the pricing and entitlement of a feature or service. */
|
|
2961
4198
|
export interface RateCard {
|
|
2962
|
-
/**
|
|
4199
|
+
/**
|
|
4200
|
+
* Display name of the resource.
|
|
4201
|
+
*
|
|
4202
|
+
* Between 1 and 256 characters.
|
|
4203
|
+
*/
|
|
2963
4204
|
name: string;
|
|
2964
|
-
/**
|
|
4205
|
+
/**
|
|
4206
|
+
* Optional description of the resource.
|
|
4207
|
+
*
|
|
4208
|
+
* Maximum 1024 characters.
|
|
4209
|
+
*/
|
|
2965
4210
|
description?: string;
|
|
2966
4211
|
labels?: Labels;
|
|
2967
4212
|
key: string;
|
|
2968
4213
|
/** The feature associated with the rate card. */
|
|
2969
4214
|
feature?: FeatureReference;
|
|
2970
|
-
/**
|
|
4215
|
+
/**
|
|
4216
|
+
* The billing cadence of the rate card. When null, the charge is one-time
|
|
4217
|
+
* (non-recurring). Only valid for flat prices.
|
|
4218
|
+
*/
|
|
2971
4219
|
billing_cadence?: string;
|
|
2972
4220
|
/** The price of the rate card. */
|
|
2973
4221
|
price: PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVolume;
|
|
2974
|
-
/**
|
|
4222
|
+
/**
|
|
4223
|
+
* Unit conversion configuration for the rate card.
|
|
4224
|
+
*
|
|
4225
|
+
* Synthesized on read for plans authored with v1 dynamic or package prices:
|
|
4226
|
+
* dynamic prices map to a unit price with a multiply unit config, and package
|
|
4227
|
+
* prices map to a unit price with a divide unit config.
|
|
4228
|
+
*
|
|
4229
|
+
* Accepted on create and update only when the UnitConfig feature is enabled on the
|
|
4230
|
+
* deployment; otherwise rejected.
|
|
4231
|
+
*/
|
|
2975
4232
|
unit_config?: UnitConfig;
|
|
2976
|
-
/**
|
|
4233
|
+
/**
|
|
4234
|
+
* The payment term of the rate card. In advance payment term can only be used for
|
|
4235
|
+
* flat prices.
|
|
4236
|
+
*/
|
|
2977
4237
|
payment_term: 'in_advance' | 'in_arrears';
|
|
2978
|
-
/**
|
|
4238
|
+
/**
|
|
4239
|
+
* Spend commitments for this rate card. Only applicable to usage-based prices
|
|
4240
|
+
* (unit, graduated, volume).
|
|
4241
|
+
*/
|
|
2979
4242
|
commitments?: SpendCommitments;
|
|
2980
4243
|
/** The discounts of the rate card. */
|
|
2981
4244
|
discounts?: RateCardDiscounts;
|
|
2982
4245
|
/** The tax config of the rate card. */
|
|
2983
4246
|
tax_config?: RateCardTaxConfig;
|
|
2984
|
-
/**
|
|
4247
|
+
/**
|
|
4248
|
+
* The entitlement template granted to subscribers of a plan or addon containing
|
|
4249
|
+
* this rate card. Requires `feature` to be set.
|
|
4250
|
+
*/
|
|
2985
4251
|
entitlement?: RateCardMeteredEntitlement | RateCardStaticEntitlement | RateCardBooleanEntitlement;
|
|
2986
4252
|
}
|
|
2987
4253
|
/** Page paginated response. */
|
|
@@ -3000,12 +4266,26 @@ export interface Workflow {
|
|
|
3000
4266
|
/** The tax settings for this workflow */
|
|
3001
4267
|
tax?: WorkflowTaxSettings;
|
|
3002
4268
|
}
|
|
3003
|
-
/**
|
|
4269
|
+
/**
|
|
4270
|
+
* A top-level line item on an invoice.
|
|
4271
|
+
*
|
|
4272
|
+
* Each line represents a single charge, typically associated with a rate card from
|
|
4273
|
+
* a subscription. Detailed (child) lines are nested under `detailed_lines` when
|
|
4274
|
+
* present.
|
|
4275
|
+
*/
|
|
3004
4276
|
export interface InvoiceStandardLine {
|
|
3005
4277
|
id: string;
|
|
3006
|
-
/**
|
|
4278
|
+
/**
|
|
4279
|
+
* Display name of the resource.
|
|
4280
|
+
*
|
|
4281
|
+
* Between 1 and 256 characters.
|
|
4282
|
+
*/
|
|
3007
4283
|
name: string;
|
|
3008
|
-
/**
|
|
4284
|
+
/**
|
|
4285
|
+
* Optional description of the resource.
|
|
4286
|
+
*
|
|
4287
|
+
* Maximum 1024 characters.
|
|
4288
|
+
*/
|
|
3009
4289
|
description?: string;
|
|
3010
4290
|
labels?: Labels;
|
|
3011
4291
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3016,9 +4296,18 @@ export interface InvoiceStandardLine {
|
|
|
3016
4296
|
deleted_at?: string;
|
|
3017
4297
|
/** The type of charge this line item represents. */
|
|
3018
4298
|
type: 'standard_line';
|
|
3019
|
-
/**
|
|
4299
|
+
/**
|
|
4300
|
+
* Indicates whether this line item's lifecycle is controlled by OpenMeter or
|
|
4301
|
+
* manually overridden by the API user.
|
|
4302
|
+
*/
|
|
3020
4303
|
lifecycle_controller: 'system' | 'manual';
|
|
3021
|
-
/**
|
|
4304
|
+
/**
|
|
4305
|
+
* The service period covered by this invoice, spanning the earliest line start to
|
|
4306
|
+
* the latest line end across all of its lines.
|
|
4307
|
+
*
|
|
4308
|
+
* For an invoice with no lines the period is empty, which means `from` will be
|
|
4309
|
+
* equal to `to`.
|
|
4310
|
+
*/
|
|
3022
4311
|
service_period: ClosedPeriod;
|
|
3023
4312
|
/** Aggregated financial totals for the line item. */
|
|
3024
4313
|
totals: Totals;
|
|
@@ -3032,30 +4321,59 @@ export interface InvoiceStandardLine {
|
|
|
3032
4321
|
subscription?: SubscriptionReference;
|
|
3033
4322
|
/** The rate card configuration snapshot used to price this line item. */
|
|
3034
4323
|
rate_card: InvoiceLineRateCard;
|
|
3035
|
-
/**
|
|
4324
|
+
/**
|
|
4325
|
+
* Detailed sub-lines that this line has been broken down into.
|
|
4326
|
+
*
|
|
4327
|
+
* Present when line has individual details.
|
|
4328
|
+
*/
|
|
3036
4329
|
detailed_lines: InvoiceDetailedLine[];
|
|
3037
4330
|
/** Reference to the charge associated with this line item. */
|
|
3038
4331
|
charge?: ChargeReference;
|
|
3039
4332
|
}
|
|
3040
|
-
/**
|
|
4333
|
+
/**
|
|
4334
|
+
* The plan phase or pricing ramp allows changing a plan's rate cards over time as
|
|
4335
|
+
* a subscription progresses.
|
|
4336
|
+
*/
|
|
3041
4337
|
export interface PlanPhase {
|
|
3042
|
-
/**
|
|
4338
|
+
/**
|
|
4339
|
+
* Display name of the resource.
|
|
4340
|
+
*
|
|
4341
|
+
* Between 1 and 256 characters.
|
|
4342
|
+
*/
|
|
3043
4343
|
name: string;
|
|
3044
|
-
/**
|
|
4344
|
+
/**
|
|
4345
|
+
* Optional description of the resource.
|
|
4346
|
+
*
|
|
4347
|
+
* Maximum 1024 characters.
|
|
4348
|
+
*/
|
|
3045
4349
|
description?: string;
|
|
3046
4350
|
labels?: Labels;
|
|
3047
4351
|
key: string;
|
|
3048
|
-
/**
|
|
4352
|
+
/**
|
|
4353
|
+
* The duration of the phase. When not specified, the phase runs indefinitely. Only
|
|
4354
|
+
* the last phase may omit the duration.
|
|
4355
|
+
*/
|
|
3049
4356
|
duration?: string;
|
|
3050
4357
|
/** The rate cards of the plan. */
|
|
3051
4358
|
rate_cards: RateCard[];
|
|
3052
4359
|
}
|
|
3053
|
-
/**
|
|
4360
|
+
/**
|
|
4361
|
+
* Add-on allows extending subscriptions with compatible plans with additional
|
|
4362
|
+
* ratecards.
|
|
4363
|
+
*/
|
|
3054
4364
|
export interface Addon {
|
|
3055
4365
|
id: string;
|
|
3056
|
-
/**
|
|
4366
|
+
/**
|
|
4367
|
+
* Display name of the resource.
|
|
4368
|
+
*
|
|
4369
|
+
* Between 1 and 256 characters.
|
|
4370
|
+
*/
|
|
3057
4371
|
name: string;
|
|
3058
|
-
/**
|
|
4372
|
+
/**
|
|
4373
|
+
* Optional description of the resource.
|
|
4374
|
+
*
|
|
4375
|
+
* Maximum 1024 characters.
|
|
4376
|
+
*/
|
|
3059
4377
|
description?: string;
|
|
3060
4378
|
labels?: Labels;
|
|
3061
4379
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3064,7 +4382,11 @@ export interface Addon {
|
|
|
3064
4382
|
updated_at: string;
|
|
3065
4383
|
/** An ISO-8601 timestamp representation of entity deletion date. */
|
|
3066
4384
|
deleted_at?: string;
|
|
3067
|
-
/**
|
|
4385
|
+
/**
|
|
4386
|
+
* A key is a semi-unique string that is used to identify the add-on. It is used to
|
|
4387
|
+
* reference the latest `active` version of the add-on and is unique with the
|
|
4388
|
+
* version number.
|
|
4389
|
+
*/
|
|
3068
4390
|
key: string;
|
|
3069
4391
|
/** Version of the add-on. Incremented when the add-on is updated. */
|
|
3070
4392
|
version: number;
|
|
@@ -3072,11 +4394,24 @@ export interface Addon {
|
|
|
3072
4394
|
instance_type: 'single' | 'multiple';
|
|
3073
4395
|
/** The currency code of the add-on. */
|
|
3074
4396
|
currency: string;
|
|
3075
|
-
/**
|
|
4397
|
+
/**
|
|
4398
|
+
* The date and time when the add-on becomes effective. When not specified, the
|
|
4399
|
+
* add-on is a draft.
|
|
4400
|
+
*/
|
|
3076
4401
|
effective_from?: string;
|
|
3077
|
-
/**
|
|
4402
|
+
/**
|
|
4403
|
+
* The date and time when the add-on is no longer effective. When not specified,
|
|
4404
|
+
* the add-on is effective indefinitely.
|
|
4405
|
+
*/
|
|
3078
4406
|
effective_to?: string;
|
|
3079
|
-
/**
|
|
4407
|
+
/**
|
|
4408
|
+
* The status of the add-on. Computed based on the effective start and end dates:
|
|
4409
|
+
*
|
|
4410
|
+
* - `draft`: `effective_from` is not set.
|
|
4411
|
+
* - `active`: `effective_from <= now` and (`effective_to` is not set or
|
|
4412
|
+
* `now < effective_to`).
|
|
4413
|
+
* - `archived`: `effective_to <= now`.
|
|
4414
|
+
*/
|
|
3080
4415
|
status: 'draft' | 'active' | 'archived';
|
|
3081
4416
|
/** The rate cards of the add-on. */
|
|
3082
4417
|
rate_cards: RateCard[];
|
|
@@ -3085,12 +4420,24 @@ export interface Addon {
|
|
|
3085
4420
|
}
|
|
3086
4421
|
/** Addon create request. */
|
|
3087
4422
|
export interface CreateAddonRequest {
|
|
3088
|
-
/**
|
|
4423
|
+
/**
|
|
4424
|
+
* Display name of the resource.
|
|
4425
|
+
*
|
|
4426
|
+
* Between 1 and 256 characters.
|
|
4427
|
+
*/
|
|
3089
4428
|
name: string;
|
|
3090
|
-
/**
|
|
4429
|
+
/**
|
|
4430
|
+
* Optional description of the resource.
|
|
4431
|
+
*
|
|
4432
|
+
* Maximum 1024 characters.
|
|
4433
|
+
*/
|
|
3091
4434
|
description?: string;
|
|
3092
4435
|
labels?: Labels;
|
|
3093
|
-
/**
|
|
4436
|
+
/**
|
|
4437
|
+
* A key is a semi-unique string that is used to identify the add-on. It is used to
|
|
4438
|
+
* reference the latest `active` version of the add-on and is unique with the
|
|
4439
|
+
* version number.
|
|
4440
|
+
*/
|
|
3094
4441
|
key: string;
|
|
3095
4442
|
/** The InstanceType of the add-ons. Can be "single" or "multiple". */
|
|
3096
4443
|
instance_type: 'single' | 'multiple';
|
|
@@ -3101,9 +4448,17 @@ export interface CreateAddonRequest {
|
|
|
3101
4448
|
}
|
|
3102
4449
|
/** Addon upsert request. */
|
|
3103
4450
|
export interface UpsertAddonRequest {
|
|
3104
|
-
/**
|
|
4451
|
+
/**
|
|
4452
|
+
* Display name of the resource.
|
|
4453
|
+
*
|
|
4454
|
+
* Between 1 and 256 characters.
|
|
4455
|
+
*/
|
|
3105
4456
|
name: string;
|
|
3106
|
-
/**
|
|
4457
|
+
/**
|
|
4458
|
+
* Optional description of the resource.
|
|
4459
|
+
*
|
|
4460
|
+
* Maximum 1024 characters.
|
|
4461
|
+
*/
|
|
3107
4462
|
description?: string;
|
|
3108
4463
|
labels?: Labels;
|
|
3109
4464
|
/** The InstanceType of the add-ons. Can be "single" or "multiple". */
|
|
@@ -3111,12 +4466,23 @@ export interface UpsertAddonRequest {
|
|
|
3111
4466
|
/** The rate cards of the add-on. */
|
|
3112
4467
|
rate_cards: RateCard[];
|
|
3113
4468
|
}
|
|
3114
|
-
/**
|
|
4469
|
+
/**
|
|
4470
|
+
* Billing profiles contain the settings for billing and controls invoice
|
|
4471
|
+
* generation.
|
|
4472
|
+
*/
|
|
3115
4473
|
export interface Profile {
|
|
3116
4474
|
id: string;
|
|
3117
|
-
/**
|
|
4475
|
+
/**
|
|
4476
|
+
* Display name of the resource.
|
|
4477
|
+
*
|
|
4478
|
+
* Between 1 and 256 characters.
|
|
4479
|
+
*/
|
|
3118
4480
|
name: string;
|
|
3119
|
-
/**
|
|
4481
|
+
/**
|
|
4482
|
+
* Optional description of the resource.
|
|
4483
|
+
*
|
|
4484
|
+
* Maximum 1024 characters.
|
|
4485
|
+
*/
|
|
3120
4486
|
description?: string;
|
|
3121
4487
|
labels?: Labels;
|
|
3122
4488
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3125,7 +4491,10 @@ export interface Profile {
|
|
|
3125
4491
|
updated_at: string;
|
|
3126
4492
|
/** An ISO-8601 timestamp representation of entity deletion date. */
|
|
3127
4493
|
deleted_at?: string;
|
|
3128
|
-
/**
|
|
4494
|
+
/**
|
|
4495
|
+
* The name and contact information for the supplier this billing profile
|
|
4496
|
+
* represents
|
|
4497
|
+
*/
|
|
3129
4498
|
supplier: Party;
|
|
3130
4499
|
/** The billing workflow settings for this profile */
|
|
3131
4500
|
workflow: Workflow;
|
|
@@ -3136,12 +4505,23 @@ export interface Profile {
|
|
|
3136
4505
|
}
|
|
3137
4506
|
/** BillingProfile create request. */
|
|
3138
4507
|
export interface CreateBillingProfileRequest {
|
|
3139
|
-
/**
|
|
4508
|
+
/**
|
|
4509
|
+
* Display name of the resource.
|
|
4510
|
+
*
|
|
4511
|
+
* Between 1 and 256 characters.
|
|
4512
|
+
*/
|
|
3140
4513
|
name: string;
|
|
3141
|
-
/**
|
|
4514
|
+
/**
|
|
4515
|
+
* Optional description of the resource.
|
|
4516
|
+
*
|
|
4517
|
+
* Maximum 1024 characters.
|
|
4518
|
+
*/
|
|
3142
4519
|
description?: string;
|
|
3143
4520
|
labels?: Labels;
|
|
3144
|
-
/**
|
|
4521
|
+
/**
|
|
4522
|
+
* The name and contact information for the supplier this billing profile
|
|
4523
|
+
* represents
|
|
4524
|
+
*/
|
|
3145
4525
|
supplier: Party;
|
|
3146
4526
|
/** The billing workflow settings for this profile */
|
|
3147
4527
|
workflow: Workflow;
|
|
@@ -3152,12 +4532,23 @@ export interface CreateBillingProfileRequest {
|
|
|
3152
4532
|
}
|
|
3153
4533
|
/** BillingProfile upsert request. */
|
|
3154
4534
|
export interface UpsertBillingProfileRequest {
|
|
3155
|
-
/**
|
|
4535
|
+
/**
|
|
4536
|
+
* Display name of the resource.
|
|
4537
|
+
*
|
|
4538
|
+
* Between 1 and 256 characters.
|
|
4539
|
+
*/
|
|
3156
4540
|
name: string;
|
|
3157
|
-
/**
|
|
4541
|
+
/**
|
|
4542
|
+
* Optional description of the resource.
|
|
4543
|
+
*
|
|
4544
|
+
* Maximum 1024 characters.
|
|
4545
|
+
*/
|
|
3158
4546
|
description?: string;
|
|
3159
4547
|
labels?: Labels;
|
|
3160
|
-
/**
|
|
4548
|
+
/**
|
|
4549
|
+
* The name and contact information for the supplier this billing profile
|
|
4550
|
+
* represents
|
|
4551
|
+
*/
|
|
3161
4552
|
supplier: Party;
|
|
3162
4553
|
/** The billing workflow settings for this profile */
|
|
3163
4554
|
workflow: Workflow;
|
|
@@ -3172,9 +4563,17 @@ export interface ChargePagePaginatedResponse {
|
|
|
3172
4563
|
/** Plans provide a template for subscriptions. */
|
|
3173
4564
|
export interface Plan {
|
|
3174
4565
|
id: string;
|
|
3175
|
-
/**
|
|
4566
|
+
/**
|
|
4567
|
+
* Display name of the resource.
|
|
4568
|
+
*
|
|
4569
|
+
* Between 1 and 256 characters.
|
|
4570
|
+
*/
|
|
3176
4571
|
name: string;
|
|
3177
|
-
/**
|
|
4572
|
+
/**
|
|
4573
|
+
* Optional description of the resource.
|
|
4574
|
+
*
|
|
4575
|
+
* Maximum 1024 characters.
|
|
4576
|
+
*/
|
|
3178
4577
|
description?: string;
|
|
3179
4578
|
labels?: Labels;
|
|
3180
4579
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3183,9 +4582,16 @@ export interface Plan {
|
|
|
3183
4582
|
updated_at: string;
|
|
3184
4583
|
/** An ISO-8601 timestamp representation of entity deletion date. */
|
|
3185
4584
|
deleted_at?: string;
|
|
3186
|
-
/**
|
|
4585
|
+
/**
|
|
4586
|
+
* A key is a semi-unique string that is used to identify the plan. It is used to
|
|
4587
|
+
* reference the latest `active` version of the plan and is unique with the version
|
|
4588
|
+
* number.
|
|
4589
|
+
*/
|
|
3187
4590
|
key: string;
|
|
3188
|
-
/**
|
|
4591
|
+
/**
|
|
4592
|
+
* Plans are versioned to allow you to make changes without affecting running
|
|
4593
|
+
* subscriptions.
|
|
4594
|
+
*/
|
|
3189
4595
|
version: number;
|
|
3190
4596
|
/** The currency code of the plan. */
|
|
3191
4597
|
currency: string;
|
|
@@ -3193,27 +4599,67 @@ export interface Plan {
|
|
|
3193
4599
|
billing_cadence: string;
|
|
3194
4600
|
/** Whether pro-rating is enabled for this plan. */
|
|
3195
4601
|
pro_rating_enabled: boolean;
|
|
3196
|
-
/**
|
|
4602
|
+
/**
|
|
4603
|
+
* The date and time when the plan becomes `active`. When not specified, the plan
|
|
4604
|
+
* is in `draft` status.
|
|
4605
|
+
*/
|
|
3197
4606
|
effective_from?: string;
|
|
3198
|
-
/**
|
|
4607
|
+
/**
|
|
4608
|
+
* A scheduled date and time when the plan becomes `archived`. When not specified,
|
|
4609
|
+
* the plan is in `active` status indefinitely.
|
|
4610
|
+
*/
|
|
3199
4611
|
effective_to?: string;
|
|
3200
|
-
/**
|
|
4612
|
+
/**
|
|
4613
|
+
* The status of the plan. Computed based on the effective start and end dates:
|
|
4614
|
+
*
|
|
4615
|
+
* - `draft`: `effective_from` is not set.
|
|
4616
|
+
* - `scheduled`: `now < effective_from`.
|
|
4617
|
+
* - `active`: `effective_from <= now` and (`effective_to` is not set or
|
|
4618
|
+
* `now < effective_to`).
|
|
4619
|
+
* - `archived`: `effective_to <= now`.
|
|
4620
|
+
*/
|
|
3201
4621
|
status: 'draft' | 'active' | 'archived' | 'scheduled';
|
|
3202
|
-
/**
|
|
4622
|
+
/**
|
|
4623
|
+
* The plan phases define the pricing ramp for a subscription. A phase switch
|
|
4624
|
+
* occurs only at the end of a billing period. At least one phase is required.
|
|
4625
|
+
*/
|
|
3203
4626
|
phases: PlanPhase[];
|
|
3204
|
-
/**
|
|
4627
|
+
/**
|
|
4628
|
+
* Settlement mode for plan.
|
|
4629
|
+
*
|
|
4630
|
+
* Values:
|
|
4631
|
+
*
|
|
4632
|
+
* - `credit_then_invoice`: Credits are applied first, then any remainder is
|
|
4633
|
+
* invoiced.
|
|
4634
|
+
* - `credit_only`: Usage is settled exclusively against credits.
|
|
4635
|
+
*/
|
|
3205
4636
|
settlement_mode: 'credit_then_invoice' | 'credit_only';
|
|
3206
|
-
/**
|
|
4637
|
+
/**
|
|
4638
|
+
* List of validation errors in `draft` state that prevent the plan from being
|
|
4639
|
+
* published.
|
|
4640
|
+
*/
|
|
3207
4641
|
validation_errors?: ProductCatalogValidationError[];
|
|
3208
4642
|
}
|
|
3209
4643
|
/** Plan create request. */
|
|
3210
4644
|
export interface CreatePlanRequest {
|
|
3211
|
-
/**
|
|
4645
|
+
/**
|
|
4646
|
+
* Display name of the resource.
|
|
4647
|
+
*
|
|
4648
|
+
* Between 1 and 256 characters.
|
|
4649
|
+
*/
|
|
3212
4650
|
name: string;
|
|
3213
|
-
/**
|
|
4651
|
+
/**
|
|
4652
|
+
* Optional description of the resource.
|
|
4653
|
+
*
|
|
4654
|
+
* Maximum 1024 characters.
|
|
4655
|
+
*/
|
|
3214
4656
|
description?: string;
|
|
3215
4657
|
labels?: Labels;
|
|
3216
|
-
/**
|
|
4658
|
+
/**
|
|
4659
|
+
* A key is a semi-unique string that is used to identify the plan. It is used to
|
|
4660
|
+
* reference the latest `active` version of the plan and is unique with the version
|
|
4661
|
+
* number.
|
|
4662
|
+
*/
|
|
3217
4663
|
key: string;
|
|
3218
4664
|
/** The currency code of the plan. */
|
|
3219
4665
|
currency: string;
|
|
@@ -3221,19 +4667,33 @@ export interface CreatePlanRequest {
|
|
|
3221
4667
|
billing_cadence: string;
|
|
3222
4668
|
/** Whether pro-rating is enabled for this plan. */
|
|
3223
4669
|
pro_rating_enabled: boolean;
|
|
3224
|
-
/**
|
|
4670
|
+
/**
|
|
4671
|
+
* The plan phases define the pricing ramp for a subscription. A phase switch
|
|
4672
|
+
* occurs only at the end of a billing period. At least one phase is required.
|
|
4673
|
+
*/
|
|
3225
4674
|
phases: PlanPhase[];
|
|
3226
4675
|
}
|
|
3227
4676
|
/** Plan upsert request. */
|
|
3228
4677
|
export interface UpsertPlanRequest {
|
|
3229
|
-
/**
|
|
4678
|
+
/**
|
|
4679
|
+
* Display name of the resource.
|
|
4680
|
+
*
|
|
4681
|
+
* Between 1 and 256 characters.
|
|
4682
|
+
*/
|
|
3230
4683
|
name: string;
|
|
3231
|
-
/**
|
|
4684
|
+
/**
|
|
4685
|
+
* Optional description of the resource.
|
|
4686
|
+
*
|
|
4687
|
+
* Maximum 1024 characters.
|
|
4688
|
+
*/
|
|
3232
4689
|
description?: string;
|
|
3233
4690
|
labels?: Labels;
|
|
3234
4691
|
/** Whether pro-rating is enabled for this plan. */
|
|
3235
4692
|
pro_rating_enabled: boolean;
|
|
3236
|
-
/**
|
|
4693
|
+
/**
|
|
4694
|
+
* The plan phases define the pricing ramp for a subscription. A phase switch
|
|
4695
|
+
* occurs only at the end of a billing period. At least one phase is required.
|
|
4696
|
+
*/
|
|
3237
4697
|
phases: PlanPhase[];
|
|
3238
4698
|
}
|
|
3239
4699
|
/** Page paginated response. */
|
|
@@ -3249,7 +4709,11 @@ export interface ProfilePagePaginatedResponse {
|
|
|
3249
4709
|
/** A standard invoice for charges owed by the customer. */
|
|
3250
4710
|
export interface InvoiceStandard {
|
|
3251
4711
|
id: string;
|
|
3252
|
-
/**
|
|
4712
|
+
/**
|
|
4713
|
+
* Optional description of the resource.
|
|
4714
|
+
*
|
|
4715
|
+
* Maximum 1024 characters.
|
|
4716
|
+
*/
|
|
3253
4717
|
description?: string;
|
|
3254
4718
|
labels?: Labels;
|
|
3255
4719
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3262,15 +4726,29 @@ export interface InvoiceStandard {
|
|
|
3262
4726
|
number: string;
|
|
3263
4727
|
/** Three-letter ISO 4217 currency code for the invoice. */
|
|
3264
4728
|
currency: string;
|
|
3265
|
-
/**
|
|
4729
|
+
/**
|
|
4730
|
+
* Snapshot of the supplier's contact information at the time the invoice was
|
|
4731
|
+
* issued.
|
|
4732
|
+
*/
|
|
3266
4733
|
supplier: Supplier;
|
|
3267
4734
|
/** Snapshot of the customer's information at the time the invoice was issued. */
|
|
3268
4735
|
customer: InvoiceCustomer;
|
|
3269
4736
|
/** Aggregated financial totals for the invoice. */
|
|
3270
4737
|
totals: Totals;
|
|
3271
|
-
/**
|
|
4738
|
+
/**
|
|
4739
|
+
* The service period covered by this invoice.
|
|
4740
|
+
*
|
|
4741
|
+
* For flat fee the service period can be empty which means `from` will be equals
|
|
4742
|
+
* to `to`. In other cases those fields will be filled with the actual service
|
|
4743
|
+
* period.
|
|
4744
|
+
*/
|
|
3272
4745
|
service_period: ClosedPeriod;
|
|
3273
|
-
/**
|
|
4746
|
+
/**
|
|
4747
|
+
* Validation issues found during invoice processing.
|
|
4748
|
+
*
|
|
4749
|
+
* Present only when there are one or more validation findings. An empty list is
|
|
4750
|
+
* omitted.
|
|
4751
|
+
*/
|
|
3274
4752
|
validation_issues?: InvoiceValidationIssue[];
|
|
3275
4753
|
/** External identifiers assigned to this invoice by third-party systems. */
|
|
3276
4754
|
external_references?: InvoiceExternalReferences;
|
|
@@ -3282,7 +4760,11 @@ export interface InvoiceStandard {
|
|
|
3282
4760
|
status_details: InvoiceStatusDetails;
|
|
3283
4761
|
/** Timestamp when the invoice was issued to the customer. */
|
|
3284
4762
|
issued_at?: string;
|
|
3285
|
-
/**
|
|
4763
|
+
/**
|
|
4764
|
+
* Timestamp until which the invoice remains in draft state.
|
|
4765
|
+
*
|
|
4766
|
+
* The invoice advances automatically once this time is reached.
|
|
4767
|
+
*/
|
|
3286
4768
|
draft_until?: string;
|
|
3287
4769
|
/** Timestamp when usage quantities were last snapshotted for this invoice. */
|
|
3288
4770
|
quantity_snapshotted_at?: string;
|
|
@@ -3294,7 +4776,12 @@ export interface InvoiceStandard {
|
|
|
3294
4776
|
sent_to_customer_at?: string;
|
|
3295
4777
|
/** Workflow configuration snapshot captured at invoice creation time. */
|
|
3296
4778
|
workflow: InvoiceWorkflowSettings;
|
|
3297
|
-
/**
|
|
4779
|
+
/**
|
|
4780
|
+
* Line items on this invoice.
|
|
4781
|
+
*
|
|
4782
|
+
* Always returned on single-resource GET; omitted on list endpoints unless
|
|
4783
|
+
* explicitly expanded.
|
|
4784
|
+
*/
|
|
3298
4785
|
lines?: InvoiceStandardLine[];
|
|
3299
4786
|
}
|
|
3300
4787
|
/** Page paginated response. */
|
|
@@ -3311,7 +4798,10 @@ export interface SortQueryInput {
|
|
|
3311
4798
|
export interface BaseErrorInput {
|
|
3312
4799
|
/** Type contains a URI that identifies the problem type. */
|
|
3313
4800
|
type?: string;
|
|
3314
|
-
/**
|
|
4801
|
+
/**
|
|
4802
|
+
* The HTTP status code generated by the origin server for this occurrence of the
|
|
4803
|
+
* problem.
|
|
4804
|
+
*/
|
|
3315
4805
|
status: number;
|
|
3316
4806
|
/** A a short, human-readable summary of the problem type. */
|
|
3317
4807
|
title: string;
|
|
@@ -3324,7 +4814,10 @@ export interface BaseErrorInput {
|
|
|
3324
4814
|
export interface WorkflowPaymentSendInvoiceSettingsInput {
|
|
3325
4815
|
/** The collection method for the invoice. */
|
|
3326
4816
|
collection_method: 'send_invoice';
|
|
3327
|
-
/**
|
|
4817
|
+
/**
|
|
4818
|
+
* The period after which the invoice is due. With some payment solutions it's only
|
|
4819
|
+
* applicable for manual collection method.
|
|
4820
|
+
*/
|
|
3328
4821
|
due_after?: string;
|
|
3329
4822
|
}
|
|
3330
4823
|
export interface InvoiceWorkflowInvoicingSettingsInput {
|
|
@@ -3340,13 +4833,22 @@ export interface EventInput {
|
|
|
3340
4833
|
source: string;
|
|
3341
4834
|
/** The version of the CloudEvents specification which the event uses. */
|
|
3342
4835
|
specversion?: string;
|
|
3343
|
-
/**
|
|
4836
|
+
/**
|
|
4837
|
+
* Contains a value describing the type of event related to the originating
|
|
4838
|
+
* occurrence.
|
|
4839
|
+
*/
|
|
3344
4840
|
type: string;
|
|
3345
|
-
/**
|
|
4841
|
+
/**
|
|
4842
|
+
* Content type of the CloudEvents data value. Only the value "application/json" is
|
|
4843
|
+
* allowed over HTTP.
|
|
4844
|
+
*/
|
|
3346
4845
|
datacontenttype?: 'application/json' | null;
|
|
3347
4846
|
/** Identifies the schema that data adheres to. */
|
|
3348
4847
|
dataschema?: string | null;
|
|
3349
|
-
/**
|
|
4848
|
+
/**
|
|
4849
|
+
* Describes the subject of the event in the context of the event producer
|
|
4850
|
+
* (identified by source).
|
|
4851
|
+
*/
|
|
3350
4852
|
subject: string;
|
|
3351
4853
|
/** Timestamp of when the occurrence happened. Must adhere to RFC 3339. */
|
|
3352
4854
|
time?: string | null;
|
|
@@ -3378,45 +4880,100 @@ export interface NotImplementedInput extends BaseErrorInput {
|
|
|
3378
4880
|
export interface NotAvailableInput extends BaseErrorInput {
|
|
3379
4881
|
}
|
|
3380
4882
|
export interface AppStripeCreateCheckoutSessionCustomerUpdateInput {
|
|
3381
|
-
/**
|
|
4883
|
+
/**
|
|
4884
|
+
* Whether to save the billing address to customer.address.
|
|
4885
|
+
*
|
|
4886
|
+
* Defaults to "never".
|
|
4887
|
+
*/
|
|
3382
4888
|
address?: 'auto' | 'never';
|
|
3383
|
-
/**
|
|
4889
|
+
/**
|
|
4890
|
+
* Whether to save the customer name to customer.name.
|
|
4891
|
+
*
|
|
4892
|
+
* Defaults to "never".
|
|
4893
|
+
*/
|
|
3384
4894
|
name?: 'auto' | 'never';
|
|
3385
|
-
/**
|
|
4895
|
+
/**
|
|
4896
|
+
* Whether to save shipping information to customer.shipping.
|
|
4897
|
+
*
|
|
4898
|
+
* Defaults to "never".
|
|
4899
|
+
*/
|
|
3386
4900
|
shipping?: 'auto' | 'never';
|
|
3387
4901
|
}
|
|
3388
4902
|
export interface AppStripeCreateCheckoutSessionTaxIdCollectionInput {
|
|
3389
|
-
/**
|
|
4903
|
+
/**
|
|
4904
|
+
* Enable tax ID collection during checkout.
|
|
4905
|
+
*
|
|
4906
|
+
* Defaults to false.
|
|
4907
|
+
*/
|
|
3390
4908
|
enabled?: boolean;
|
|
3391
|
-
/**
|
|
4909
|
+
/**
|
|
4910
|
+
* Whether tax ID collection is required.
|
|
4911
|
+
*
|
|
4912
|
+
* Defaults to "never".
|
|
4913
|
+
*/
|
|
3392
4914
|
required?: 'if_supported' | 'never';
|
|
3393
4915
|
}
|
|
3394
4916
|
export interface CreateCreditGrantPurchaseInput {
|
|
3395
4917
|
/** Currency of the purchase amount. */
|
|
3396
4918
|
currency: string;
|
|
3397
|
-
/**
|
|
4919
|
+
/**
|
|
4920
|
+
* Cost basis per credit unit used to calculate the purchase amount.
|
|
4921
|
+
*
|
|
4922
|
+
* If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
|
|
4923
|
+
* is $50.00. The value must be greater than 0. If the cost basis is 0, use
|
|
4924
|
+
* `funding_method=none` instead.
|
|
4925
|
+
*
|
|
4926
|
+
* Defaults to 1.0.
|
|
4927
|
+
*/
|
|
3398
4928
|
per_unit_cost_basis?: string;
|
|
3399
|
-
/**
|
|
4929
|
+
/**
|
|
4930
|
+
* Controls when credits become available for consumption.
|
|
4931
|
+
*
|
|
4932
|
+
* Defaults to `on_creation`.
|
|
4933
|
+
*/
|
|
3400
4934
|
availability_policy?: 'on_creation';
|
|
3401
4935
|
}
|
|
3402
4936
|
export interface RateCardMeteredEntitlementInput {
|
|
3403
4937
|
/** The type of the entitlement template. */
|
|
3404
4938
|
type: 'metered';
|
|
3405
|
-
/**
|
|
4939
|
+
/**
|
|
4940
|
+
* If soft limit is true, the subject can use the feature even if the entitlement
|
|
4941
|
+
* is exhausted; access remains granted.
|
|
4942
|
+
*/
|
|
3406
4943
|
is_soft_limit?: boolean;
|
|
3407
|
-
/**
|
|
4944
|
+
/**
|
|
4945
|
+
* The amount of usage granted each usage period, in the feature's unit. Usage is
|
|
4946
|
+
* counted against this allowance and the balance resets every usage period. When
|
|
4947
|
+
* `is_soft_limit` is true the subject keeps access after the limit is reached;
|
|
4948
|
+
* otherwise access is denied once the allowance is exhausted.
|
|
4949
|
+
*/
|
|
3408
4950
|
limit?: number;
|
|
3409
|
-
/**
|
|
4951
|
+
/**
|
|
4952
|
+
* The reset interval of the metered entitlement in ISO8601 format. Defaults to the
|
|
4953
|
+
* billing cadence of the rate card.
|
|
4954
|
+
*/
|
|
3410
4955
|
usage_period?: string;
|
|
3411
4956
|
}
|
|
3412
4957
|
export interface CreditGrantPurchaseInput {
|
|
3413
4958
|
/** Currency of the purchase amount. */
|
|
3414
4959
|
currency: string;
|
|
3415
|
-
/**
|
|
4960
|
+
/**
|
|
4961
|
+
* Cost basis per credit unit used to calculate the purchase amount.
|
|
4962
|
+
*
|
|
4963
|
+
* If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
|
|
4964
|
+
* is $50.00. The value must be greater than 0. If the cost basis is 0, use
|
|
4965
|
+
* `funding_method=none` instead.
|
|
4966
|
+
*
|
|
4967
|
+
* Defaults to 1.0.
|
|
4968
|
+
*/
|
|
3416
4969
|
per_unit_cost_basis?: string;
|
|
3417
4970
|
/** The purchase amount. Calculated from `per_unit_cost_basis` and credit `amount`. */
|
|
3418
4971
|
amount: string;
|
|
3419
|
-
/**
|
|
4972
|
+
/**
|
|
4973
|
+
* Controls when credits become available for consumption.
|
|
4974
|
+
*
|
|
4975
|
+
* Defaults to `on_creation`.
|
|
4976
|
+
*/
|
|
3420
4977
|
availability_policy?: 'on_creation';
|
|
3421
4978
|
/** Current payment settlement status. */
|
|
3422
4979
|
settlement_status?: 'pending' | 'authorized' | 'settled';
|
|
@@ -3434,17 +4991,44 @@ export interface WorkflowInvoicingSettingsInput {
|
|
|
3434
4991
|
export interface UnitConfigInput {
|
|
3435
4992
|
/** The arithmetic operation to apply to the raw metered quantity. */
|
|
3436
4993
|
operation: 'divide' | 'multiply';
|
|
3437
|
-
/**
|
|
4994
|
+
/**
|
|
4995
|
+
* The factor used in the conversion operation.
|
|
4996
|
+
*
|
|
4997
|
+
* - For `divide`: `converted = raw / conversionFactor`.
|
|
4998
|
+
* - For `multiply`: `converted = raw × conversionFactor`.
|
|
4999
|
+
*
|
|
5000
|
+
* Must be a positive non-zero value.
|
|
5001
|
+
*/
|
|
3438
5002
|
conversion_factor: string;
|
|
3439
|
-
/**
|
|
5003
|
+
/**
|
|
5004
|
+
* The rounding mode applied to the converted quantity for invoicing.
|
|
5005
|
+
*
|
|
5006
|
+
* Defaults to none (no rounding). Entitlement checks always use the precise
|
|
5007
|
+
* (unrounded) value.
|
|
5008
|
+
*/
|
|
3440
5009
|
rounding?: 'ceiling' | 'floor' | 'half_up' | 'none';
|
|
3441
|
-
/**
|
|
5010
|
+
/**
|
|
5011
|
+
* The number of decimal places to retain after rounding.
|
|
5012
|
+
*
|
|
5013
|
+
* Only meaningful when rounding is not "none". Defaults to 0 (round to whole
|
|
5014
|
+
* numbers).
|
|
5015
|
+
*/
|
|
3442
5016
|
precision?: number;
|
|
3443
|
-
/**
|
|
5017
|
+
/**
|
|
5018
|
+
* A human-readable label for the converted unit shown on invoices and in the
|
|
5019
|
+
* customer portal (e.g., "GB", "hours", "M tokens").
|
|
5020
|
+
*
|
|
5021
|
+
* Optional. When omitted, no unit label is rendered.
|
|
5022
|
+
*/
|
|
3444
5023
|
display_unit?: string;
|
|
3445
5024
|
}
|
|
3446
5025
|
export interface GovernanceQueryRequestInput {
|
|
3447
|
-
/**
|
|
5026
|
+
/**
|
|
5027
|
+
* Whether to include credit balance availability for each resolved customer. When
|
|
5028
|
+
* true, each feature evaluation includes credit balance checks.
|
|
5029
|
+
*
|
|
5030
|
+
* Defaults to `false`.
|
|
5031
|
+
*/
|
|
3448
5032
|
include_credits?: boolean;
|
|
3449
5033
|
customer: GovernanceQueryRequestCustomers;
|
|
3450
5034
|
feature?: GovernanceQueryRequestFeatures;
|
|
@@ -3474,19 +5058,33 @@ export interface InvoiceWorkflowInput {
|
|
|
3474
5058
|
export interface InvoiceUsageQuantityDetailInput {
|
|
3475
5059
|
/** The raw quantity as reported by the meter (native units). */
|
|
3476
5060
|
raw_quantity: string;
|
|
3477
|
-
/**
|
|
5061
|
+
/**
|
|
5062
|
+
* The precise decimal value after applying the conversion operation and factor,
|
|
5063
|
+
* before rounding.
|
|
5064
|
+
*/
|
|
3478
5065
|
converted_quantity: string;
|
|
3479
5066
|
/** The quantity after rounding, used for pricing. */
|
|
3480
5067
|
invoiced_quantity: string;
|
|
3481
5068
|
/** The display unit label (e.g., "GB", "hours", "M tokens"). */
|
|
3482
5069
|
display_unit?: string;
|
|
3483
|
-
/**
|
|
5070
|
+
/**
|
|
5071
|
+
* Snapshot of the UnitConfig that was in effect at billing time. Ensures
|
|
5072
|
+
* historical invoices reflect the config that was actually applied.
|
|
5073
|
+
*/
|
|
3484
5074
|
applied_unit_config: UnitConfigInput;
|
|
3485
5075
|
}
|
|
3486
5076
|
export interface CreateCreditGrantRequestInput {
|
|
3487
|
-
/**
|
|
5077
|
+
/**
|
|
5078
|
+
* Display name of the resource.
|
|
5079
|
+
*
|
|
5080
|
+
* Between 1 and 256 characters.
|
|
5081
|
+
*/
|
|
3488
5082
|
name: string;
|
|
3489
|
-
/**
|
|
5083
|
+
/**
|
|
5084
|
+
* Optional description of the resource.
|
|
5085
|
+
*
|
|
5086
|
+
* Maximum 1024 characters.
|
|
5087
|
+
*/
|
|
3490
5088
|
description?: string;
|
|
3491
5089
|
labels?: CreateLabels;
|
|
3492
5090
|
/** Funding method of the grant. */
|
|
@@ -3497,19 +5095,38 @@ export interface CreateCreditGrantRequestInput {
|
|
|
3497
5095
|
amount: string;
|
|
3498
5096
|
/** Present when a funding workflow applies (funding_method is not `none`). */
|
|
3499
5097
|
purchase?: CreateCreditGrantPurchaseInput;
|
|
3500
|
-
/**
|
|
5098
|
+
/**
|
|
5099
|
+
* Tax configuration for the grant.
|
|
5100
|
+
*
|
|
5101
|
+
* For `invoice` and `external` funding methods, tax configuration should be
|
|
5102
|
+
* provided to ensure correct revenue recognition. When not provided, the default
|
|
5103
|
+
* credit grant tax code is applied, if that's not set the global default taxcode
|
|
5104
|
+
* is used.
|
|
5105
|
+
*/
|
|
3501
5106
|
tax_config?: CreateCreditGrantTaxConfig;
|
|
3502
5107
|
filters?: CreateCreditGrantFilters;
|
|
3503
5108
|
/** Draw-down priority of the grant. Lower values have higher priority. */
|
|
3504
5109
|
priority?: number;
|
|
3505
|
-
/**
|
|
5110
|
+
/**
|
|
5111
|
+
* The duration after which the credit grant expires.
|
|
5112
|
+
*
|
|
5113
|
+
* Defaults to never expiring.
|
|
5114
|
+
*/
|
|
3506
5115
|
expires_after?: string;
|
|
3507
5116
|
}
|
|
3508
5117
|
export interface CreditGrantInput {
|
|
3509
5118
|
id: string;
|
|
3510
|
-
/**
|
|
5119
|
+
/**
|
|
5120
|
+
* Display name of the resource.
|
|
5121
|
+
*
|
|
5122
|
+
* Between 1 and 256 characters.
|
|
5123
|
+
*/
|
|
3511
5124
|
name: string;
|
|
3512
|
-
/**
|
|
5125
|
+
/**
|
|
5126
|
+
* Optional description of the resource.
|
|
5127
|
+
*
|
|
5128
|
+
* Maximum 1024 characters.
|
|
5129
|
+
*/
|
|
3513
5130
|
description?: string;
|
|
3514
5131
|
labels?: Labels;
|
|
3515
5132
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3526,16 +5143,31 @@ export interface CreditGrantInput {
|
|
|
3526
5143
|
amount: string;
|
|
3527
5144
|
/** Present when a funding workflow applies (funding_method is not `none`). */
|
|
3528
5145
|
purchase?: CreditGrantPurchaseInput;
|
|
3529
|
-
/**
|
|
5146
|
+
/**
|
|
5147
|
+
* Tax configuration for the grant.
|
|
5148
|
+
*
|
|
5149
|
+
* For `invoice` and `external` funding methods, tax configuration should be
|
|
5150
|
+
* provided to ensure correct revenue recognition. When not provided, the default
|
|
5151
|
+
* credit grant tax code is applied, if that's not set the global default taxcode
|
|
5152
|
+
* is used.
|
|
5153
|
+
*/
|
|
3530
5154
|
tax_config?: CreditGrantTaxConfig;
|
|
3531
5155
|
/** Available when `funding_method` is `invoice`. */
|
|
3532
5156
|
invoice?: CreditGrantInvoiceReference;
|
|
3533
5157
|
filters?: CreditGrantFilters;
|
|
3534
5158
|
/** Draw-down priority of the grant. Lower values have higher priority. */
|
|
3535
5159
|
priority?: number;
|
|
3536
|
-
/**
|
|
5160
|
+
/**
|
|
5161
|
+
* The duration after which the credit grant expires.
|
|
5162
|
+
*
|
|
5163
|
+
* Defaults to never expiring.
|
|
5164
|
+
*/
|
|
3537
5165
|
expires_after?: string;
|
|
3538
|
-
/**
|
|
5166
|
+
/**
|
|
5167
|
+
* The timestamp when the credit grant expires.
|
|
5168
|
+
*
|
|
5169
|
+
* Calculated from the grant effective time and `expires_after` if provided.
|
|
5170
|
+
*/
|
|
3539
5171
|
expires_at?: string;
|
|
3540
5172
|
/** Timestamp when the grant was voided. */
|
|
3541
5173
|
voided_at?: string;
|
|
@@ -3543,11 +5175,26 @@ export interface CreditGrantInput {
|
|
|
3543
5175
|
status: 'pending' | 'active' | 'expired' | 'voided';
|
|
3544
5176
|
}
|
|
3545
5177
|
export interface WorkflowTaxSettingsInput {
|
|
3546
|
-
/**
|
|
5178
|
+
/**
|
|
5179
|
+
* Enable automatic tax calculation when tax is supported by the app. For example,
|
|
5180
|
+
* with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.
|
|
5181
|
+
*/
|
|
3547
5182
|
enabled?: boolean;
|
|
3548
|
-
/**
|
|
5183
|
+
/**
|
|
5184
|
+
* Enforce tax calculation when tax is supported by the app. When enabled, the
|
|
5185
|
+
* billing system will not allow to create an invoice without tax calculation.
|
|
5186
|
+
* Enforcement is different per apps, for example, Stripe app requires customer to
|
|
5187
|
+
* have a tax location when starting a paid subscription.
|
|
5188
|
+
*/
|
|
3549
5189
|
enforced?: boolean;
|
|
3550
|
-
/**
|
|
5190
|
+
/**
|
|
5191
|
+
* Default tax configuration to apply to the invoices for line items.
|
|
5192
|
+
*
|
|
5193
|
+
* Setting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax
|
|
5194
|
+
* config is deprecated and can no longer be added or changed: the organization
|
|
5195
|
+
* default tax code is used instead. Existing tax-code values may still be removed,
|
|
5196
|
+
* and `behavior` remains fully supported.
|
|
5197
|
+
*/
|
|
3551
5198
|
default_tax_config?: TaxConfig;
|
|
3552
5199
|
}
|
|
3553
5200
|
export interface IngestedEventPaginatedResponseInput {
|
|
@@ -3559,9 +5206,16 @@ export interface MeterQueryRequestInput {
|
|
|
3559
5206
|
from?: string;
|
|
3560
5207
|
/** The end of the period the usage is queried to. */
|
|
3561
5208
|
to?: string;
|
|
3562
|
-
/**
|
|
5209
|
+
/**
|
|
5210
|
+
* The size of the time buckets to group the usage into. If not specified, the
|
|
5211
|
+
* usage is aggregated over the entire period.
|
|
5212
|
+
*/
|
|
3563
5213
|
granularity?: 'PT1M' | 'PT1H' | 'P1D' | 'P1M';
|
|
3564
|
-
/**
|
|
5214
|
+
/**
|
|
5215
|
+
* The value is the name of the time zone as defined in the IANA Time Zone Database
|
|
5216
|
+
* (http://www.iana.org/time-zones). The time zone is used to determine the start
|
|
5217
|
+
* and end of the time buckets. If not specified, the UTC timezone will be used.
|
|
5218
|
+
*/
|
|
3565
5219
|
time_zone?: string;
|
|
3566
5220
|
/** The dimensions to group the results by. */
|
|
3567
5221
|
group_by_dimensions?: string[];
|
|
@@ -3569,35 +5223,88 @@ export interface MeterQueryRequestInput {
|
|
|
3569
5223
|
filters?: MeterQueryFilters;
|
|
3570
5224
|
}
|
|
3571
5225
|
export interface AppStripeCreateCheckoutSessionRequestOptionsInput {
|
|
3572
|
-
/**
|
|
5226
|
+
/**
|
|
5227
|
+
* Whether to collect the customer's billing address.
|
|
5228
|
+
*
|
|
5229
|
+
* Defaults to auto, which only collects the address when necessary for tax
|
|
5230
|
+
* calculation.
|
|
5231
|
+
*/
|
|
3573
5232
|
billing_address_collection?: 'auto' | 'required';
|
|
3574
|
-
/**
|
|
5233
|
+
/**
|
|
5234
|
+
* URL to redirect customers who cancel the checkout session.
|
|
5235
|
+
*
|
|
5236
|
+
* Not allowed when ui_mode is "embedded".
|
|
5237
|
+
*/
|
|
3575
5238
|
cancel_url?: string;
|
|
3576
|
-
/**
|
|
5239
|
+
/**
|
|
5240
|
+
* Unique reference string for reconciling sessions with internal systems.
|
|
5241
|
+
*
|
|
5242
|
+
* Can be a customer ID, cart ID, or any other identifier.
|
|
5243
|
+
*/
|
|
3577
5244
|
client_reference_id?: string;
|
|
3578
5245
|
/** Controls which customer fields can be updated by the checkout session. */
|
|
3579
5246
|
customer_update?: AppStripeCreateCheckoutSessionCustomerUpdateInput;
|
|
3580
5247
|
/** Configuration for collecting customer consent during checkout. */
|
|
3581
5248
|
consent_collection?: AppStripeCreateCheckoutSessionConsentCollection;
|
|
3582
|
-
/**
|
|
5249
|
+
/**
|
|
5250
|
+
* Three-letter ISO 4217 currency code in uppercase.
|
|
5251
|
+
*
|
|
5252
|
+
* Required for payment mode sessions. Optional for setup mode sessions.
|
|
5253
|
+
*/
|
|
3583
5254
|
currency?: string;
|
|
3584
5255
|
/** Custom text to display during checkout at various stages. */
|
|
3585
5256
|
custom_text?: AppStripeCheckoutSessionCustomTextParams;
|
|
3586
|
-
/**
|
|
5257
|
+
/**
|
|
5258
|
+
* Unix timestamp when the checkout session expires.
|
|
5259
|
+
*
|
|
5260
|
+
* Can be 30 minutes to 24 hours from creation. Defaults to 24 hours.
|
|
5261
|
+
*/
|
|
3587
5262
|
expires_at?: bigint;
|
|
3588
|
-
/**
|
|
5263
|
+
/**
|
|
5264
|
+
* IETF language tag for the checkout UI locale.
|
|
5265
|
+
*
|
|
5266
|
+
* If blank or "auto", uses the browser's locale. Example: "en", "fr", "de".
|
|
5267
|
+
*/
|
|
3589
5268
|
locale?: string;
|
|
3590
|
-
/**
|
|
5269
|
+
/**
|
|
5270
|
+
* Set of key-value pairs to attach to the checkout session.
|
|
5271
|
+
*
|
|
5272
|
+
* Useful for storing additional structured information.
|
|
5273
|
+
*/
|
|
3591
5274
|
metadata?: Record<string, string>;
|
|
3592
|
-
/**
|
|
5275
|
+
/**
|
|
5276
|
+
* Return URL for embedded checkout sessions after payment authentication.
|
|
5277
|
+
*
|
|
5278
|
+
* Required if ui_mode is "embedded" and redirect-based payment methods are
|
|
5279
|
+
* enabled.
|
|
5280
|
+
*/
|
|
3593
5281
|
return_url?: string;
|
|
3594
|
-
/**
|
|
5282
|
+
/**
|
|
5283
|
+
* Success URL to redirect customers after completing payment or setup.
|
|
5284
|
+
*
|
|
5285
|
+
* Not allowed when ui_mode is "embedded". See:
|
|
5286
|
+
* https://docs.stripe.com/payments/checkout/custom-success-page
|
|
5287
|
+
*/
|
|
3595
5288
|
success_url?: string;
|
|
3596
|
-
/**
|
|
5289
|
+
/**
|
|
5290
|
+
* The UI mode for the checkout session.
|
|
5291
|
+
*
|
|
5292
|
+
* "hosted" displays a Stripe-hosted page. "embedded" integrates directly into your
|
|
5293
|
+
* app. Defaults to "hosted".
|
|
5294
|
+
*/
|
|
3597
5295
|
ui_mode?: 'embedded' | 'hosted';
|
|
3598
|
-
/**
|
|
5296
|
+
/**
|
|
5297
|
+
* List of payment method types to enable (e.g., "card", "us_bank_account").
|
|
5298
|
+
*
|
|
5299
|
+
* If not specified, Stripe enables all relevant payment methods.
|
|
5300
|
+
*/
|
|
3599
5301
|
payment_method_types?: string[];
|
|
3600
|
-
/**
|
|
5302
|
+
/**
|
|
5303
|
+
* Redirect behavior for embedded checkout sessions.
|
|
5304
|
+
*
|
|
5305
|
+
* Controls when to redirect users after completion. See:
|
|
5306
|
+
* https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form
|
|
5307
|
+
*/
|
|
3601
5308
|
redirect_on_completion?: 'always' | 'if_required' | 'never';
|
|
3602
5309
|
/** Configuration for collecting tax IDs during checkout. */
|
|
3603
5310
|
tax_id_collection?: AppStripeCreateCheckoutSessionTaxIdCollectionInput;
|
|
@@ -3607,14 +5314,29 @@ export interface InvoiceWorkflowSettingsInput {
|
|
|
3607
5314
|
apps?: InvoiceWorkflowAppsReferences;
|
|
3608
5315
|
/** The billing profile that was the source of this workflow snapshot. */
|
|
3609
5316
|
source_billing_profile: ProfileReference;
|
|
3610
|
-
/**
|
|
5317
|
+
/**
|
|
5318
|
+
* The workflow configuration that was active when the invoice was created.
|
|
5319
|
+
*
|
|
5320
|
+
* Only the fields that are meaningful at the per-invoice level are included:
|
|
5321
|
+
* invoicing behaviour (auto-advance, draft period) and payment settings
|
|
5322
|
+
* (collection method, due date). Profile-wide settings such as collection
|
|
5323
|
+
* alignment, progressive billing, and tax policy are omitted.
|
|
5324
|
+
*/
|
|
3611
5325
|
workflow: InvoiceWorkflowInput;
|
|
3612
5326
|
}
|
|
3613
5327
|
export interface InvoiceDetailedLineInput {
|
|
3614
5328
|
id: string;
|
|
3615
|
-
/**
|
|
5329
|
+
/**
|
|
5330
|
+
* Display name of the resource.
|
|
5331
|
+
*
|
|
5332
|
+
* Between 1 and 256 characters.
|
|
5333
|
+
*/
|
|
3616
5334
|
name: string;
|
|
3617
|
-
/**
|
|
5335
|
+
/**
|
|
5336
|
+
* Optional description of the resource.
|
|
5337
|
+
*
|
|
5338
|
+
* Maximum 1024 characters.
|
|
5339
|
+
*/
|
|
3618
5340
|
description?: string;
|
|
3619
5341
|
labels?: Labels;
|
|
3620
5342
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3649,39 +5371,79 @@ export interface BadRequestInput extends BaseErrorInput {
|
|
|
3649
5371
|
invalid_parameters: (InvalidParameterStandard | InvalidParameterMinimumLength | InvalidParameterMaximumLength | InvalidParameterChoiceItem | InvalidParameterDependentItem)[];
|
|
3650
5372
|
}
|
|
3651
5373
|
export interface CustomerStripeCreateCheckoutSessionRequestInput {
|
|
3652
|
-
/**
|
|
5374
|
+
/**
|
|
5375
|
+
* Options for configuring the Stripe Checkout Session.
|
|
5376
|
+
*
|
|
5377
|
+
* These options are passed directly to Stripe's
|
|
5378
|
+
* [checkout session creation API](https://docs.stripe.com/api/checkout/sessions/create).
|
|
5379
|
+
*/
|
|
3653
5380
|
stripe_options: AppStripeCreateCheckoutSessionRequestOptionsInput;
|
|
3654
5381
|
}
|
|
3655
5382
|
export interface WorkflowCollectionSettingsInput {
|
|
3656
5383
|
/** The alignment for collecting the pending line items into an invoice. */
|
|
3657
5384
|
alignment?: WorkflowCollectionAlignmentSubscription | WorkflowCollectionAlignmentAnchored;
|
|
3658
|
-
/**
|
|
5385
|
+
/**
|
|
5386
|
+
* This grace period can be used to delay the collection of the pending line items
|
|
5387
|
+
* specified in alignment.
|
|
5388
|
+
*
|
|
5389
|
+
* This is useful, in case of multiple subscriptions having slightly different
|
|
5390
|
+
* billing periods.
|
|
5391
|
+
*/
|
|
3659
5392
|
interval?: string;
|
|
3660
5393
|
}
|
|
3661
5394
|
export interface RateCardInput {
|
|
3662
|
-
/**
|
|
5395
|
+
/**
|
|
5396
|
+
* Display name of the resource.
|
|
5397
|
+
*
|
|
5398
|
+
* Between 1 and 256 characters.
|
|
5399
|
+
*/
|
|
3663
5400
|
name: string;
|
|
3664
|
-
/**
|
|
5401
|
+
/**
|
|
5402
|
+
* Optional description of the resource.
|
|
5403
|
+
*
|
|
5404
|
+
* Maximum 1024 characters.
|
|
5405
|
+
*/
|
|
3665
5406
|
description?: string;
|
|
3666
5407
|
labels?: Labels;
|
|
3667
5408
|
key: string;
|
|
3668
5409
|
/** The feature associated with the rate card. */
|
|
3669
5410
|
feature?: FeatureReference;
|
|
3670
|
-
/**
|
|
5411
|
+
/**
|
|
5412
|
+
* The billing cadence of the rate card. When null, the charge is one-time
|
|
5413
|
+
* (non-recurring). Only valid for flat prices.
|
|
5414
|
+
*/
|
|
3671
5415
|
billing_cadence?: string;
|
|
3672
5416
|
/** The price of the rate card. */
|
|
3673
5417
|
price: PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVolume;
|
|
3674
|
-
/**
|
|
5418
|
+
/**
|
|
5419
|
+
* Unit conversion configuration for the rate card.
|
|
5420
|
+
*
|
|
5421
|
+
* Synthesized on read for plans authored with v1 dynamic or package prices:
|
|
5422
|
+
* dynamic prices map to a unit price with a multiply unit config, and package
|
|
5423
|
+
* prices map to a unit price with a divide unit config.
|
|
5424
|
+
*
|
|
5425
|
+
* Accepted on create and update only when the UnitConfig feature is enabled on the
|
|
5426
|
+
* deployment; otherwise rejected.
|
|
5427
|
+
*/
|
|
3675
5428
|
unit_config?: UnitConfigInput;
|
|
3676
|
-
/**
|
|
5429
|
+
/**
|
|
5430
|
+
* The payment term of the rate card. In advance payment term can only be used for
|
|
5431
|
+
* flat prices.
|
|
5432
|
+
*/
|
|
3677
5433
|
payment_term?: 'in_advance' | 'in_arrears';
|
|
3678
|
-
/**
|
|
5434
|
+
/**
|
|
5435
|
+
* Spend commitments for this rate card. Only applicable to usage-based prices
|
|
5436
|
+
* (unit, graduated, volume).
|
|
5437
|
+
*/
|
|
3679
5438
|
commitments?: SpendCommitments;
|
|
3680
5439
|
/** The discounts of the rate card. */
|
|
3681
5440
|
discounts?: RateCardDiscounts;
|
|
3682
5441
|
/** The tax config of the rate card. */
|
|
3683
5442
|
tax_config?: RateCardTaxConfig;
|
|
3684
|
-
/**
|
|
5443
|
+
/**
|
|
5444
|
+
* The entitlement template granted to subscribers of a plan or addon containing
|
|
5445
|
+
* this rate card. Requires `feature` to be set.
|
|
5446
|
+
*/
|
|
3685
5447
|
entitlement?: RateCardMeteredEntitlementInput | RateCardStaticEntitlement | RateCardBooleanEntitlement;
|
|
3686
5448
|
}
|
|
3687
5449
|
export interface WorkflowInput {
|
|
@@ -3696,9 +5458,17 @@ export interface WorkflowInput {
|
|
|
3696
5458
|
}
|
|
3697
5459
|
export interface InvoiceStandardLineInput {
|
|
3698
5460
|
id: string;
|
|
3699
|
-
/**
|
|
5461
|
+
/**
|
|
5462
|
+
* Display name of the resource.
|
|
5463
|
+
*
|
|
5464
|
+
* Between 1 and 256 characters.
|
|
5465
|
+
*/
|
|
3700
5466
|
name: string;
|
|
3701
|
-
/**
|
|
5467
|
+
/**
|
|
5468
|
+
* Optional description of the resource.
|
|
5469
|
+
*
|
|
5470
|
+
* Maximum 1024 characters.
|
|
5471
|
+
*/
|
|
3702
5472
|
description?: string;
|
|
3703
5473
|
labels?: Labels;
|
|
3704
5474
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3709,9 +5479,18 @@ export interface InvoiceStandardLineInput {
|
|
|
3709
5479
|
deleted_at?: string;
|
|
3710
5480
|
/** The type of charge this line item represents. */
|
|
3711
5481
|
type: 'standard_line';
|
|
3712
|
-
/**
|
|
5482
|
+
/**
|
|
5483
|
+
* Indicates whether this line item's lifecycle is controlled by OpenMeter or
|
|
5484
|
+
* manually overridden by the API user.
|
|
5485
|
+
*/
|
|
3713
5486
|
lifecycle_controller: 'system' | 'manual';
|
|
3714
|
-
/**
|
|
5487
|
+
/**
|
|
5488
|
+
* The service period covered by this invoice, spanning the earliest line start to
|
|
5489
|
+
* the latest line end across all of its lines.
|
|
5490
|
+
*
|
|
5491
|
+
* For an invoice with no lines the period is empty, which means `from` will be
|
|
5492
|
+
* equal to `to`.
|
|
5493
|
+
*/
|
|
3715
5494
|
service_period: ClosedPeriod;
|
|
3716
5495
|
/** Aggregated financial totals for the line item. */
|
|
3717
5496
|
totals: Totals;
|
|
@@ -3725,28 +5504,51 @@ export interface InvoiceStandardLineInput {
|
|
|
3725
5504
|
subscription?: SubscriptionReference;
|
|
3726
5505
|
/** The rate card configuration snapshot used to price this line item. */
|
|
3727
5506
|
rate_card: InvoiceLineRateCard;
|
|
3728
|
-
/**
|
|
5507
|
+
/**
|
|
5508
|
+
* Detailed sub-lines that this line has been broken down into.
|
|
5509
|
+
*
|
|
5510
|
+
* Present when line has individual details.
|
|
5511
|
+
*/
|
|
3729
5512
|
detailed_lines: InvoiceDetailedLineInput[];
|
|
3730
5513
|
/** Reference to the charge associated with this line item. */
|
|
3731
5514
|
charge?: ChargeReference;
|
|
3732
5515
|
}
|
|
3733
5516
|
export interface PlanPhaseInput {
|
|
3734
|
-
/**
|
|
5517
|
+
/**
|
|
5518
|
+
* Display name of the resource.
|
|
5519
|
+
*
|
|
5520
|
+
* Between 1 and 256 characters.
|
|
5521
|
+
*/
|
|
3735
5522
|
name: string;
|
|
3736
|
-
/**
|
|
5523
|
+
/**
|
|
5524
|
+
* Optional description of the resource.
|
|
5525
|
+
*
|
|
5526
|
+
* Maximum 1024 characters.
|
|
5527
|
+
*/
|
|
3737
5528
|
description?: string;
|
|
3738
5529
|
labels?: Labels;
|
|
3739
5530
|
key: string;
|
|
3740
|
-
/**
|
|
5531
|
+
/**
|
|
5532
|
+
* The duration of the phase. When not specified, the phase runs indefinitely. Only
|
|
5533
|
+
* the last phase may omit the duration.
|
|
5534
|
+
*/
|
|
3741
5535
|
duration?: string;
|
|
3742
5536
|
/** The rate cards of the plan. */
|
|
3743
5537
|
rate_cards: RateCardInput[];
|
|
3744
5538
|
}
|
|
3745
5539
|
export interface AddonInput {
|
|
3746
5540
|
id: string;
|
|
3747
|
-
/**
|
|
5541
|
+
/**
|
|
5542
|
+
* Display name of the resource.
|
|
5543
|
+
*
|
|
5544
|
+
* Between 1 and 256 characters.
|
|
5545
|
+
*/
|
|
3748
5546
|
name: string;
|
|
3749
|
-
/**
|
|
5547
|
+
/**
|
|
5548
|
+
* Optional description of the resource.
|
|
5549
|
+
*
|
|
5550
|
+
* Maximum 1024 characters.
|
|
5551
|
+
*/
|
|
3750
5552
|
description?: string;
|
|
3751
5553
|
labels?: Labels;
|
|
3752
5554
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3755,7 +5557,11 @@ export interface AddonInput {
|
|
|
3755
5557
|
updated_at: string;
|
|
3756
5558
|
/** An ISO-8601 timestamp representation of entity deletion date. */
|
|
3757
5559
|
deleted_at?: string;
|
|
3758
|
-
/**
|
|
5560
|
+
/**
|
|
5561
|
+
* A key is a semi-unique string that is used to identify the add-on. It is used to
|
|
5562
|
+
* reference the latest `active` version of the add-on and is unique with the
|
|
5563
|
+
* version number.
|
|
5564
|
+
*/
|
|
3759
5565
|
key: string;
|
|
3760
5566
|
/** Version of the add-on. Incremented when the add-on is updated. */
|
|
3761
5567
|
version?: number;
|
|
@@ -3763,11 +5569,24 @@ export interface AddonInput {
|
|
|
3763
5569
|
instance_type: 'single' | 'multiple';
|
|
3764
5570
|
/** The currency code of the add-on. */
|
|
3765
5571
|
currency: string;
|
|
3766
|
-
/**
|
|
5572
|
+
/**
|
|
5573
|
+
* The date and time when the add-on becomes effective. When not specified, the
|
|
5574
|
+
* add-on is a draft.
|
|
5575
|
+
*/
|
|
3767
5576
|
effective_from?: string;
|
|
3768
|
-
/**
|
|
5577
|
+
/**
|
|
5578
|
+
* The date and time when the add-on is no longer effective. When not specified,
|
|
5579
|
+
* the add-on is effective indefinitely.
|
|
5580
|
+
*/
|
|
3769
5581
|
effective_to?: string;
|
|
3770
|
-
/**
|
|
5582
|
+
/**
|
|
5583
|
+
* The status of the add-on. Computed based on the effective start and end dates:
|
|
5584
|
+
*
|
|
5585
|
+
* - `draft`: `effective_from` is not set.
|
|
5586
|
+
* - `active`: `effective_from <= now` and (`effective_to` is not set or
|
|
5587
|
+
* `now < effective_to`).
|
|
5588
|
+
* - `archived`: `effective_to <= now`.
|
|
5589
|
+
*/
|
|
3771
5590
|
status: 'draft' | 'active' | 'archived';
|
|
3772
5591
|
/** The rate cards of the add-on. */
|
|
3773
5592
|
rate_cards: RateCardInput[];
|
|
@@ -3775,12 +5594,24 @@ export interface AddonInput {
|
|
|
3775
5594
|
validation_errors?: ProductCatalogValidationError[];
|
|
3776
5595
|
}
|
|
3777
5596
|
export interface CreateAddonRequestInput {
|
|
3778
|
-
/**
|
|
5597
|
+
/**
|
|
5598
|
+
* Display name of the resource.
|
|
5599
|
+
*
|
|
5600
|
+
* Between 1 and 256 characters.
|
|
5601
|
+
*/
|
|
3779
5602
|
name: string;
|
|
3780
|
-
/**
|
|
5603
|
+
/**
|
|
5604
|
+
* Optional description of the resource.
|
|
5605
|
+
*
|
|
5606
|
+
* Maximum 1024 characters.
|
|
5607
|
+
*/
|
|
3781
5608
|
description?: string;
|
|
3782
5609
|
labels?: Labels;
|
|
3783
|
-
/**
|
|
5610
|
+
/**
|
|
5611
|
+
* A key is a semi-unique string that is used to identify the add-on. It is used to
|
|
5612
|
+
* reference the latest `active` version of the add-on and is unique with the
|
|
5613
|
+
* version number.
|
|
5614
|
+
*/
|
|
3784
5615
|
key: string;
|
|
3785
5616
|
/** The InstanceType of the add-ons. Can be "single" or "multiple". */
|
|
3786
5617
|
instance_type: 'single' | 'multiple';
|
|
@@ -3790,9 +5621,17 @@ export interface CreateAddonRequestInput {
|
|
|
3790
5621
|
rate_cards: RateCardInput[];
|
|
3791
5622
|
}
|
|
3792
5623
|
export interface UpsertAddonRequestInput {
|
|
3793
|
-
/**
|
|
5624
|
+
/**
|
|
5625
|
+
* Display name of the resource.
|
|
5626
|
+
*
|
|
5627
|
+
* Between 1 and 256 characters.
|
|
5628
|
+
*/
|
|
3794
5629
|
name: string;
|
|
3795
|
-
/**
|
|
5630
|
+
/**
|
|
5631
|
+
* Optional description of the resource.
|
|
5632
|
+
*
|
|
5633
|
+
* Maximum 1024 characters.
|
|
5634
|
+
*/
|
|
3796
5635
|
description?: string;
|
|
3797
5636
|
labels?: Labels;
|
|
3798
5637
|
/** The InstanceType of the add-ons. Can be "single" or "multiple". */
|
|
@@ -3802,9 +5641,17 @@ export interface UpsertAddonRequestInput {
|
|
|
3802
5641
|
}
|
|
3803
5642
|
export interface ProfileInput {
|
|
3804
5643
|
id: string;
|
|
3805
|
-
/**
|
|
5644
|
+
/**
|
|
5645
|
+
* Display name of the resource.
|
|
5646
|
+
*
|
|
5647
|
+
* Between 1 and 256 characters.
|
|
5648
|
+
*/
|
|
3806
5649
|
name: string;
|
|
3807
|
-
/**
|
|
5650
|
+
/**
|
|
5651
|
+
* Optional description of the resource.
|
|
5652
|
+
*
|
|
5653
|
+
* Maximum 1024 characters.
|
|
5654
|
+
*/
|
|
3808
5655
|
description?: string;
|
|
3809
5656
|
labels?: Labels;
|
|
3810
5657
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3813,7 +5660,10 @@ export interface ProfileInput {
|
|
|
3813
5660
|
updated_at: string;
|
|
3814
5661
|
/** An ISO-8601 timestamp representation of entity deletion date. */
|
|
3815
5662
|
deleted_at?: string;
|
|
3816
|
-
/**
|
|
5663
|
+
/**
|
|
5664
|
+
* The name and contact information for the supplier this billing profile
|
|
5665
|
+
* represents
|
|
5666
|
+
*/
|
|
3817
5667
|
supplier: Party;
|
|
3818
5668
|
/** The billing workflow settings for this profile */
|
|
3819
5669
|
workflow: WorkflowInput;
|
|
@@ -3823,12 +5673,23 @@ export interface ProfileInput {
|
|
|
3823
5673
|
default: boolean;
|
|
3824
5674
|
}
|
|
3825
5675
|
export interface CreateBillingProfileRequestInput {
|
|
3826
|
-
/**
|
|
5676
|
+
/**
|
|
5677
|
+
* Display name of the resource.
|
|
5678
|
+
*
|
|
5679
|
+
* Between 1 and 256 characters.
|
|
5680
|
+
*/
|
|
3827
5681
|
name: string;
|
|
3828
|
-
/**
|
|
5682
|
+
/**
|
|
5683
|
+
* Optional description of the resource.
|
|
5684
|
+
*
|
|
5685
|
+
* Maximum 1024 characters.
|
|
5686
|
+
*/
|
|
3829
5687
|
description?: string;
|
|
3830
5688
|
labels?: Labels;
|
|
3831
|
-
/**
|
|
5689
|
+
/**
|
|
5690
|
+
* The name and contact information for the supplier this billing profile
|
|
5691
|
+
* represents
|
|
5692
|
+
*/
|
|
3832
5693
|
supplier: Party;
|
|
3833
5694
|
/** The billing workflow settings for this profile */
|
|
3834
5695
|
workflow: WorkflowInput;
|
|
@@ -3838,12 +5699,23 @@ export interface CreateBillingProfileRequestInput {
|
|
|
3838
5699
|
default: boolean;
|
|
3839
5700
|
}
|
|
3840
5701
|
export interface UpsertBillingProfileRequestInput {
|
|
3841
|
-
/**
|
|
5702
|
+
/**
|
|
5703
|
+
* Display name of the resource.
|
|
5704
|
+
*
|
|
5705
|
+
* Between 1 and 256 characters.
|
|
5706
|
+
*/
|
|
3842
5707
|
name: string;
|
|
3843
|
-
/**
|
|
5708
|
+
/**
|
|
5709
|
+
* Optional description of the resource.
|
|
5710
|
+
*
|
|
5711
|
+
* Maximum 1024 characters.
|
|
5712
|
+
*/
|
|
3844
5713
|
description?: string;
|
|
3845
5714
|
labels?: Labels;
|
|
3846
|
-
/**
|
|
5715
|
+
/**
|
|
5716
|
+
* The name and contact information for the supplier this billing profile
|
|
5717
|
+
* represents
|
|
5718
|
+
*/
|
|
3847
5719
|
supplier: Party;
|
|
3848
5720
|
/** The billing workflow settings for this profile */
|
|
3849
5721
|
workflow: WorkflowInput;
|
|
@@ -3852,9 +5724,17 @@ export interface UpsertBillingProfileRequestInput {
|
|
|
3852
5724
|
}
|
|
3853
5725
|
export interface PlanInput {
|
|
3854
5726
|
id: string;
|
|
3855
|
-
/**
|
|
5727
|
+
/**
|
|
5728
|
+
* Display name of the resource.
|
|
5729
|
+
*
|
|
5730
|
+
* Between 1 and 256 characters.
|
|
5731
|
+
*/
|
|
3856
5732
|
name: string;
|
|
3857
|
-
/**
|
|
5733
|
+
/**
|
|
5734
|
+
* Optional description of the resource.
|
|
5735
|
+
*
|
|
5736
|
+
* Maximum 1024 characters.
|
|
5737
|
+
*/
|
|
3858
5738
|
description?: string;
|
|
3859
5739
|
labels?: Labels;
|
|
3860
5740
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3863,9 +5743,16 @@ export interface PlanInput {
|
|
|
3863
5743
|
updated_at: string;
|
|
3864
5744
|
/** An ISO-8601 timestamp representation of entity deletion date. */
|
|
3865
5745
|
deleted_at?: string;
|
|
3866
|
-
/**
|
|
5746
|
+
/**
|
|
5747
|
+
* A key is a semi-unique string that is used to identify the plan. It is used to
|
|
5748
|
+
* reference the latest `active` version of the plan and is unique with the version
|
|
5749
|
+
* number.
|
|
5750
|
+
*/
|
|
3867
5751
|
key: string;
|
|
3868
|
-
/**
|
|
5752
|
+
/**
|
|
5753
|
+
* Plans are versioned to allow you to make changes without affecting running
|
|
5754
|
+
* subscriptions.
|
|
5755
|
+
*/
|
|
3869
5756
|
version?: number;
|
|
3870
5757
|
/** The currency code of the plan. */
|
|
3871
5758
|
currency: string;
|
|
@@ -3873,26 +5760,66 @@ export interface PlanInput {
|
|
|
3873
5760
|
billing_cadence: string;
|
|
3874
5761
|
/** Whether pro-rating is enabled for this plan. */
|
|
3875
5762
|
pro_rating_enabled?: boolean;
|
|
3876
|
-
/**
|
|
5763
|
+
/**
|
|
5764
|
+
* The date and time when the plan becomes `active`. When not specified, the plan
|
|
5765
|
+
* is in `draft` status.
|
|
5766
|
+
*/
|
|
3877
5767
|
effective_from?: string;
|
|
3878
|
-
/**
|
|
5768
|
+
/**
|
|
5769
|
+
* A scheduled date and time when the plan becomes `archived`. When not specified,
|
|
5770
|
+
* the plan is in `active` status indefinitely.
|
|
5771
|
+
*/
|
|
3879
5772
|
effective_to?: string;
|
|
3880
|
-
/**
|
|
5773
|
+
/**
|
|
5774
|
+
* The status of the plan. Computed based on the effective start and end dates:
|
|
5775
|
+
*
|
|
5776
|
+
* - `draft`: `effective_from` is not set.
|
|
5777
|
+
* - `scheduled`: `now < effective_from`.
|
|
5778
|
+
* - `active`: `effective_from <= now` and (`effective_to` is not set or
|
|
5779
|
+
* `now < effective_to`).
|
|
5780
|
+
* - `archived`: `effective_to <= now`.
|
|
5781
|
+
*/
|
|
3881
5782
|
status: 'draft' | 'active' | 'archived' | 'scheduled';
|
|
3882
|
-
/**
|
|
5783
|
+
/**
|
|
5784
|
+
* The plan phases define the pricing ramp for a subscription. A phase switch
|
|
5785
|
+
* occurs only at the end of a billing period. At least one phase is required.
|
|
5786
|
+
*/
|
|
3883
5787
|
phases: PlanPhaseInput[];
|
|
3884
|
-
/**
|
|
5788
|
+
/**
|
|
5789
|
+
* Settlement mode for plan.
|
|
5790
|
+
*
|
|
5791
|
+
* Values:
|
|
5792
|
+
*
|
|
5793
|
+
* - `credit_then_invoice`: Credits are applied first, then any remainder is
|
|
5794
|
+
* invoiced.
|
|
5795
|
+
* - `credit_only`: Usage is settled exclusively against credits.
|
|
5796
|
+
*/
|
|
3885
5797
|
settlement_mode?: 'credit_then_invoice' | 'credit_only';
|
|
3886
|
-
/**
|
|
5798
|
+
/**
|
|
5799
|
+
* List of validation errors in `draft` state that prevent the plan from being
|
|
5800
|
+
* published.
|
|
5801
|
+
*/
|
|
3887
5802
|
validation_errors?: ProductCatalogValidationError[];
|
|
3888
5803
|
}
|
|
3889
5804
|
export interface CreatePlanRequestInput {
|
|
3890
|
-
/**
|
|
5805
|
+
/**
|
|
5806
|
+
* Display name of the resource.
|
|
5807
|
+
*
|
|
5808
|
+
* Between 1 and 256 characters.
|
|
5809
|
+
*/
|
|
3891
5810
|
name: string;
|
|
3892
|
-
/**
|
|
5811
|
+
/**
|
|
5812
|
+
* Optional description of the resource.
|
|
5813
|
+
*
|
|
5814
|
+
* Maximum 1024 characters.
|
|
5815
|
+
*/
|
|
3893
5816
|
description?: string;
|
|
3894
5817
|
labels?: Labels;
|
|
3895
|
-
/**
|
|
5818
|
+
/**
|
|
5819
|
+
* A key is a semi-unique string that is used to identify the plan. It is used to
|
|
5820
|
+
* reference the latest `active` version of the plan and is unique with the version
|
|
5821
|
+
* number.
|
|
5822
|
+
*/
|
|
3896
5823
|
key: string;
|
|
3897
5824
|
/** The currency code of the plan. */
|
|
3898
5825
|
currency: string;
|
|
@@ -3900,18 +5827,32 @@ export interface CreatePlanRequestInput {
|
|
|
3900
5827
|
billing_cadence: string;
|
|
3901
5828
|
/** Whether pro-rating is enabled for this plan. */
|
|
3902
5829
|
pro_rating_enabled?: boolean;
|
|
3903
|
-
/**
|
|
5830
|
+
/**
|
|
5831
|
+
* The plan phases define the pricing ramp for a subscription. A phase switch
|
|
5832
|
+
* occurs only at the end of a billing period. At least one phase is required.
|
|
5833
|
+
*/
|
|
3904
5834
|
phases: PlanPhaseInput[];
|
|
3905
5835
|
}
|
|
3906
5836
|
export interface UpsertPlanRequestInput {
|
|
3907
|
-
/**
|
|
5837
|
+
/**
|
|
5838
|
+
* Display name of the resource.
|
|
5839
|
+
*
|
|
5840
|
+
* Between 1 and 256 characters.
|
|
5841
|
+
*/
|
|
3908
5842
|
name: string;
|
|
3909
|
-
/**
|
|
5843
|
+
/**
|
|
5844
|
+
* Optional description of the resource.
|
|
5845
|
+
*
|
|
5846
|
+
* Maximum 1024 characters.
|
|
5847
|
+
*/
|
|
3910
5848
|
description?: string;
|
|
3911
5849
|
labels?: Labels;
|
|
3912
5850
|
/** Whether pro-rating is enabled for this plan. */
|
|
3913
5851
|
pro_rating_enabled?: boolean;
|
|
3914
|
-
/**
|
|
5852
|
+
/**
|
|
5853
|
+
* The plan phases define the pricing ramp for a subscription. A phase switch
|
|
5854
|
+
* occurs only at the end of a billing period. At least one phase is required.
|
|
5855
|
+
*/
|
|
3915
5856
|
phases: PlanPhaseInput[];
|
|
3916
5857
|
}
|
|
3917
5858
|
export interface AddonPagePaginatedResponseInput {
|
|
@@ -3924,7 +5865,11 @@ export interface ProfilePagePaginatedResponseInput {
|
|
|
3924
5865
|
}
|
|
3925
5866
|
export interface InvoiceStandardInput {
|
|
3926
5867
|
id: string;
|
|
3927
|
-
/**
|
|
5868
|
+
/**
|
|
5869
|
+
* Optional description of the resource.
|
|
5870
|
+
*
|
|
5871
|
+
* Maximum 1024 characters.
|
|
5872
|
+
*/
|
|
3928
5873
|
description?: string;
|
|
3929
5874
|
labels?: Labels;
|
|
3930
5875
|
/** An ISO-8601 timestamp representation of entity creation date. */
|
|
@@ -3937,15 +5882,29 @@ export interface InvoiceStandardInput {
|
|
|
3937
5882
|
number: string;
|
|
3938
5883
|
/** Three-letter ISO 4217 currency code for the invoice. */
|
|
3939
5884
|
currency: string;
|
|
3940
|
-
/**
|
|
5885
|
+
/**
|
|
5886
|
+
* Snapshot of the supplier's contact information at the time the invoice was
|
|
5887
|
+
* issued.
|
|
5888
|
+
*/
|
|
3941
5889
|
supplier: Supplier;
|
|
3942
5890
|
/** Snapshot of the customer's information at the time the invoice was issued. */
|
|
3943
5891
|
customer: InvoiceCustomer;
|
|
3944
5892
|
/** Aggregated financial totals for the invoice. */
|
|
3945
5893
|
totals: Totals;
|
|
3946
|
-
/**
|
|
5894
|
+
/**
|
|
5895
|
+
* The service period covered by this invoice.
|
|
5896
|
+
*
|
|
5897
|
+
* For flat fee the service period can be empty which means `from` will be equals
|
|
5898
|
+
* to `to`. In other cases those fields will be filled with the actual service
|
|
5899
|
+
* period.
|
|
5900
|
+
*/
|
|
3947
5901
|
service_period: ClosedPeriod;
|
|
3948
|
-
/**
|
|
5902
|
+
/**
|
|
5903
|
+
* Validation issues found during invoice processing.
|
|
5904
|
+
*
|
|
5905
|
+
* Present only when there are one or more validation findings. An empty list is
|
|
5906
|
+
* omitted.
|
|
5907
|
+
*/
|
|
3949
5908
|
validation_issues?: InvoiceValidationIssue[];
|
|
3950
5909
|
/** External identifiers assigned to this invoice by third-party systems. */
|
|
3951
5910
|
external_references?: InvoiceExternalReferences;
|
|
@@ -3957,7 +5916,11 @@ export interface InvoiceStandardInput {
|
|
|
3957
5916
|
status_details: InvoiceStatusDetails;
|
|
3958
5917
|
/** Timestamp when the invoice was issued to the customer. */
|
|
3959
5918
|
issued_at?: string;
|
|
3960
|
-
/**
|
|
5919
|
+
/**
|
|
5920
|
+
* Timestamp until which the invoice remains in draft state.
|
|
5921
|
+
*
|
|
5922
|
+
* The invoice advances automatically once this time is reached.
|
|
5923
|
+
*/
|
|
3961
5924
|
draft_until?: string;
|
|
3962
5925
|
/** Timestamp when usage quantities were last snapshotted for this invoice. */
|
|
3963
5926
|
quantity_snapshotted_at?: string;
|
|
@@ -3969,7 +5932,12 @@ export interface InvoiceStandardInput {
|
|
|
3969
5932
|
sent_to_customer_at?: string;
|
|
3970
5933
|
/** Workflow configuration snapshot captured at invoice creation time. */
|
|
3971
5934
|
workflow: InvoiceWorkflowSettingsInput;
|
|
3972
|
-
/**
|
|
5935
|
+
/**
|
|
5936
|
+
* Line items on this invoice.
|
|
5937
|
+
*
|
|
5938
|
+
* Always returned on single-resource GET; omitted on list endpoints unless
|
|
5939
|
+
* explicitly expanded.
|
|
5940
|
+
*/
|
|
3973
5941
|
lines?: InvoiceStandardLineInput[];
|
|
3974
5942
|
}
|
|
3975
5943
|
export interface PlanPagePaginatedResponseInput {
|