@humanlayer/pulumi-stripe 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/bin/billingMeter.d.ts +130 -0
- package/bin/billingMeter.js +72 -0
- package/bin/billingMeter.js.map +1 -0
- package/bin/config/index.d.ts +1 -0
- package/bin/config/index.js +21 -0
- package/bin/config/index.js.map +1 -0
- package/bin/config/vars.d.ts +4 -0
- package/bin/config/vars.js +13 -0
- package/bin/config/vars.js.map +1 -0
- package/bin/coupon.d.ts +203 -0
- package/bin/coupon.js +77 -0
- package/bin/coupon.js.map +1 -0
- package/bin/customer.d.ts +248 -0
- package/bin/customer.js +93 -0
- package/bin/customer.js.map +1 -0
- package/bin/entitlementsFeature.d.ts +86 -0
- package/bin/entitlementsFeature.js +58 -0
- package/bin/entitlementsFeature.js.map +1 -0
- package/bin/getBillingMeter.d.ts +26 -0
- package/bin/getBillingMeter.js +25 -0
- package/bin/getBillingMeter.js.map +1 -0
- package/bin/index.d.ts +64 -0
- package/bin/index.js +145 -0
- package/bin/index.js.map +1 -0
- package/bin/price.d.ts +232 -0
- package/bin/price.js +82 -0
- package/bin/price.js.map +1 -0
- package/bin/product.d.ts +212 -0
- package/bin/product.js +75 -0
- package/bin/product.js.map +1 -0
- package/bin/promotionCode.d.ts +160 -0
- package/bin/promotionCode.js +70 -0
- package/bin/promotionCode.js.map +1 -0
- package/bin/provider.d.ts +49 -0
- package/bin/provider.js +55 -0
- package/bin/provider.js.map +1 -0
- package/bin/shippingRate.d.ts +136 -0
- package/bin/shippingRate.js +66 -0
- package/bin/shippingRate.js.map +1 -0
- package/bin/taxRate.d.ts +186 -0
- package/bin/taxRate.js +82 -0
- package/bin/taxRate.js.map +1 -0
- package/bin/types/index.d.ts +3 -0
- package/bin/types/index.js +11 -0
- package/bin/types/index.js.map +1 -0
- package/bin/types/input.d.ts +713 -0
- package/bin/types/input.js +5 -0
- package/bin/types/input.js.map +1 -0
- package/bin/types/output.d.ts +712 -0
- package/bin/types/output.js +5 -0
- package/bin/types/output.js.map +1 -0
- package/bin/utilities.d.ts +4 -0
- package/bin/utilities.js +90 -0
- package/bin/utilities.js.map +1 -0
- package/bin/v2billingLicenseFee.d.ts +200 -0
- package/bin/v2billingLicenseFee.js +93 -0
- package/bin/v2billingLicenseFee.js.map +1 -0
- package/bin/v2billingLicensedItem.d.ts +90 -0
- package/bin/v2billingLicensedItem.js +58 -0
- package/bin/v2billingLicensedItem.js.map +1 -0
- package/bin/v2billingMeteredItem.d.ts +128 -0
- package/bin/v2billingMeteredItem.js +67 -0
- package/bin/v2billingMeteredItem.js.map +1 -0
- package/bin/v2billingPricingPlan.d.ts +138 -0
- package/bin/v2billingPricingPlan.js +74 -0
- package/bin/v2billingPricingPlan.js.map +1 -0
- package/bin/v2billingPricingPlanComponent.d.ts +144 -0
- package/bin/v2billingPricingPlanComponent.js +71 -0
- package/bin/v2billingPricingPlanComponent.js.map +1 -0
- package/bin/v2billingRateCard.d.ts +150 -0
- package/bin/v2billingRateCard.js +82 -0
- package/bin/v2billingRateCard.js.map +1 -0
- package/bin/v2billingRateCardRate.d.ts +132 -0
- package/bin/v2billingRateCardRate.js +69 -0
- package/bin/v2billingRateCardRate.js.map +1 -0
- package/bin/v2billingServiceAction.d.ts +98 -0
- package/bin/v2billingServiceAction.js +66 -0
- package/bin/v2billingServiceAction.js.map +1 -0
- package/bin/v2coreEventDestination.d.ts +172 -0
- package/bin/v2coreEventDestination.js +78 -0
- package/bin/v2coreEventDestination.js.map +1 -0
- package/bin/webhookEndpoint.d.ts +120 -0
- package/bin/webhookEndpoint.js +73 -0
- package/bin/webhookEndpoint.js.map +1 -0
- package/package.json +42 -0
|
@@ -0,0 +1,712 @@
|
|
|
1
|
+
import * as outputs from "../types/output";
|
|
2
|
+
export interface BillingMeterCustomerMapping {
|
|
3
|
+
/**
|
|
4
|
+
* The key in the meter event payload to use for mapping the event to a customer.
|
|
5
|
+
*/
|
|
6
|
+
eventPayloadKey: string;
|
|
7
|
+
/**
|
|
8
|
+
* The method for mapping a meter event to a customer. Must be `byId`.
|
|
9
|
+
*/
|
|
10
|
+
type: string;
|
|
11
|
+
}
|
|
12
|
+
export interface BillingMeterDefaultAggregation {
|
|
13
|
+
/**
|
|
14
|
+
* Specifies how events are aggregated. Allowed values are `count` to count the number of events, `sum` to sum each event's value and `last` to take the last event's value in the window.
|
|
15
|
+
*/
|
|
16
|
+
formula: string;
|
|
17
|
+
}
|
|
18
|
+
export interface BillingMeterValueSettings {
|
|
19
|
+
/**
|
|
20
|
+
* The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a `bytesUsed` field, then set the eventPayloadKey to \"bytes_used\".
|
|
21
|
+
*/
|
|
22
|
+
eventPayloadKey: string;
|
|
23
|
+
}
|
|
24
|
+
export interface CouponAppliesTo {
|
|
25
|
+
/**
|
|
26
|
+
* An array of Product IDs that this Coupon will apply to.
|
|
27
|
+
*/
|
|
28
|
+
products: string[];
|
|
29
|
+
}
|
|
30
|
+
export interface CouponCurrencyOption {
|
|
31
|
+
/**
|
|
32
|
+
* A positive integer representing the amount to subtract from an invoice total.
|
|
33
|
+
*/
|
|
34
|
+
amountOff: number;
|
|
35
|
+
key: string;
|
|
36
|
+
}
|
|
37
|
+
export interface CouponScript {
|
|
38
|
+
/**
|
|
39
|
+
* The configuration values of the script. The keys and values are specific to the script implementation.
|
|
40
|
+
*/
|
|
41
|
+
configuration: {
|
|
42
|
+
[key: string]: string;
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* The name of the script used to calculate the discount.
|
|
46
|
+
*/
|
|
47
|
+
displayName: string;
|
|
48
|
+
/**
|
|
49
|
+
* The script implementation ID for this coupon.
|
|
50
|
+
*/
|
|
51
|
+
id: string;
|
|
52
|
+
}
|
|
53
|
+
export interface CustomerAddress {
|
|
54
|
+
/**
|
|
55
|
+
* City, district, suburb, town, or village.
|
|
56
|
+
*/
|
|
57
|
+
city?: string;
|
|
58
|
+
/**
|
|
59
|
+
* A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
60
|
+
*/
|
|
61
|
+
country?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Address line 1, such as the street, PO Box, or company name.
|
|
64
|
+
*/
|
|
65
|
+
line1?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Address line 2, such as the apartment, suite, unit, or building.
|
|
68
|
+
*/
|
|
69
|
+
line2?: string;
|
|
70
|
+
/**
|
|
71
|
+
* ZIP or postal code.
|
|
72
|
+
*/
|
|
73
|
+
postalCode?: string;
|
|
74
|
+
/**
|
|
75
|
+
* State, county, province, or region.
|
|
76
|
+
*/
|
|
77
|
+
state?: string;
|
|
78
|
+
}
|
|
79
|
+
export interface CustomerCashBalance {
|
|
80
|
+
/**
|
|
81
|
+
* A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
|
82
|
+
*/
|
|
83
|
+
available: {
|
|
84
|
+
[key: string]: string;
|
|
85
|
+
};
|
|
86
|
+
/**
|
|
87
|
+
* The ID of the customer whose cash balance this object represents.
|
|
88
|
+
*/
|
|
89
|
+
customer: string;
|
|
90
|
+
/**
|
|
91
|
+
* The ID of the account whose cash balance this object represents.
|
|
92
|
+
*/
|
|
93
|
+
customerAccount: string;
|
|
94
|
+
/**
|
|
95
|
+
* Settings controlling the behavior of the customer's cash balance, such as reconciliation of funds received.
|
|
96
|
+
*/
|
|
97
|
+
settings?: outputs.CustomerCashBalanceSettings;
|
|
98
|
+
}
|
|
99
|
+
export interface CustomerCashBalanceSettings {
|
|
100
|
+
/**
|
|
101
|
+
* Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchantDefault`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
|
|
102
|
+
*/
|
|
103
|
+
reconciliationMode?: string;
|
|
104
|
+
}
|
|
105
|
+
export interface CustomerInvoiceSettings {
|
|
106
|
+
customFields?: any[][];
|
|
107
|
+
/**
|
|
108
|
+
* ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
|
|
109
|
+
*/
|
|
110
|
+
defaultPaymentMethod?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Default footer to be displayed on invoices for this customer.
|
|
113
|
+
*/
|
|
114
|
+
footer?: string;
|
|
115
|
+
renderingOptions?: outputs.CustomerInvoiceSettingsRenderingOptions;
|
|
116
|
+
}
|
|
117
|
+
export interface CustomerInvoiceSettingsRenderingOptions {
|
|
118
|
+
/**
|
|
119
|
+
* How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `excludeTax` or `includeInclusiveTax`. `includeInclusiveTax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `excludeTax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
|
|
120
|
+
*/
|
|
121
|
+
amountTaxDisplay?: string;
|
|
122
|
+
/**
|
|
123
|
+
* ID of the invoice rendering template to use for future invoices.
|
|
124
|
+
*/
|
|
125
|
+
template?: string;
|
|
126
|
+
}
|
|
127
|
+
export interface CustomerShipping {
|
|
128
|
+
/**
|
|
129
|
+
* Customer shipping address.
|
|
130
|
+
*/
|
|
131
|
+
address: outputs.CustomerShippingAddress;
|
|
132
|
+
/**
|
|
133
|
+
* The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
|
|
134
|
+
*/
|
|
135
|
+
carrier: string;
|
|
136
|
+
/**
|
|
137
|
+
* Customer name.
|
|
138
|
+
*/
|
|
139
|
+
name: string;
|
|
140
|
+
/**
|
|
141
|
+
* Customer phone (including extension).
|
|
142
|
+
*/
|
|
143
|
+
phone?: string;
|
|
144
|
+
/**
|
|
145
|
+
* The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
|
|
146
|
+
*/
|
|
147
|
+
trackingNumber: string;
|
|
148
|
+
}
|
|
149
|
+
export interface CustomerShippingAddress {
|
|
150
|
+
/**
|
|
151
|
+
* City, district, suburb, town, or village.
|
|
152
|
+
*/
|
|
153
|
+
city?: string;
|
|
154
|
+
/**
|
|
155
|
+
* A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
156
|
+
*/
|
|
157
|
+
country?: string;
|
|
158
|
+
/**
|
|
159
|
+
* Address line 1, such as the street, PO Box, or company name.
|
|
160
|
+
*/
|
|
161
|
+
line1?: string;
|
|
162
|
+
/**
|
|
163
|
+
* Address line 2, such as the apartment, suite, unit, or building.
|
|
164
|
+
*/
|
|
165
|
+
line2?: string;
|
|
166
|
+
/**
|
|
167
|
+
* ZIP or postal code.
|
|
168
|
+
*/
|
|
169
|
+
postalCode?: string;
|
|
170
|
+
/**
|
|
171
|
+
* State, county, province, or region.
|
|
172
|
+
*/
|
|
173
|
+
state?: string;
|
|
174
|
+
}
|
|
175
|
+
export interface CustomerTax {
|
|
176
|
+
/**
|
|
177
|
+
* Surfaces if automatic tax computation is possible given the current customer location information.
|
|
178
|
+
*/
|
|
179
|
+
automaticTax: string;
|
|
180
|
+
ipAddress?: string;
|
|
181
|
+
/**
|
|
182
|
+
* The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](https://www.terraform.io/tax/third-party-apps).
|
|
183
|
+
*/
|
|
184
|
+
provider: string;
|
|
185
|
+
/**
|
|
186
|
+
* A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.
|
|
187
|
+
*/
|
|
188
|
+
validateLocation?: string;
|
|
189
|
+
}
|
|
190
|
+
export interface CustomerTaxIdData {
|
|
191
|
+
/**
|
|
192
|
+
* Type of the tax ID, one of `adNrt`, `aeTrn`, `alTin`, `amTin`, `aoTin`, `arCuit`, `auAbn`, `auArn`, `awTin`, `azTin`, `baTin`, `bbTin`, `bdBin`, `bfIfu`, `bgUic`, `bhVat`, `bjIfu`, `boTin`, `brCnpj`, `brCpf`, `bsTin`, `byTin`, `caBn`, `caGstHst`, `caPstBc`, `caPstMb`, `caPstSk`, `caQst`, `cdNif`, `chUid`, `chVat`, `clTin`, `cmNiu`, `cnTin`, `coNit`, `crTin`, `cvNif`, `deStn`, `doRcn`, `ecRuc`, `egTin`, `esCif`, `etTin`, `euOssVat`, `euVat`, `gbVat`, `geVat`, `gnNif`, `hkBr`, `hrOib`, `huTin`, `idNpwp`, `ilVat`, `inGst`, `isVat`, `jpCn`, `jpRn`, `jpTrn`, `kePin`, `kgTin`, `khTin`, `krBrn`, `kzBin`, `laTin`, `liUid`, `liVat`, `maVat`, `mdVat`, `mePib`, `mkVat`, `mrNif`, `mxRfc`, `myFrp`, `myItn`, `mySst`, `ngTin`, `noVat`, `noVoec`, `npPan`, `nzGst`, `omVat`, `peRuc`, `phTin`, `roTin`, `rsPib`, `ruInn`, `ruKpp`, `saVat`, `sgGst`, `sgUen`, `siTin`, `snNinea`, `srFin`, `svNit`, `thVat`, `tjTin`, `trTin`, `twVat`, `tzVat`, `uaVat`, `ugTin`, `usEin`, `uyRuc`, `uzTin`, `uzVat`, `veRif`, `vnTin`, `zaVat`, `zmTin`, or `zwTin`
|
|
193
|
+
*/
|
|
194
|
+
type: string;
|
|
195
|
+
/**
|
|
196
|
+
* Value of the tax ID.
|
|
197
|
+
*/
|
|
198
|
+
value: string;
|
|
199
|
+
}
|
|
200
|
+
export interface PriceCurrencyOption {
|
|
201
|
+
/**
|
|
202
|
+
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
203
|
+
*/
|
|
204
|
+
customUnitAmount?: outputs.PriceCurrencyOptionCustomUnitAmount;
|
|
205
|
+
key: string;
|
|
206
|
+
/**
|
|
207
|
+
* Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
208
|
+
*/
|
|
209
|
+
taxBehavior?: string;
|
|
210
|
+
/**
|
|
211
|
+
* Each element represents a pricing tier. This parameter requires `billingScheme` to be set to `tiered`. See also the documentation for `billingScheme`.
|
|
212
|
+
*/
|
|
213
|
+
tiers?: any[][];
|
|
214
|
+
/**
|
|
215
|
+
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
216
|
+
*/
|
|
217
|
+
unitAmount?: number;
|
|
218
|
+
}
|
|
219
|
+
export interface PriceCurrencyOptionCustomUnitAmount {
|
|
220
|
+
/**
|
|
221
|
+
* Pass in `true` to enable `customUnitAmount`, otherwise omit `customUnitAmount`.
|
|
222
|
+
*/
|
|
223
|
+
enabled: boolean;
|
|
224
|
+
/**
|
|
225
|
+
* The maximum unit amount the customer can specify for this item.
|
|
226
|
+
*/
|
|
227
|
+
maximum?: number;
|
|
228
|
+
/**
|
|
229
|
+
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
|
230
|
+
*/
|
|
231
|
+
minimum?: number;
|
|
232
|
+
/**
|
|
233
|
+
* The starting unit amount which can be updated by the customer.
|
|
234
|
+
*/
|
|
235
|
+
preset?: number;
|
|
236
|
+
}
|
|
237
|
+
export interface PriceCustomUnitAmount {
|
|
238
|
+
/**
|
|
239
|
+
* The maximum unit amount the customer can specify for this item.
|
|
240
|
+
*/
|
|
241
|
+
maximum: number;
|
|
242
|
+
/**
|
|
243
|
+
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
|
244
|
+
*/
|
|
245
|
+
minimum: number;
|
|
246
|
+
/**
|
|
247
|
+
* The starting unit amount which can be updated by the customer.
|
|
248
|
+
*/
|
|
249
|
+
preset: number;
|
|
250
|
+
}
|
|
251
|
+
export interface PriceProductData {
|
|
252
|
+
/**
|
|
253
|
+
* Whether the product is currently available for purchase. Defaults to `true`.
|
|
254
|
+
*/
|
|
255
|
+
active: boolean;
|
|
256
|
+
/**
|
|
257
|
+
* The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
|
|
258
|
+
*/
|
|
259
|
+
id: string;
|
|
260
|
+
/**
|
|
261
|
+
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
262
|
+
*/
|
|
263
|
+
metadata: {
|
|
264
|
+
[key: string]: string;
|
|
265
|
+
};
|
|
266
|
+
/**
|
|
267
|
+
* The product's name, meant to be displayable to the customer.
|
|
268
|
+
*/
|
|
269
|
+
name: string;
|
|
270
|
+
/**
|
|
271
|
+
* An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
|
|
272
|
+
*/
|
|
273
|
+
statementDescriptor: string;
|
|
274
|
+
/**
|
|
275
|
+
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
|
276
|
+
*/
|
|
277
|
+
taxCode: string;
|
|
278
|
+
/**
|
|
279
|
+
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
280
|
+
*/
|
|
281
|
+
unitLabel: string;
|
|
282
|
+
}
|
|
283
|
+
export interface PriceRecurring {
|
|
284
|
+
/**
|
|
285
|
+
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
286
|
+
*/
|
|
287
|
+
interval: string;
|
|
288
|
+
/**
|
|
289
|
+
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
|
290
|
+
*/
|
|
291
|
+
intervalCount: number;
|
|
292
|
+
/**
|
|
293
|
+
* The meter tracking the usage of a metered price
|
|
294
|
+
*/
|
|
295
|
+
meter: string;
|
|
296
|
+
/**
|
|
297
|
+
* Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
|
|
298
|
+
*/
|
|
299
|
+
trialPeriodDays: number;
|
|
300
|
+
/**
|
|
301
|
+
* Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
|
|
302
|
+
*/
|
|
303
|
+
usageType: string;
|
|
304
|
+
}
|
|
305
|
+
export interface PriceTier {
|
|
306
|
+
/**
|
|
307
|
+
* The flat billing amount for an entire tier, regardless of the number of units in the tier.
|
|
308
|
+
*/
|
|
309
|
+
flatAmount?: number;
|
|
310
|
+
/**
|
|
311
|
+
* Same as `flatAmount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flatAmount` and `flatAmountDecimal` can be set.
|
|
312
|
+
*/
|
|
313
|
+
flatAmountDecimal?: string;
|
|
314
|
+
/**
|
|
315
|
+
* The per unit billing amount for each individual unit for which this tier applies.
|
|
316
|
+
*/
|
|
317
|
+
unitAmount?: number;
|
|
318
|
+
upTo: string;
|
|
319
|
+
}
|
|
320
|
+
export interface ProductDefaultPriceData {
|
|
321
|
+
/**
|
|
322
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
323
|
+
*/
|
|
324
|
+
currency: string;
|
|
325
|
+
/**
|
|
326
|
+
* Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
|
327
|
+
*/
|
|
328
|
+
currencyOptions: outputs.ProductDefaultPriceDataCurrencyOption[];
|
|
329
|
+
/**
|
|
330
|
+
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
331
|
+
*/
|
|
332
|
+
customUnitAmount?: outputs.ProductDefaultPriceDataCustomUnitAmount;
|
|
333
|
+
/**
|
|
334
|
+
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
335
|
+
*/
|
|
336
|
+
metadata: {
|
|
337
|
+
[key: string]: string;
|
|
338
|
+
};
|
|
339
|
+
/**
|
|
340
|
+
* The recurring components of a price such as `interval` and `intervalCount`.
|
|
341
|
+
*/
|
|
342
|
+
recurring?: outputs.ProductDefaultPriceDataRecurring;
|
|
343
|
+
/**
|
|
344
|
+
* Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
345
|
+
*/
|
|
346
|
+
taxBehavior: string;
|
|
347
|
+
/**
|
|
348
|
+
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unitAmount`, `unitAmountDecimal`, or `customUnitAmount` is required.
|
|
349
|
+
*/
|
|
350
|
+
unitAmount: number;
|
|
351
|
+
}
|
|
352
|
+
export interface ProductDefaultPriceDataCurrencyOption {
|
|
353
|
+
/**
|
|
354
|
+
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
355
|
+
*/
|
|
356
|
+
customUnitAmount?: outputs.ProductDefaultPriceDataCurrencyOptionCustomUnitAmount;
|
|
357
|
+
key: string;
|
|
358
|
+
/**
|
|
359
|
+
* Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
360
|
+
*/
|
|
361
|
+
taxBehavior: string;
|
|
362
|
+
/**
|
|
363
|
+
* Each element represents a pricing tier. This parameter requires `billingScheme` to be set to `tiered`. See also the documentation for `billingScheme`.
|
|
364
|
+
*/
|
|
365
|
+
tiers: any[][];
|
|
366
|
+
/**
|
|
367
|
+
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
368
|
+
*/
|
|
369
|
+
unitAmount: number;
|
|
370
|
+
}
|
|
371
|
+
export interface ProductDefaultPriceDataCurrencyOptionCustomUnitAmount {
|
|
372
|
+
/**
|
|
373
|
+
* Pass in `true` to enable `customUnitAmount`, otherwise omit `customUnitAmount`.
|
|
374
|
+
*/
|
|
375
|
+
enabled: boolean;
|
|
376
|
+
/**
|
|
377
|
+
* The maximum unit amount the customer can specify for this item.
|
|
378
|
+
*/
|
|
379
|
+
maximum?: number;
|
|
380
|
+
/**
|
|
381
|
+
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
|
382
|
+
*/
|
|
383
|
+
minimum?: number;
|
|
384
|
+
/**
|
|
385
|
+
* The starting unit amount which can be updated by the customer.
|
|
386
|
+
*/
|
|
387
|
+
preset?: number;
|
|
388
|
+
}
|
|
389
|
+
export interface ProductDefaultPriceDataCustomUnitAmount {
|
|
390
|
+
/**
|
|
391
|
+
* Pass in `true` to enable `customUnitAmount`, otherwise omit `customUnitAmount`.
|
|
392
|
+
*/
|
|
393
|
+
enabled: boolean;
|
|
394
|
+
/**
|
|
395
|
+
* The maximum unit amount the customer can specify for this item.
|
|
396
|
+
*/
|
|
397
|
+
maximum?: number;
|
|
398
|
+
/**
|
|
399
|
+
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
|
400
|
+
*/
|
|
401
|
+
minimum?: number;
|
|
402
|
+
/**
|
|
403
|
+
* The starting unit amount which can be updated by the customer.
|
|
404
|
+
*/
|
|
405
|
+
preset?: number;
|
|
406
|
+
}
|
|
407
|
+
export interface ProductDefaultPriceDataRecurring {
|
|
408
|
+
/**
|
|
409
|
+
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
410
|
+
*/
|
|
411
|
+
interval: string;
|
|
412
|
+
/**
|
|
413
|
+
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
|
414
|
+
*/
|
|
415
|
+
intervalCount?: number;
|
|
416
|
+
}
|
|
417
|
+
export interface ProductMarketingFeature {
|
|
418
|
+
/**
|
|
419
|
+
* The marketing feature name. Up to 80 characters long.
|
|
420
|
+
*/
|
|
421
|
+
name: string;
|
|
422
|
+
}
|
|
423
|
+
export interface ProductPackageDimensions {
|
|
424
|
+
/**
|
|
425
|
+
* Height, in inches. Maximum precision is 2 decimal places.
|
|
426
|
+
*/
|
|
427
|
+
height: number;
|
|
428
|
+
/**
|
|
429
|
+
* Length, in inches. Maximum precision is 2 decimal places.
|
|
430
|
+
*/
|
|
431
|
+
length: number;
|
|
432
|
+
/**
|
|
433
|
+
* Weight, in ounces. Maximum precision is 2 decimal places.
|
|
434
|
+
*/
|
|
435
|
+
weight: number;
|
|
436
|
+
/**
|
|
437
|
+
* Width, in inches. Maximum precision is 2 decimal places.
|
|
438
|
+
*/
|
|
439
|
+
width: number;
|
|
440
|
+
}
|
|
441
|
+
export interface PromotionCodePromotion {
|
|
442
|
+
/**
|
|
443
|
+
* If promotion `type` is `coupon`, the coupon for this promotion code.
|
|
444
|
+
*/
|
|
445
|
+
coupon: string;
|
|
446
|
+
/**
|
|
447
|
+
* Specifies the type of promotion.
|
|
448
|
+
*/
|
|
449
|
+
type: string;
|
|
450
|
+
}
|
|
451
|
+
export interface PromotionCodeRestrictions {
|
|
452
|
+
/**
|
|
453
|
+
* Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
|
454
|
+
*/
|
|
455
|
+
currencyOptions?: outputs.PromotionCodeRestrictionsCurrencyOption[];
|
|
456
|
+
/**
|
|
457
|
+
* A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
|
|
458
|
+
*/
|
|
459
|
+
firstTimeTransaction: boolean;
|
|
460
|
+
/**
|
|
461
|
+
* Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
|
|
462
|
+
*/
|
|
463
|
+
minimumAmount: number;
|
|
464
|
+
/**
|
|
465
|
+
* Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
|
|
466
|
+
*/
|
|
467
|
+
minimumAmountCurrency: string;
|
|
468
|
+
}
|
|
469
|
+
export interface PromotionCodeRestrictionsCurrencyOption {
|
|
470
|
+
key: string;
|
|
471
|
+
/**
|
|
472
|
+
* Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
|
|
473
|
+
*/
|
|
474
|
+
minimumAmount?: number;
|
|
475
|
+
}
|
|
476
|
+
export interface ShippingRateDeliveryEstimate {
|
|
477
|
+
/**
|
|
478
|
+
* The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
|
|
479
|
+
*/
|
|
480
|
+
maximum?: outputs.ShippingRateDeliveryEstimateMaximum;
|
|
481
|
+
/**
|
|
482
|
+
* The lower bound of the estimated range. If empty, represents no lower bound.
|
|
483
|
+
*/
|
|
484
|
+
minimum?: outputs.ShippingRateDeliveryEstimateMinimum;
|
|
485
|
+
}
|
|
486
|
+
export interface ShippingRateDeliveryEstimateMaximum {
|
|
487
|
+
/**
|
|
488
|
+
* A unit of time.
|
|
489
|
+
*/
|
|
490
|
+
unit: string;
|
|
491
|
+
/**
|
|
492
|
+
* Must be greater than 0.
|
|
493
|
+
*/
|
|
494
|
+
value: number;
|
|
495
|
+
}
|
|
496
|
+
export interface ShippingRateDeliveryEstimateMinimum {
|
|
497
|
+
/**
|
|
498
|
+
* A unit of time.
|
|
499
|
+
*/
|
|
500
|
+
unit: string;
|
|
501
|
+
/**
|
|
502
|
+
* Must be greater than 0.
|
|
503
|
+
*/
|
|
504
|
+
value: number;
|
|
505
|
+
}
|
|
506
|
+
export interface ShippingRateFixedAmount {
|
|
507
|
+
/**
|
|
508
|
+
* A non-negative integer in cents representing how much to charge.
|
|
509
|
+
*/
|
|
510
|
+
amount: number;
|
|
511
|
+
/**
|
|
512
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
513
|
+
*/
|
|
514
|
+
currency: string;
|
|
515
|
+
/**
|
|
516
|
+
* Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
|
517
|
+
*/
|
|
518
|
+
currencyOptions?: outputs.ShippingRateFixedAmountCurrencyOption[];
|
|
519
|
+
}
|
|
520
|
+
export interface ShippingRateFixedAmountCurrencyOption {
|
|
521
|
+
/**
|
|
522
|
+
* A non-negative integer in cents representing how much to charge.
|
|
523
|
+
*/
|
|
524
|
+
amount: number;
|
|
525
|
+
key: string;
|
|
526
|
+
/**
|
|
527
|
+
* Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
|
528
|
+
*/
|
|
529
|
+
taxBehavior?: string;
|
|
530
|
+
}
|
|
531
|
+
export interface V2BillingLicenseFeeTier {
|
|
532
|
+
/**
|
|
533
|
+
* Price for the entire tier, represented as a decimal string in minor currency units with at most 12 decimal places.
|
|
534
|
+
*/
|
|
535
|
+
flatAmount?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Per-unit price for units included in this tier, represented as a decimal string in minor currency units with at most 12 decimal places.
|
|
538
|
+
*/
|
|
539
|
+
unitAmount?: string;
|
|
540
|
+
/**
|
|
541
|
+
* Up to and including this quantity will be contained in the tier. Only one of `upToDecimal` and `upToInf` may be set.
|
|
542
|
+
*/
|
|
543
|
+
upToDecimal?: string;
|
|
544
|
+
/**
|
|
545
|
+
* No upper bound to this tier. Only one of `upToDecimal` and `upToInf` may be set.
|
|
546
|
+
*/
|
|
547
|
+
upToInf?: string;
|
|
548
|
+
}
|
|
549
|
+
export interface V2BillingMeteredItemMeterSegmentCondition {
|
|
550
|
+
/**
|
|
551
|
+
* A Meter dimension.
|
|
552
|
+
*/
|
|
553
|
+
dimension: string;
|
|
554
|
+
/**
|
|
555
|
+
* To count usage towards this metered item, the dimension must have this value.
|
|
556
|
+
*/
|
|
557
|
+
value: string;
|
|
558
|
+
}
|
|
559
|
+
export interface V2BillingPricingPlanComponentLicenseFee {
|
|
560
|
+
/**
|
|
561
|
+
* The ID of the License Fee.
|
|
562
|
+
*/
|
|
563
|
+
id: string;
|
|
564
|
+
/**
|
|
565
|
+
* The version of the LicenseFee. Defaults to 'latest', if not specified.
|
|
566
|
+
*/
|
|
567
|
+
version: string;
|
|
568
|
+
}
|
|
569
|
+
export interface V2BillingPricingPlanComponentRateCard {
|
|
570
|
+
/**
|
|
571
|
+
* The ID of the Rate Card.
|
|
572
|
+
*/
|
|
573
|
+
id: string;
|
|
574
|
+
/**
|
|
575
|
+
* The version of the RateCard. Defaults to 'latest', if not specified.
|
|
576
|
+
*/
|
|
577
|
+
version: string;
|
|
578
|
+
}
|
|
579
|
+
export interface V2BillingPricingPlanComponentServiceAction {
|
|
580
|
+
/**
|
|
581
|
+
* The ID of the service action.
|
|
582
|
+
*/
|
|
583
|
+
id: string;
|
|
584
|
+
}
|
|
585
|
+
export interface V2BillingRateCardRateTier {
|
|
586
|
+
/**
|
|
587
|
+
* Price for the entire tier, represented as a decimal string in minor currency units with at most 12 decimal places.
|
|
588
|
+
*/
|
|
589
|
+
flatAmount?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Per-unit price for units included in this tier, represented as a decimal string in minor currency units with at most 12 decimal places.
|
|
592
|
+
*/
|
|
593
|
+
unitAmount?: string;
|
|
594
|
+
/**
|
|
595
|
+
* Up to and including this quantity will be contained in the tier. Only one of `upToDecimal` and `upToInf` may be set.
|
|
596
|
+
*/
|
|
597
|
+
upToDecimal?: string;
|
|
598
|
+
/**
|
|
599
|
+
* No upper bound to this tier. Only one of `upToDecimal` and `upToInf` may be set.
|
|
600
|
+
*/
|
|
601
|
+
upToInf?: string;
|
|
602
|
+
}
|
|
603
|
+
export interface V2BillingServiceActionCreditGrant {
|
|
604
|
+
/**
|
|
605
|
+
* The amount of the credit grant.
|
|
606
|
+
*/
|
|
607
|
+
amount: outputs.V2BillingServiceActionCreditGrantAmount;
|
|
608
|
+
/**
|
|
609
|
+
* Defines the scope where the credit grant is applicable.
|
|
610
|
+
*/
|
|
611
|
+
applicabilityConfig: outputs.V2BillingServiceActionCreditGrantApplicabilityConfig;
|
|
612
|
+
/**
|
|
613
|
+
* The category of the credit grant.
|
|
614
|
+
*/
|
|
615
|
+
category: string;
|
|
616
|
+
/**
|
|
617
|
+
* The expiry configuration for the credit grant.
|
|
618
|
+
*/
|
|
619
|
+
expiryConfig: outputs.V2BillingServiceActionCreditGrantExpiryConfig;
|
|
620
|
+
/**
|
|
621
|
+
* A descriptive name shown in dashboard.
|
|
622
|
+
*/
|
|
623
|
+
name: string;
|
|
624
|
+
/**
|
|
625
|
+
* The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
|
|
626
|
+
*/
|
|
627
|
+
priority: number;
|
|
628
|
+
}
|
|
629
|
+
export interface V2BillingServiceActionCreditGrantAmount {
|
|
630
|
+
/**
|
|
631
|
+
* The custom pricing unit amount of the credit grant. Required if `type` is `customPricingUnit`.
|
|
632
|
+
*/
|
|
633
|
+
customPricingUnit?: outputs.V2BillingServiceActionCreditGrantAmountCustomPricingUnit;
|
|
634
|
+
/**
|
|
635
|
+
* The monetary amount of the credit grant. Required if `type` is `monetary`.
|
|
636
|
+
*/
|
|
637
|
+
monetary?: outputs.V2BillingServiceActionCreditGrantAmountMonetary;
|
|
638
|
+
/**
|
|
639
|
+
* The type of the credit grant amount. We currently support `monetary` and `customPricingUnit` billing credits.
|
|
640
|
+
*/
|
|
641
|
+
type: string;
|
|
642
|
+
}
|
|
643
|
+
export interface V2BillingServiceActionCreditGrantAmountCustomPricingUnit {
|
|
644
|
+
/**
|
|
645
|
+
* The id of the custom pricing unit.
|
|
646
|
+
*/
|
|
647
|
+
id: string;
|
|
648
|
+
/**
|
|
649
|
+
* The value of the credit grant, decimal value represented as a string.
|
|
650
|
+
*/
|
|
651
|
+
value: string;
|
|
652
|
+
}
|
|
653
|
+
export interface V2BillingServiceActionCreditGrantAmountMonetary {
|
|
654
|
+
/**
|
|
655
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
656
|
+
*/
|
|
657
|
+
currency: string;
|
|
658
|
+
/**
|
|
659
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
|
|
660
|
+
*/
|
|
661
|
+
value: number;
|
|
662
|
+
}
|
|
663
|
+
export interface V2BillingServiceActionCreditGrantApplicabilityConfig {
|
|
664
|
+
/**
|
|
665
|
+
* The applicability scope of the credit grant.
|
|
666
|
+
*/
|
|
667
|
+
scope: outputs.V2BillingServiceActionCreditGrantApplicabilityConfigScope;
|
|
668
|
+
}
|
|
669
|
+
export interface V2BillingServiceActionCreditGrantApplicabilityConfigScope {
|
|
670
|
+
/**
|
|
671
|
+
* The billable items to apply the credit grant to.
|
|
672
|
+
*/
|
|
673
|
+
billableItems?: string[];
|
|
674
|
+
/**
|
|
675
|
+
* The price type that credit grants can apply to. We currently only support the `metered` price type. This will apply to metered prices and rate cards. Cannot be used in combination with `billableItems`.
|
|
676
|
+
*/
|
|
677
|
+
priceType?: string;
|
|
678
|
+
}
|
|
679
|
+
export interface V2BillingServiceActionCreditGrantExpiryConfig {
|
|
680
|
+
/**
|
|
681
|
+
* The type of the expiry configuration. We currently support `endOfServicePeriod`.
|
|
682
|
+
*/
|
|
683
|
+
type: string;
|
|
684
|
+
}
|
|
685
|
+
export interface V2CoreEventDestinationAmazonEventbridge {
|
|
686
|
+
/**
|
|
687
|
+
* The AWS account ID.
|
|
688
|
+
*/
|
|
689
|
+
awsAccountId: string;
|
|
690
|
+
/**
|
|
691
|
+
* The ARN of the AWS event source.
|
|
692
|
+
*/
|
|
693
|
+
awsEventSourceArn: string;
|
|
694
|
+
/**
|
|
695
|
+
* The state of the AWS event source.
|
|
696
|
+
*/
|
|
697
|
+
awsEventSourceStatus: string;
|
|
698
|
+
/**
|
|
699
|
+
* The region of the AWS event source.
|
|
700
|
+
*/
|
|
701
|
+
awsRegion: string;
|
|
702
|
+
}
|
|
703
|
+
export interface V2CoreEventDestinationWebhookEndpoint {
|
|
704
|
+
/**
|
|
705
|
+
* The signing secret of the webhook endpoint, only includable on creation.
|
|
706
|
+
*/
|
|
707
|
+
signingSecret: string;
|
|
708
|
+
/**
|
|
709
|
+
* The URL of the webhook endpoint.
|
|
710
|
+
*/
|
|
711
|
+
url: string;
|
|
712
|
+
}
|