@tennac-booking/sdk 1.0.132 → 1.0.133
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/.openapi-generator/FILES +337 -362
- package/README.md +3 -28
- package/api.ts +150 -1296
- package/dist/api.d.ts +141 -1243
- package/dist/api.js +18 -127
- package/dist/esm/api.d.ts +141 -1243
- package/dist/esm/api.js +14 -123
- package/docs/SubscriptionPlanDiscountUpdateRequest.md +36 -0
- package/docs/{UpdatePlanRequest.md → SubscriptionPlanDiscountUpdateRequestValidFrom.md} +3 -7
- package/docs/SubscriptionPlanResponse.md +2 -0
- package/docs/SubscriptionsManagerApi.md +7 -7
- package/docs/UpdateSubscriptionPlanRequest.md +34 -0
- package/package.json +1 -1
- package/docs/StripeStripeDeletedProduct.md +0 -25
- package/docs/StripeStripePrice.md +0 -63
- package/docs/StripeStripePriceBillingScheme.md +0 -10
- package/docs/StripeStripePriceCurrencyOptions.md +0 -28
- package/docs/StripeStripePriceCurrencyOptionsCustomUnitAmount.md +0 -24
- package/docs/StripeStripePriceCurrencyOptionsTaxBehavior.md +0 -12
- package/docs/StripeStripePriceCurrencyOptionsTier.md +0 -28
- package/docs/StripeStripePriceCustomUnitAmount.md +0 -24
- package/docs/StripeStripePriceProduct.md +0 -59
- package/docs/StripeStripePriceRecurring.md +0 -28
- package/docs/StripeStripePriceRecurringInterval.md +0 -14
- package/docs/StripeStripePriceRecurringUsageType.md +0 -10
- package/docs/StripeStripePriceTaxBehavior.md +0 -12
- package/docs/StripeStripePriceTier.md +0 -28
- package/docs/StripeStripePriceTiersMode.md +0 -10
- package/docs/StripeStripePriceTransformQuantity.md +0 -22
- package/docs/StripeStripePriceTransformQuantityRound.md +0 -10
- package/docs/StripeStripePriceType.md +0 -10
- package/docs/StripeStripeProduct.md +0 -59
- package/docs/StripeStripeProductDefaultPrice.md +0 -63
- package/docs/StripeStripeProductMarketingFeature.md +0 -20
- package/docs/StripeStripeProductPackageDimensions.md +0 -26
- package/docs/StripeStripeProductTaxCode.md +0 -27
- package/docs/StripeStripeProductType.md +0 -10
- package/docs/StripeStripeResponseStripeStripePrice.md +0 -64
- package/docs/StripeStripeResponseStripeStripePriceAllOfLastResponse.md +0 -30
- package/docs/StripeStripeTaxCode.md +0 -27
package/api.ts
CHANGED
|
@@ -9151,1266 +9151,6 @@ export interface StaffUserProfileResponse {
|
|
|
9151
9151
|
}
|
|
9152
9152
|
|
|
9153
9153
|
|
|
9154
|
-
/**
|
|
9155
|
-
* The DeletedProduct object.
|
|
9156
|
-
* @export
|
|
9157
|
-
* @interface StripeStripeDeletedProduct
|
|
9158
|
-
*/
|
|
9159
|
-
export interface StripeStripeDeletedProduct {
|
|
9160
|
-
/**
|
|
9161
|
-
* Unique identifier for the object.
|
|
9162
|
-
* @type {string}
|
|
9163
|
-
* @memberof StripeStripeDeletedProduct
|
|
9164
|
-
*/
|
|
9165
|
-
'id': string;
|
|
9166
|
-
/**
|
|
9167
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
9168
|
-
* @type {string}
|
|
9169
|
-
* @memberof StripeStripeDeletedProduct
|
|
9170
|
-
*/
|
|
9171
|
-
'object': StripeStripeDeletedProductObjectEnum;
|
|
9172
|
-
/**
|
|
9173
|
-
* Always true for a deleted object
|
|
9174
|
-
* @type {boolean}
|
|
9175
|
-
* @memberof StripeStripeDeletedProduct
|
|
9176
|
-
*/
|
|
9177
|
-
'deleted': boolean;
|
|
9178
|
-
}
|
|
9179
|
-
|
|
9180
|
-
export const StripeStripeDeletedProductObjectEnum = {
|
|
9181
|
-
Product: 'product'
|
|
9182
|
-
} as const;
|
|
9183
|
-
|
|
9184
|
-
export type StripeStripeDeletedProductObjectEnum = typeof StripeStripeDeletedProductObjectEnum[keyof typeof StripeStripeDeletedProductObjectEnum];
|
|
9185
|
-
|
|
9186
|
-
/**
|
|
9187
|
-
* Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
|
|
9188
|
-
* @export
|
|
9189
|
-
* @interface StripeStripePrice
|
|
9190
|
-
*/
|
|
9191
|
-
export interface StripeStripePrice {
|
|
9192
|
-
/**
|
|
9193
|
-
* Unique identifier for the object.
|
|
9194
|
-
* @type {string}
|
|
9195
|
-
* @memberof StripeStripePrice
|
|
9196
|
-
*/
|
|
9197
|
-
'id': string;
|
|
9198
|
-
/**
|
|
9199
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
9200
|
-
* @type {string}
|
|
9201
|
-
* @memberof StripeStripePrice
|
|
9202
|
-
*/
|
|
9203
|
-
'object': StripeStripePriceObjectEnum;
|
|
9204
|
-
/**
|
|
9205
|
-
* Whether the price can be used for new purchases.
|
|
9206
|
-
* @type {boolean}
|
|
9207
|
-
* @memberof StripeStripePrice
|
|
9208
|
-
*/
|
|
9209
|
-
'active': boolean;
|
|
9210
|
-
/**
|
|
9211
|
-
*
|
|
9212
|
-
* @type {StripeStripePriceBillingScheme}
|
|
9213
|
-
* @memberof StripeStripePrice
|
|
9214
|
-
*/
|
|
9215
|
-
'billing_scheme': StripeStripePriceBillingScheme;
|
|
9216
|
-
/**
|
|
9217
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
9218
|
-
* @type {number}
|
|
9219
|
-
* @memberof StripeStripePrice
|
|
9220
|
-
*/
|
|
9221
|
-
'created': number;
|
|
9222
|
-
/**
|
|
9223
|
-
* 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).
|
|
9224
|
-
* @type {string}
|
|
9225
|
-
* @memberof StripeStripePrice
|
|
9226
|
-
*/
|
|
9227
|
-
'currency': string;
|
|
9228
|
-
/**
|
|
9229
|
-
* 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).
|
|
9230
|
-
* @type {{ [key: string]: StripeStripePriceCurrencyOptions; }}
|
|
9231
|
-
* @memberof StripeStripePrice
|
|
9232
|
-
*/
|
|
9233
|
-
'currency_options'?: { [key: string]: StripeStripePriceCurrencyOptions; };
|
|
9234
|
-
/**
|
|
9235
|
-
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
9236
|
-
* @type {StripeStripePriceCustomUnitAmount}
|
|
9237
|
-
* @memberof StripeStripePrice
|
|
9238
|
-
*/
|
|
9239
|
-
'custom_unit_amount': StripeStripePriceCustomUnitAmount | null;
|
|
9240
|
-
/**
|
|
9241
|
-
* Always true for a deleted object
|
|
9242
|
-
* @type {any}
|
|
9243
|
-
* @memberof StripeStripePrice
|
|
9244
|
-
*/
|
|
9245
|
-
'deleted'?: any;
|
|
9246
|
-
/**
|
|
9247
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
9248
|
-
* @type {boolean}
|
|
9249
|
-
* @memberof StripeStripePrice
|
|
9250
|
-
*/
|
|
9251
|
-
'livemode': boolean;
|
|
9252
|
-
/**
|
|
9253
|
-
* A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
|
9254
|
-
* @type {string}
|
|
9255
|
-
* @memberof StripeStripePrice
|
|
9256
|
-
*/
|
|
9257
|
-
'lookup_key': string | null;
|
|
9258
|
-
/**
|
|
9259
|
-
* Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
9260
|
-
* @type {{ [key: string]: string; }}
|
|
9261
|
-
* @memberof StripeStripePrice
|
|
9262
|
-
*/
|
|
9263
|
-
'metadata': { [key: string]: string; };
|
|
9264
|
-
/**
|
|
9265
|
-
* A brief description of the price, hidden from customers.
|
|
9266
|
-
* @type {string}
|
|
9267
|
-
* @memberof StripeStripePrice
|
|
9268
|
-
*/
|
|
9269
|
-
'nickname': string | null;
|
|
9270
|
-
/**
|
|
9271
|
-
*
|
|
9272
|
-
* @type {StripeStripePriceProduct}
|
|
9273
|
-
* @memberof StripeStripePrice
|
|
9274
|
-
*/
|
|
9275
|
-
'product': StripeStripePriceProduct;
|
|
9276
|
-
/**
|
|
9277
|
-
* The recurring components of a price such as `interval` and `usage_type`.
|
|
9278
|
-
* @type {StripeStripePriceRecurring}
|
|
9279
|
-
* @memberof StripeStripePrice
|
|
9280
|
-
*/
|
|
9281
|
-
'recurring': StripeStripePriceRecurring | null;
|
|
9282
|
-
/**
|
|
9283
|
-
* 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.
|
|
9284
|
-
* @type {StripeStripePriceTaxBehavior}
|
|
9285
|
-
* @memberof StripeStripePrice
|
|
9286
|
-
*/
|
|
9287
|
-
'tax_behavior': StripeStripePriceTaxBehavior | null;
|
|
9288
|
-
/**
|
|
9289
|
-
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
9290
|
-
* @type {Array<StripeStripePriceTier>}
|
|
9291
|
-
* @memberof StripeStripePrice
|
|
9292
|
-
*/
|
|
9293
|
-
'tiers'?: Array<StripeStripePriceTier>;
|
|
9294
|
-
/**
|
|
9295
|
-
* Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
|
|
9296
|
-
* @type {StripeStripePriceTiersMode}
|
|
9297
|
-
* @memberof StripeStripePrice
|
|
9298
|
-
*/
|
|
9299
|
-
'tiers_mode': StripeStripePriceTiersMode | null;
|
|
9300
|
-
/**
|
|
9301
|
-
* Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
|
|
9302
|
-
* @type {StripeStripePriceTransformQuantity}
|
|
9303
|
-
* @memberof StripeStripePrice
|
|
9304
|
-
*/
|
|
9305
|
-
'transform_quantity': StripeStripePriceTransformQuantity | null;
|
|
9306
|
-
/**
|
|
9307
|
-
*
|
|
9308
|
-
* @type {StripeStripePriceType}
|
|
9309
|
-
* @memberof StripeStripePrice
|
|
9310
|
-
*/
|
|
9311
|
-
'type': StripeStripePriceType;
|
|
9312
|
-
/**
|
|
9313
|
-
* The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
|
|
9314
|
-
* @type {number}
|
|
9315
|
-
* @memberof StripeStripePrice
|
|
9316
|
-
*/
|
|
9317
|
-
'unit_amount': number | null;
|
|
9318
|
-
/**
|
|
9319
|
-
* The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
|
|
9320
|
-
* @type {string}
|
|
9321
|
-
* @memberof StripeStripePrice
|
|
9322
|
-
*/
|
|
9323
|
-
'unit_amount_decimal': string | null;
|
|
9324
|
-
}
|
|
9325
|
-
|
|
9326
|
-
export const StripeStripePriceObjectEnum = {
|
|
9327
|
-
Price: 'price'
|
|
9328
|
-
} as const;
|
|
9329
|
-
|
|
9330
|
-
export type StripeStripePriceObjectEnum = typeof StripeStripePriceObjectEnum[keyof typeof StripeStripePriceObjectEnum];
|
|
9331
|
-
|
|
9332
|
-
/**
|
|
9333
|
-
*
|
|
9334
|
-
* @export
|
|
9335
|
-
* @enum {string}
|
|
9336
|
-
*/
|
|
9337
|
-
|
|
9338
|
-
export const StripeStripePriceBillingScheme = {
|
|
9339
|
-
PerUnit: 'per_unit',
|
|
9340
|
-
Tiered: 'tiered'
|
|
9341
|
-
} as const;
|
|
9342
|
-
|
|
9343
|
-
export type StripeStripePriceBillingScheme = typeof StripeStripePriceBillingScheme[keyof typeof StripeStripePriceBillingScheme];
|
|
9344
|
-
|
|
9345
|
-
|
|
9346
|
-
/**
|
|
9347
|
-
*
|
|
9348
|
-
* @export
|
|
9349
|
-
* @interface StripeStripePriceCurrencyOptions
|
|
9350
|
-
*/
|
|
9351
|
-
export interface StripeStripePriceCurrencyOptions {
|
|
9352
|
-
/**
|
|
9353
|
-
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
9354
|
-
* @type {StripeStripePriceCurrencyOptionsCustomUnitAmount}
|
|
9355
|
-
* @memberof StripeStripePriceCurrencyOptions
|
|
9356
|
-
*/
|
|
9357
|
-
'custom_unit_amount': StripeStripePriceCurrencyOptionsCustomUnitAmount | null;
|
|
9358
|
-
/**
|
|
9359
|
-
* 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.
|
|
9360
|
-
* @type {StripeStripePriceCurrencyOptionsTaxBehavior}
|
|
9361
|
-
* @memberof StripeStripePriceCurrencyOptions
|
|
9362
|
-
*/
|
|
9363
|
-
'tax_behavior': StripeStripePriceCurrencyOptionsTaxBehavior | null;
|
|
9364
|
-
/**
|
|
9365
|
-
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
9366
|
-
* @type {Array<StripeStripePriceCurrencyOptionsTier>}
|
|
9367
|
-
* @memberof StripeStripePriceCurrencyOptions
|
|
9368
|
-
*/
|
|
9369
|
-
'tiers'?: Array<StripeStripePriceCurrencyOptionsTier>;
|
|
9370
|
-
/**
|
|
9371
|
-
* The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
|
|
9372
|
-
* @type {number}
|
|
9373
|
-
* @memberof StripeStripePriceCurrencyOptions
|
|
9374
|
-
*/
|
|
9375
|
-
'unit_amount': number | null;
|
|
9376
|
-
/**
|
|
9377
|
-
* The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
|
|
9378
|
-
* @type {string}
|
|
9379
|
-
* @memberof StripeStripePriceCurrencyOptions
|
|
9380
|
-
*/
|
|
9381
|
-
'unit_amount_decimal': string | null;
|
|
9382
|
-
}
|
|
9383
|
-
|
|
9384
|
-
|
|
9385
|
-
/**
|
|
9386
|
-
*
|
|
9387
|
-
* @export
|
|
9388
|
-
* @interface StripeStripePriceCurrencyOptionsCustomUnitAmount
|
|
9389
|
-
*/
|
|
9390
|
-
export interface StripeStripePriceCurrencyOptionsCustomUnitAmount {
|
|
9391
|
-
/**
|
|
9392
|
-
* The maximum unit amount the customer can specify for this item.
|
|
9393
|
-
* @type {number}
|
|
9394
|
-
* @memberof StripeStripePriceCurrencyOptionsCustomUnitAmount
|
|
9395
|
-
*/
|
|
9396
|
-
'maximum': number | null;
|
|
9397
|
-
/**
|
|
9398
|
-
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
|
9399
|
-
* @type {number}
|
|
9400
|
-
* @memberof StripeStripePriceCurrencyOptionsCustomUnitAmount
|
|
9401
|
-
*/
|
|
9402
|
-
'minimum': number | null;
|
|
9403
|
-
/**
|
|
9404
|
-
* The starting unit amount which can be updated by the customer.
|
|
9405
|
-
* @type {number}
|
|
9406
|
-
* @memberof StripeStripePriceCurrencyOptionsCustomUnitAmount
|
|
9407
|
-
*/
|
|
9408
|
-
'preset': number | null;
|
|
9409
|
-
}
|
|
9410
|
-
/**
|
|
9411
|
-
*
|
|
9412
|
-
* @export
|
|
9413
|
-
* @enum {string}
|
|
9414
|
-
*/
|
|
9415
|
-
|
|
9416
|
-
export const StripeStripePriceCurrencyOptionsTaxBehavior = {
|
|
9417
|
-
Exclusive: 'exclusive',
|
|
9418
|
-
Inclusive: 'inclusive',
|
|
9419
|
-
Unspecified: 'unspecified'
|
|
9420
|
-
} as const;
|
|
9421
|
-
|
|
9422
|
-
export type StripeStripePriceCurrencyOptionsTaxBehavior = typeof StripeStripePriceCurrencyOptionsTaxBehavior[keyof typeof StripeStripePriceCurrencyOptionsTaxBehavior];
|
|
9423
|
-
|
|
9424
|
-
|
|
9425
|
-
/**
|
|
9426
|
-
*
|
|
9427
|
-
* @export
|
|
9428
|
-
* @interface StripeStripePriceCurrencyOptionsTier
|
|
9429
|
-
*/
|
|
9430
|
-
export interface StripeStripePriceCurrencyOptionsTier {
|
|
9431
|
-
/**
|
|
9432
|
-
* Price for the entire tier.
|
|
9433
|
-
* @type {number}
|
|
9434
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9435
|
-
*/
|
|
9436
|
-
'flat_amount': number | null;
|
|
9437
|
-
/**
|
|
9438
|
-
* Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
|
|
9439
|
-
* @type {string}
|
|
9440
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9441
|
-
*/
|
|
9442
|
-
'flat_amount_decimal': string | null;
|
|
9443
|
-
/**
|
|
9444
|
-
* Per unit price for units relevant to the tier.
|
|
9445
|
-
* @type {number}
|
|
9446
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9447
|
-
*/
|
|
9448
|
-
'unit_amount': number | null;
|
|
9449
|
-
/**
|
|
9450
|
-
* Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
|
|
9451
|
-
* @type {string}
|
|
9452
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9453
|
-
*/
|
|
9454
|
-
'unit_amount_decimal': string | null;
|
|
9455
|
-
/**
|
|
9456
|
-
* Up to and including to this quantity will be contained in the tier.
|
|
9457
|
-
* @type {number}
|
|
9458
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9459
|
-
*/
|
|
9460
|
-
'up_to': number | null;
|
|
9461
|
-
}
|
|
9462
|
-
/**
|
|
9463
|
-
*
|
|
9464
|
-
* @export
|
|
9465
|
-
* @interface StripeStripePriceCustomUnitAmount
|
|
9466
|
-
*/
|
|
9467
|
-
export interface StripeStripePriceCustomUnitAmount {
|
|
9468
|
-
/**
|
|
9469
|
-
* The maximum unit amount the customer can specify for this item.
|
|
9470
|
-
* @type {number}
|
|
9471
|
-
* @memberof StripeStripePriceCustomUnitAmount
|
|
9472
|
-
*/
|
|
9473
|
-
'maximum': number | null;
|
|
9474
|
-
/**
|
|
9475
|
-
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
|
9476
|
-
* @type {number}
|
|
9477
|
-
* @memberof StripeStripePriceCustomUnitAmount
|
|
9478
|
-
*/
|
|
9479
|
-
'minimum': number | null;
|
|
9480
|
-
/**
|
|
9481
|
-
* The starting unit amount which can be updated by the customer.
|
|
9482
|
-
* @type {number}
|
|
9483
|
-
* @memberof StripeStripePriceCustomUnitAmount
|
|
9484
|
-
*/
|
|
9485
|
-
'preset': number | null;
|
|
9486
|
-
}
|
|
9487
|
-
/**
|
|
9488
|
-
* The ID of the product this price is associated with.
|
|
9489
|
-
* @export
|
|
9490
|
-
* @interface StripeStripePriceProduct
|
|
9491
|
-
*/
|
|
9492
|
-
export interface StripeStripePriceProduct {
|
|
9493
|
-
/**
|
|
9494
|
-
* Unique identifier for the object.
|
|
9495
|
-
* @type {string}
|
|
9496
|
-
* @memberof StripeStripePriceProduct
|
|
9497
|
-
*/
|
|
9498
|
-
'id': string;
|
|
9499
|
-
/**
|
|
9500
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
9501
|
-
* @type {string}
|
|
9502
|
-
* @memberof StripeStripePriceProduct
|
|
9503
|
-
*/
|
|
9504
|
-
'object': StripeStripePriceProductObjectEnum;
|
|
9505
|
-
/**
|
|
9506
|
-
* Whether the product is currently available for purchase.
|
|
9507
|
-
* @type {boolean}
|
|
9508
|
-
* @memberof StripeStripePriceProduct
|
|
9509
|
-
*/
|
|
9510
|
-
'active': boolean;
|
|
9511
|
-
/**
|
|
9512
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
9513
|
-
* @type {number}
|
|
9514
|
-
* @memberof StripeStripePriceProduct
|
|
9515
|
-
*/
|
|
9516
|
-
'created': number;
|
|
9517
|
-
/**
|
|
9518
|
-
*
|
|
9519
|
-
* @type {StripeStripeProductDefaultPrice}
|
|
9520
|
-
* @memberof StripeStripePriceProduct
|
|
9521
|
-
*/
|
|
9522
|
-
'default_price'?: StripeStripeProductDefaultPrice | null;
|
|
9523
|
-
/**
|
|
9524
|
-
* Always true for a deleted object
|
|
9525
|
-
* @type {boolean}
|
|
9526
|
-
* @memberof StripeStripePriceProduct
|
|
9527
|
-
*/
|
|
9528
|
-
'deleted': boolean;
|
|
9529
|
-
/**
|
|
9530
|
-
* The product\'s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
|
|
9531
|
-
* @type {string}
|
|
9532
|
-
* @memberof StripeStripePriceProduct
|
|
9533
|
-
*/
|
|
9534
|
-
'description': string | null;
|
|
9535
|
-
/**
|
|
9536
|
-
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
9537
|
-
* @type {Array<string>}
|
|
9538
|
-
* @memberof StripeStripePriceProduct
|
|
9539
|
-
*/
|
|
9540
|
-
'images': Array<string>;
|
|
9541
|
-
/**
|
|
9542
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
9543
|
-
* @type {boolean}
|
|
9544
|
-
* @memberof StripeStripePriceProduct
|
|
9545
|
-
*/
|
|
9546
|
-
'livemode': boolean;
|
|
9547
|
-
/**
|
|
9548
|
-
* A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
|
|
9549
|
-
* @type {Array<StripeStripeProductMarketingFeature>}
|
|
9550
|
-
* @memberof StripeStripePriceProduct
|
|
9551
|
-
*/
|
|
9552
|
-
'marketing_features': Array<StripeStripeProductMarketingFeature>;
|
|
9553
|
-
/**
|
|
9554
|
-
* Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
9555
|
-
* @type {{ [key: string]: string; }}
|
|
9556
|
-
* @memberof StripeStripePriceProduct
|
|
9557
|
-
*/
|
|
9558
|
-
'metadata': { [key: string]: string; };
|
|
9559
|
-
/**
|
|
9560
|
-
* The product\'s name, meant to be displayable to the customer.
|
|
9561
|
-
* @type {string}
|
|
9562
|
-
* @memberof StripeStripePriceProduct
|
|
9563
|
-
*/
|
|
9564
|
-
'name': string;
|
|
9565
|
-
/**
|
|
9566
|
-
* The dimensions of this product for shipping purposes.
|
|
9567
|
-
* @type {StripeStripeProductPackageDimensions}
|
|
9568
|
-
* @memberof StripeStripePriceProduct
|
|
9569
|
-
*/
|
|
9570
|
-
'package_dimensions': StripeStripeProductPackageDimensions | null;
|
|
9571
|
-
/**
|
|
9572
|
-
* Whether this product is shipped (i.e., physical goods).
|
|
9573
|
-
* @type {boolean}
|
|
9574
|
-
* @memberof StripeStripePriceProduct
|
|
9575
|
-
*/
|
|
9576
|
-
'shippable': boolean | null;
|
|
9577
|
-
/**
|
|
9578
|
-
* Extra information about a product which will appear on your customer\'s credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
|
|
9579
|
-
* @type {string}
|
|
9580
|
-
* @memberof StripeStripePriceProduct
|
|
9581
|
-
*/
|
|
9582
|
-
'statement_descriptor'?: string | null;
|
|
9583
|
-
/**
|
|
9584
|
-
*
|
|
9585
|
-
* @type {StripeStripeProductTaxCode}
|
|
9586
|
-
* @memberof StripeStripePriceProduct
|
|
9587
|
-
*/
|
|
9588
|
-
'tax_code': StripeStripeProductTaxCode | null;
|
|
9589
|
-
/**
|
|
9590
|
-
*
|
|
9591
|
-
* @type {StripeStripeProductType}
|
|
9592
|
-
* @memberof StripeStripePriceProduct
|
|
9593
|
-
*/
|
|
9594
|
-
'type': StripeStripeProductType;
|
|
9595
|
-
/**
|
|
9596
|
-
* A label that represents units of this product. When set, this will be included in customers\' receipts, invoices, Checkout, and the customer portal.
|
|
9597
|
-
* @type {string}
|
|
9598
|
-
* @memberof StripeStripePriceProduct
|
|
9599
|
-
*/
|
|
9600
|
-
'unit_label'?: string | null;
|
|
9601
|
-
/**
|
|
9602
|
-
* Time at which the object was last updated. Measured in seconds since the Unix epoch.
|
|
9603
|
-
* @type {number}
|
|
9604
|
-
* @memberof StripeStripePriceProduct
|
|
9605
|
-
*/
|
|
9606
|
-
'updated': number;
|
|
9607
|
-
/**
|
|
9608
|
-
* A URL of a publicly-accessible webpage for this product.
|
|
9609
|
-
* @type {string}
|
|
9610
|
-
* @memberof StripeStripePriceProduct
|
|
9611
|
-
*/
|
|
9612
|
-
'url': string | null;
|
|
9613
|
-
}
|
|
9614
|
-
|
|
9615
|
-
export const StripeStripePriceProductObjectEnum = {
|
|
9616
|
-
Product: 'product'
|
|
9617
|
-
} as const;
|
|
9618
|
-
|
|
9619
|
-
export type StripeStripePriceProductObjectEnum = typeof StripeStripePriceProductObjectEnum[keyof typeof StripeStripePriceProductObjectEnum];
|
|
9620
|
-
|
|
9621
|
-
/**
|
|
9622
|
-
*
|
|
9623
|
-
* @export
|
|
9624
|
-
* @interface StripeStripePriceRecurring
|
|
9625
|
-
*/
|
|
9626
|
-
export interface StripeStripePriceRecurring {
|
|
9627
|
-
/**
|
|
9628
|
-
*
|
|
9629
|
-
* @type {StripeStripePriceRecurringInterval}
|
|
9630
|
-
* @memberof StripeStripePriceRecurring
|
|
9631
|
-
*/
|
|
9632
|
-
'interval': StripeStripePriceRecurringInterval;
|
|
9633
|
-
/**
|
|
9634
|
-
* The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
|
|
9635
|
-
* @type {number}
|
|
9636
|
-
* @memberof StripeStripePriceRecurring
|
|
9637
|
-
*/
|
|
9638
|
-
'interval_count': number;
|
|
9639
|
-
/**
|
|
9640
|
-
* The meter tracking the usage of a metered price
|
|
9641
|
-
* @type {string}
|
|
9642
|
-
* @memberof StripeStripePriceRecurring
|
|
9643
|
-
*/
|
|
9644
|
-
'meter': string | null;
|
|
9645
|
-
/**
|
|
9646
|
-
* 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).
|
|
9647
|
-
* @type {number}
|
|
9648
|
-
* @memberof StripeStripePriceRecurring
|
|
9649
|
-
*/
|
|
9650
|
-
'trial_period_days': number | null;
|
|
9651
|
-
/**
|
|
9652
|
-
*
|
|
9653
|
-
* @type {StripeStripePriceRecurringUsageType}
|
|
9654
|
-
* @memberof StripeStripePriceRecurring
|
|
9655
|
-
*/
|
|
9656
|
-
'usage_type': StripeStripePriceRecurringUsageType;
|
|
9657
|
-
}
|
|
9658
|
-
|
|
9659
|
-
|
|
9660
|
-
/**
|
|
9661
|
-
*
|
|
9662
|
-
* @export
|
|
9663
|
-
* @enum {string}
|
|
9664
|
-
*/
|
|
9665
|
-
|
|
9666
|
-
export const StripeStripePriceRecurringInterval = {
|
|
9667
|
-
Day: 'day',
|
|
9668
|
-
Month: 'month',
|
|
9669
|
-
Week: 'week',
|
|
9670
|
-
Year: 'year'
|
|
9671
|
-
} as const;
|
|
9672
|
-
|
|
9673
|
-
export type StripeStripePriceRecurringInterval = typeof StripeStripePriceRecurringInterval[keyof typeof StripeStripePriceRecurringInterval];
|
|
9674
|
-
|
|
9675
|
-
|
|
9676
|
-
/**
|
|
9677
|
-
*
|
|
9678
|
-
* @export
|
|
9679
|
-
* @enum {string}
|
|
9680
|
-
*/
|
|
9681
|
-
|
|
9682
|
-
export const StripeStripePriceRecurringUsageType = {
|
|
9683
|
-
Licensed: 'licensed',
|
|
9684
|
-
Metered: 'metered'
|
|
9685
|
-
} as const;
|
|
9686
|
-
|
|
9687
|
-
export type StripeStripePriceRecurringUsageType = typeof StripeStripePriceRecurringUsageType[keyof typeof StripeStripePriceRecurringUsageType];
|
|
9688
|
-
|
|
9689
|
-
|
|
9690
|
-
/**
|
|
9691
|
-
*
|
|
9692
|
-
* @export
|
|
9693
|
-
* @enum {string}
|
|
9694
|
-
*/
|
|
9695
|
-
|
|
9696
|
-
export const StripeStripePriceTaxBehavior = {
|
|
9697
|
-
Exclusive: 'exclusive',
|
|
9698
|
-
Inclusive: 'inclusive',
|
|
9699
|
-
Unspecified: 'unspecified'
|
|
9700
|
-
} as const;
|
|
9701
|
-
|
|
9702
|
-
export type StripeStripePriceTaxBehavior = typeof StripeStripePriceTaxBehavior[keyof typeof StripeStripePriceTaxBehavior];
|
|
9703
|
-
|
|
9704
|
-
|
|
9705
|
-
/**
|
|
9706
|
-
*
|
|
9707
|
-
* @export
|
|
9708
|
-
* @interface StripeStripePriceTier
|
|
9709
|
-
*/
|
|
9710
|
-
export interface StripeStripePriceTier {
|
|
9711
|
-
/**
|
|
9712
|
-
* Price for the entire tier.
|
|
9713
|
-
* @type {number}
|
|
9714
|
-
* @memberof StripeStripePriceTier
|
|
9715
|
-
*/
|
|
9716
|
-
'flat_amount': number | null;
|
|
9717
|
-
/**
|
|
9718
|
-
* Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
|
|
9719
|
-
* @type {string}
|
|
9720
|
-
* @memberof StripeStripePriceTier
|
|
9721
|
-
*/
|
|
9722
|
-
'flat_amount_decimal': string | null;
|
|
9723
|
-
/**
|
|
9724
|
-
* Per unit price for units relevant to the tier.
|
|
9725
|
-
* @type {number}
|
|
9726
|
-
* @memberof StripeStripePriceTier
|
|
9727
|
-
*/
|
|
9728
|
-
'unit_amount': number | null;
|
|
9729
|
-
/**
|
|
9730
|
-
* Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
|
|
9731
|
-
* @type {string}
|
|
9732
|
-
* @memberof StripeStripePriceTier
|
|
9733
|
-
*/
|
|
9734
|
-
'unit_amount_decimal': string | null;
|
|
9735
|
-
/**
|
|
9736
|
-
* Up to and including to this quantity will be contained in the tier.
|
|
9737
|
-
* @type {number}
|
|
9738
|
-
* @memberof StripeStripePriceTier
|
|
9739
|
-
*/
|
|
9740
|
-
'up_to': number | null;
|
|
9741
|
-
}
|
|
9742
|
-
/**
|
|
9743
|
-
*
|
|
9744
|
-
* @export
|
|
9745
|
-
* @enum {string}
|
|
9746
|
-
*/
|
|
9747
|
-
|
|
9748
|
-
export const StripeStripePriceTiersMode = {
|
|
9749
|
-
Graduated: 'graduated',
|
|
9750
|
-
Volume: 'volume'
|
|
9751
|
-
} as const;
|
|
9752
|
-
|
|
9753
|
-
export type StripeStripePriceTiersMode = typeof StripeStripePriceTiersMode[keyof typeof StripeStripePriceTiersMode];
|
|
9754
|
-
|
|
9755
|
-
|
|
9756
|
-
/**
|
|
9757
|
-
*
|
|
9758
|
-
* @export
|
|
9759
|
-
* @interface StripeStripePriceTransformQuantity
|
|
9760
|
-
*/
|
|
9761
|
-
export interface StripeStripePriceTransformQuantity {
|
|
9762
|
-
/**
|
|
9763
|
-
* Divide usage by this number.
|
|
9764
|
-
* @type {number}
|
|
9765
|
-
* @memberof StripeStripePriceTransformQuantity
|
|
9766
|
-
*/
|
|
9767
|
-
'divide_by': number;
|
|
9768
|
-
/**
|
|
9769
|
-
*
|
|
9770
|
-
* @type {StripeStripePriceTransformQuantityRound}
|
|
9771
|
-
* @memberof StripeStripePriceTransformQuantity
|
|
9772
|
-
*/
|
|
9773
|
-
'round': StripeStripePriceTransformQuantityRound;
|
|
9774
|
-
}
|
|
9775
|
-
|
|
9776
|
-
|
|
9777
|
-
/**
|
|
9778
|
-
*
|
|
9779
|
-
* @export
|
|
9780
|
-
* @enum {string}
|
|
9781
|
-
*/
|
|
9782
|
-
|
|
9783
|
-
export const StripeStripePriceTransformQuantityRound = {
|
|
9784
|
-
Down: 'down',
|
|
9785
|
-
Up: 'up'
|
|
9786
|
-
} as const;
|
|
9787
|
-
|
|
9788
|
-
export type StripeStripePriceTransformQuantityRound = typeof StripeStripePriceTransformQuantityRound[keyof typeof StripeStripePriceTransformQuantityRound];
|
|
9789
|
-
|
|
9790
|
-
|
|
9791
|
-
/**
|
|
9792
|
-
*
|
|
9793
|
-
* @export
|
|
9794
|
-
* @enum {string}
|
|
9795
|
-
*/
|
|
9796
|
-
|
|
9797
|
-
export const StripeStripePriceType = {
|
|
9798
|
-
OneTime: 'one_time',
|
|
9799
|
-
Recurring: 'recurring'
|
|
9800
|
-
} as const;
|
|
9801
|
-
|
|
9802
|
-
export type StripeStripePriceType = typeof StripeStripePriceType[keyof typeof StripeStripePriceType];
|
|
9803
|
-
|
|
9804
|
-
|
|
9805
|
-
/**
|
|
9806
|
-
* Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [share a Payment Link](https://stripe.com/docs/payment-links), [accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront), and more about [Products and Prices](https://stripe.com/docs/products-prices/overview)
|
|
9807
|
-
* @export
|
|
9808
|
-
* @interface StripeStripeProduct
|
|
9809
|
-
*/
|
|
9810
|
-
export interface StripeStripeProduct {
|
|
9811
|
-
/**
|
|
9812
|
-
* Unique identifier for the object.
|
|
9813
|
-
* @type {string}
|
|
9814
|
-
* @memberof StripeStripeProduct
|
|
9815
|
-
*/
|
|
9816
|
-
'id': string;
|
|
9817
|
-
/**
|
|
9818
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
9819
|
-
* @type {string}
|
|
9820
|
-
* @memberof StripeStripeProduct
|
|
9821
|
-
*/
|
|
9822
|
-
'object': StripeStripeProductObjectEnum;
|
|
9823
|
-
/**
|
|
9824
|
-
* Whether the product is currently available for purchase.
|
|
9825
|
-
* @type {boolean}
|
|
9826
|
-
* @memberof StripeStripeProduct
|
|
9827
|
-
*/
|
|
9828
|
-
'active': boolean;
|
|
9829
|
-
/**
|
|
9830
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
9831
|
-
* @type {number}
|
|
9832
|
-
* @memberof StripeStripeProduct
|
|
9833
|
-
*/
|
|
9834
|
-
'created': number;
|
|
9835
|
-
/**
|
|
9836
|
-
*
|
|
9837
|
-
* @type {StripeStripeProductDefaultPrice}
|
|
9838
|
-
* @memberof StripeStripeProduct
|
|
9839
|
-
*/
|
|
9840
|
-
'default_price'?: StripeStripeProductDefaultPrice | null;
|
|
9841
|
-
/**
|
|
9842
|
-
* Always true for a deleted object
|
|
9843
|
-
* @type {any}
|
|
9844
|
-
* @memberof StripeStripeProduct
|
|
9845
|
-
*/
|
|
9846
|
-
'deleted'?: any;
|
|
9847
|
-
/**
|
|
9848
|
-
* The product\'s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
|
|
9849
|
-
* @type {string}
|
|
9850
|
-
* @memberof StripeStripeProduct
|
|
9851
|
-
*/
|
|
9852
|
-
'description': string | null;
|
|
9853
|
-
/**
|
|
9854
|
-
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
9855
|
-
* @type {Array<string>}
|
|
9856
|
-
* @memberof StripeStripeProduct
|
|
9857
|
-
*/
|
|
9858
|
-
'images': Array<string>;
|
|
9859
|
-
/**
|
|
9860
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
9861
|
-
* @type {boolean}
|
|
9862
|
-
* @memberof StripeStripeProduct
|
|
9863
|
-
*/
|
|
9864
|
-
'livemode': boolean;
|
|
9865
|
-
/**
|
|
9866
|
-
* A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
|
|
9867
|
-
* @type {Array<StripeStripeProductMarketingFeature>}
|
|
9868
|
-
* @memberof StripeStripeProduct
|
|
9869
|
-
*/
|
|
9870
|
-
'marketing_features': Array<StripeStripeProductMarketingFeature>;
|
|
9871
|
-
/**
|
|
9872
|
-
* Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
9873
|
-
* @type {{ [key: string]: string; }}
|
|
9874
|
-
* @memberof StripeStripeProduct
|
|
9875
|
-
*/
|
|
9876
|
-
'metadata': { [key: string]: string; };
|
|
9877
|
-
/**
|
|
9878
|
-
* The product\'s name, meant to be displayable to the customer.
|
|
9879
|
-
* @type {string}
|
|
9880
|
-
* @memberof StripeStripeProduct
|
|
9881
|
-
*/
|
|
9882
|
-
'name': string;
|
|
9883
|
-
/**
|
|
9884
|
-
* The dimensions of this product for shipping purposes.
|
|
9885
|
-
* @type {StripeStripeProductPackageDimensions}
|
|
9886
|
-
* @memberof StripeStripeProduct
|
|
9887
|
-
*/
|
|
9888
|
-
'package_dimensions': StripeStripeProductPackageDimensions | null;
|
|
9889
|
-
/**
|
|
9890
|
-
* Whether this product is shipped (i.e., physical goods).
|
|
9891
|
-
* @type {boolean}
|
|
9892
|
-
* @memberof StripeStripeProduct
|
|
9893
|
-
*/
|
|
9894
|
-
'shippable': boolean | null;
|
|
9895
|
-
/**
|
|
9896
|
-
* Extra information about a product which will appear on your customer\'s credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
|
|
9897
|
-
* @type {string}
|
|
9898
|
-
* @memberof StripeStripeProduct
|
|
9899
|
-
*/
|
|
9900
|
-
'statement_descriptor'?: string | null;
|
|
9901
|
-
/**
|
|
9902
|
-
*
|
|
9903
|
-
* @type {StripeStripeProductTaxCode}
|
|
9904
|
-
* @memberof StripeStripeProduct
|
|
9905
|
-
*/
|
|
9906
|
-
'tax_code': StripeStripeProductTaxCode | null;
|
|
9907
|
-
/**
|
|
9908
|
-
*
|
|
9909
|
-
* @type {StripeStripeProductType}
|
|
9910
|
-
* @memberof StripeStripeProduct
|
|
9911
|
-
*/
|
|
9912
|
-
'type': StripeStripeProductType;
|
|
9913
|
-
/**
|
|
9914
|
-
* A label that represents units of this product. When set, this will be included in customers\' receipts, invoices, Checkout, and the customer portal.
|
|
9915
|
-
* @type {string}
|
|
9916
|
-
* @memberof StripeStripeProduct
|
|
9917
|
-
*/
|
|
9918
|
-
'unit_label'?: string | null;
|
|
9919
|
-
/**
|
|
9920
|
-
* Time at which the object was last updated. Measured in seconds since the Unix epoch.
|
|
9921
|
-
* @type {number}
|
|
9922
|
-
* @memberof StripeStripeProduct
|
|
9923
|
-
*/
|
|
9924
|
-
'updated': number;
|
|
9925
|
-
/**
|
|
9926
|
-
* A URL of a publicly-accessible webpage for this product.
|
|
9927
|
-
* @type {string}
|
|
9928
|
-
* @memberof StripeStripeProduct
|
|
9929
|
-
*/
|
|
9930
|
-
'url': string | null;
|
|
9931
|
-
}
|
|
9932
|
-
|
|
9933
|
-
export const StripeStripeProductObjectEnum = {
|
|
9934
|
-
Product: 'product'
|
|
9935
|
-
} as const;
|
|
9936
|
-
|
|
9937
|
-
export type StripeStripeProductObjectEnum = typeof StripeStripeProductObjectEnum[keyof typeof StripeStripeProductObjectEnum];
|
|
9938
|
-
|
|
9939
|
-
/**
|
|
9940
|
-
* The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
|
|
9941
|
-
* @export
|
|
9942
|
-
* @interface StripeStripeProductDefaultPrice
|
|
9943
|
-
*/
|
|
9944
|
-
export interface StripeStripeProductDefaultPrice {
|
|
9945
|
-
/**
|
|
9946
|
-
* Unique identifier for the object.
|
|
9947
|
-
* @type {string}
|
|
9948
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9949
|
-
*/
|
|
9950
|
-
'id': string;
|
|
9951
|
-
/**
|
|
9952
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
9953
|
-
* @type {string}
|
|
9954
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9955
|
-
*/
|
|
9956
|
-
'object': StripeStripeProductDefaultPriceObjectEnum;
|
|
9957
|
-
/**
|
|
9958
|
-
* Whether the price can be used for new purchases.
|
|
9959
|
-
* @type {boolean}
|
|
9960
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9961
|
-
*/
|
|
9962
|
-
'active': boolean;
|
|
9963
|
-
/**
|
|
9964
|
-
*
|
|
9965
|
-
* @type {StripeStripePriceBillingScheme}
|
|
9966
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9967
|
-
*/
|
|
9968
|
-
'billing_scheme': StripeStripePriceBillingScheme;
|
|
9969
|
-
/**
|
|
9970
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
9971
|
-
* @type {number}
|
|
9972
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9973
|
-
*/
|
|
9974
|
-
'created': number;
|
|
9975
|
-
/**
|
|
9976
|
-
* 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).
|
|
9977
|
-
* @type {string}
|
|
9978
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9979
|
-
*/
|
|
9980
|
-
'currency': string;
|
|
9981
|
-
/**
|
|
9982
|
-
* 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).
|
|
9983
|
-
* @type {{ [key: string]: StripeStripePriceCurrencyOptions; }}
|
|
9984
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9985
|
-
*/
|
|
9986
|
-
'currency_options'?: { [key: string]: StripeStripePriceCurrencyOptions; };
|
|
9987
|
-
/**
|
|
9988
|
-
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
9989
|
-
* @type {StripeStripePriceCustomUnitAmount}
|
|
9990
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9991
|
-
*/
|
|
9992
|
-
'custom_unit_amount': StripeStripePriceCustomUnitAmount | null;
|
|
9993
|
-
/**
|
|
9994
|
-
* Always true for a deleted object
|
|
9995
|
-
* @type {any}
|
|
9996
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9997
|
-
*/
|
|
9998
|
-
'deleted'?: any;
|
|
9999
|
-
/**
|
|
10000
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
10001
|
-
* @type {boolean}
|
|
10002
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10003
|
-
*/
|
|
10004
|
-
'livemode': boolean;
|
|
10005
|
-
/**
|
|
10006
|
-
* A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
|
10007
|
-
* @type {string}
|
|
10008
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10009
|
-
*/
|
|
10010
|
-
'lookup_key': string | null;
|
|
10011
|
-
/**
|
|
10012
|
-
* Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
10013
|
-
* @type {{ [key: string]: string; }}
|
|
10014
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10015
|
-
*/
|
|
10016
|
-
'metadata': { [key: string]: string; };
|
|
10017
|
-
/**
|
|
10018
|
-
* A brief description of the price, hidden from customers.
|
|
10019
|
-
* @type {string}
|
|
10020
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10021
|
-
*/
|
|
10022
|
-
'nickname': string | null;
|
|
10023
|
-
/**
|
|
10024
|
-
*
|
|
10025
|
-
* @type {StripeStripePriceProduct}
|
|
10026
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10027
|
-
*/
|
|
10028
|
-
'product': StripeStripePriceProduct;
|
|
10029
|
-
/**
|
|
10030
|
-
* The recurring components of a price such as `interval` and `usage_type`.
|
|
10031
|
-
* @type {StripeStripePriceRecurring}
|
|
10032
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10033
|
-
*/
|
|
10034
|
-
'recurring': StripeStripePriceRecurring | null;
|
|
10035
|
-
/**
|
|
10036
|
-
* 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.
|
|
10037
|
-
* @type {StripeStripePriceTaxBehavior}
|
|
10038
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10039
|
-
*/
|
|
10040
|
-
'tax_behavior': StripeStripePriceTaxBehavior | null;
|
|
10041
|
-
/**
|
|
10042
|
-
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
10043
|
-
* @type {Array<StripeStripePriceTier>}
|
|
10044
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10045
|
-
*/
|
|
10046
|
-
'tiers'?: Array<StripeStripePriceTier>;
|
|
10047
|
-
/**
|
|
10048
|
-
* Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
|
|
10049
|
-
* @type {StripeStripePriceTiersMode}
|
|
10050
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10051
|
-
*/
|
|
10052
|
-
'tiers_mode': StripeStripePriceTiersMode | null;
|
|
10053
|
-
/**
|
|
10054
|
-
* Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
|
|
10055
|
-
* @type {StripeStripePriceTransformQuantity}
|
|
10056
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10057
|
-
*/
|
|
10058
|
-
'transform_quantity': StripeStripePriceTransformQuantity | null;
|
|
10059
|
-
/**
|
|
10060
|
-
*
|
|
10061
|
-
* @type {StripeStripePriceType}
|
|
10062
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10063
|
-
*/
|
|
10064
|
-
'type': StripeStripePriceType;
|
|
10065
|
-
/**
|
|
10066
|
-
* The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
|
|
10067
|
-
* @type {number}
|
|
10068
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10069
|
-
*/
|
|
10070
|
-
'unit_amount': number | null;
|
|
10071
|
-
/**
|
|
10072
|
-
* The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
|
|
10073
|
-
* @type {string}
|
|
10074
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10075
|
-
*/
|
|
10076
|
-
'unit_amount_decimal': string | null;
|
|
10077
|
-
}
|
|
10078
|
-
|
|
10079
|
-
export const StripeStripeProductDefaultPriceObjectEnum = {
|
|
10080
|
-
Price: 'price'
|
|
10081
|
-
} as const;
|
|
10082
|
-
|
|
10083
|
-
export type StripeStripeProductDefaultPriceObjectEnum = typeof StripeStripeProductDefaultPriceObjectEnum[keyof typeof StripeStripeProductDefaultPriceObjectEnum];
|
|
10084
|
-
|
|
10085
|
-
/**
|
|
10086
|
-
*
|
|
10087
|
-
* @export
|
|
10088
|
-
* @interface StripeStripeProductMarketingFeature
|
|
10089
|
-
*/
|
|
10090
|
-
export interface StripeStripeProductMarketingFeature {
|
|
10091
|
-
/**
|
|
10092
|
-
* The marketing feature name. Up to 80 characters long.
|
|
10093
|
-
* @type {string}
|
|
10094
|
-
* @memberof StripeStripeProductMarketingFeature
|
|
10095
|
-
*/
|
|
10096
|
-
'name'?: string;
|
|
10097
|
-
}
|
|
10098
|
-
/**
|
|
10099
|
-
*
|
|
10100
|
-
* @export
|
|
10101
|
-
* @interface StripeStripeProductPackageDimensions
|
|
10102
|
-
*/
|
|
10103
|
-
export interface StripeStripeProductPackageDimensions {
|
|
10104
|
-
/**
|
|
10105
|
-
* Height, in inches.
|
|
10106
|
-
* @type {number}
|
|
10107
|
-
* @memberof StripeStripeProductPackageDimensions
|
|
10108
|
-
*/
|
|
10109
|
-
'height': number;
|
|
10110
|
-
/**
|
|
10111
|
-
* Length, in inches.
|
|
10112
|
-
* @type {number}
|
|
10113
|
-
* @memberof StripeStripeProductPackageDimensions
|
|
10114
|
-
*/
|
|
10115
|
-
'length': number;
|
|
10116
|
-
/**
|
|
10117
|
-
* Weight, in ounces.
|
|
10118
|
-
* @type {number}
|
|
10119
|
-
* @memberof StripeStripeProductPackageDimensions
|
|
10120
|
-
*/
|
|
10121
|
-
'weight': number;
|
|
10122
|
-
/**
|
|
10123
|
-
* Width, in inches.
|
|
10124
|
-
* @type {number}
|
|
10125
|
-
* @memberof StripeStripeProductPackageDimensions
|
|
10126
|
-
*/
|
|
10127
|
-
'width': number;
|
|
10128
|
-
}
|
|
10129
|
-
/**
|
|
10130
|
-
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
|
10131
|
-
* @export
|
|
10132
|
-
* @interface StripeStripeProductTaxCode
|
|
10133
|
-
*/
|
|
10134
|
-
export interface StripeStripeProductTaxCode {
|
|
10135
|
-
/**
|
|
10136
|
-
* Unique identifier for the object.
|
|
10137
|
-
* @type {string}
|
|
10138
|
-
* @memberof StripeStripeProductTaxCode
|
|
10139
|
-
*/
|
|
10140
|
-
'id': string;
|
|
10141
|
-
/**
|
|
10142
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
10143
|
-
* @type {string}
|
|
10144
|
-
* @memberof StripeStripeProductTaxCode
|
|
10145
|
-
*/
|
|
10146
|
-
'object': StripeStripeProductTaxCodeObjectEnum;
|
|
10147
|
-
/**
|
|
10148
|
-
* A detailed description of which types of products the tax code represents.
|
|
10149
|
-
* @type {string}
|
|
10150
|
-
* @memberof StripeStripeProductTaxCode
|
|
10151
|
-
*/
|
|
10152
|
-
'description': string;
|
|
10153
|
-
/**
|
|
10154
|
-
* A short name for the tax code.
|
|
10155
|
-
* @type {string}
|
|
10156
|
-
* @memberof StripeStripeProductTaxCode
|
|
10157
|
-
*/
|
|
10158
|
-
'name': string;
|
|
10159
|
-
}
|
|
10160
|
-
|
|
10161
|
-
export const StripeStripeProductTaxCodeObjectEnum = {
|
|
10162
|
-
TaxCode: 'tax_code'
|
|
10163
|
-
} as const;
|
|
10164
|
-
|
|
10165
|
-
export type StripeStripeProductTaxCodeObjectEnum = typeof StripeStripeProductTaxCodeObjectEnum[keyof typeof StripeStripeProductTaxCodeObjectEnum];
|
|
10166
|
-
|
|
10167
|
-
/**
|
|
10168
|
-
*
|
|
10169
|
-
* @export
|
|
10170
|
-
* @enum {string}
|
|
10171
|
-
*/
|
|
10172
|
-
|
|
10173
|
-
export const StripeStripeProductType = {
|
|
10174
|
-
Good: 'good',
|
|
10175
|
-
Service: 'service'
|
|
10176
|
-
} as const;
|
|
10177
|
-
|
|
10178
|
-
export type StripeStripeProductType = typeof StripeStripeProductType[keyof typeof StripeStripeProductType];
|
|
10179
|
-
|
|
10180
|
-
|
|
10181
|
-
/**
|
|
10182
|
-
*
|
|
10183
|
-
* @export
|
|
10184
|
-
* @interface StripeStripeResponseStripeStripePrice
|
|
10185
|
-
*/
|
|
10186
|
-
export interface StripeStripeResponseStripeStripePrice {
|
|
10187
|
-
/**
|
|
10188
|
-
* Unique identifier for the object.
|
|
10189
|
-
* @type {string}
|
|
10190
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10191
|
-
*/
|
|
10192
|
-
'id': string;
|
|
10193
|
-
/**
|
|
10194
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
10195
|
-
* @type {string}
|
|
10196
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10197
|
-
*/
|
|
10198
|
-
'object': StripeStripeResponseStripeStripePriceObjectEnum;
|
|
10199
|
-
/**
|
|
10200
|
-
* Whether the price can be used for new purchases.
|
|
10201
|
-
* @type {boolean}
|
|
10202
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10203
|
-
*/
|
|
10204
|
-
'active': boolean;
|
|
10205
|
-
/**
|
|
10206
|
-
*
|
|
10207
|
-
* @type {StripeStripePriceBillingScheme}
|
|
10208
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10209
|
-
*/
|
|
10210
|
-
'billing_scheme': StripeStripePriceBillingScheme;
|
|
10211
|
-
/**
|
|
10212
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
10213
|
-
* @type {number}
|
|
10214
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10215
|
-
*/
|
|
10216
|
-
'created': number;
|
|
10217
|
-
/**
|
|
10218
|
-
* 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).
|
|
10219
|
-
* @type {string}
|
|
10220
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10221
|
-
*/
|
|
10222
|
-
'currency': string;
|
|
10223
|
-
/**
|
|
10224
|
-
* 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).
|
|
10225
|
-
* @type {{ [key: string]: StripeStripePriceCurrencyOptions; }}
|
|
10226
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10227
|
-
*/
|
|
10228
|
-
'currency_options'?: { [key: string]: StripeStripePriceCurrencyOptions; };
|
|
10229
|
-
/**
|
|
10230
|
-
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
10231
|
-
* @type {StripeStripePriceCustomUnitAmount}
|
|
10232
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10233
|
-
*/
|
|
10234
|
-
'custom_unit_amount': StripeStripePriceCustomUnitAmount | null;
|
|
10235
|
-
/**
|
|
10236
|
-
* Always true for a deleted object
|
|
10237
|
-
* @type {any}
|
|
10238
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10239
|
-
*/
|
|
10240
|
-
'deleted'?: any;
|
|
10241
|
-
/**
|
|
10242
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
10243
|
-
* @type {boolean}
|
|
10244
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10245
|
-
*/
|
|
10246
|
-
'livemode': boolean;
|
|
10247
|
-
/**
|
|
10248
|
-
* A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
|
10249
|
-
* @type {string}
|
|
10250
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10251
|
-
*/
|
|
10252
|
-
'lookup_key': string | null;
|
|
10253
|
-
/**
|
|
10254
|
-
* Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
10255
|
-
* @type {{ [key: string]: string; }}
|
|
10256
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10257
|
-
*/
|
|
10258
|
-
'metadata': { [key: string]: string; };
|
|
10259
|
-
/**
|
|
10260
|
-
* A brief description of the price, hidden from customers.
|
|
10261
|
-
* @type {string}
|
|
10262
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10263
|
-
*/
|
|
10264
|
-
'nickname': string | null;
|
|
10265
|
-
/**
|
|
10266
|
-
*
|
|
10267
|
-
* @type {StripeStripePriceProduct}
|
|
10268
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10269
|
-
*/
|
|
10270
|
-
'product': StripeStripePriceProduct;
|
|
10271
|
-
/**
|
|
10272
|
-
* The recurring components of a price such as `interval` and `usage_type`.
|
|
10273
|
-
* @type {StripeStripePriceRecurring}
|
|
10274
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10275
|
-
*/
|
|
10276
|
-
'recurring': StripeStripePriceRecurring | null;
|
|
10277
|
-
/**
|
|
10278
|
-
* 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.
|
|
10279
|
-
* @type {StripeStripePriceTaxBehavior}
|
|
10280
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10281
|
-
*/
|
|
10282
|
-
'tax_behavior': StripeStripePriceTaxBehavior | null;
|
|
10283
|
-
/**
|
|
10284
|
-
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
10285
|
-
* @type {Array<StripeStripePriceTier>}
|
|
10286
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10287
|
-
*/
|
|
10288
|
-
'tiers'?: Array<StripeStripePriceTier>;
|
|
10289
|
-
/**
|
|
10290
|
-
* Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
|
|
10291
|
-
* @type {StripeStripePriceTiersMode}
|
|
10292
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10293
|
-
*/
|
|
10294
|
-
'tiers_mode': StripeStripePriceTiersMode | null;
|
|
10295
|
-
/**
|
|
10296
|
-
* Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
|
|
10297
|
-
* @type {StripeStripePriceTransformQuantity}
|
|
10298
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10299
|
-
*/
|
|
10300
|
-
'transform_quantity': StripeStripePriceTransformQuantity | null;
|
|
10301
|
-
/**
|
|
10302
|
-
*
|
|
10303
|
-
* @type {StripeStripePriceType}
|
|
10304
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10305
|
-
*/
|
|
10306
|
-
'type': StripeStripePriceType;
|
|
10307
|
-
/**
|
|
10308
|
-
* The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
|
|
10309
|
-
* @type {number}
|
|
10310
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10311
|
-
*/
|
|
10312
|
-
'unit_amount': number | null;
|
|
10313
|
-
/**
|
|
10314
|
-
* The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
|
|
10315
|
-
* @type {string}
|
|
10316
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10317
|
-
*/
|
|
10318
|
-
'unit_amount_decimal': string | null;
|
|
10319
|
-
/**
|
|
10320
|
-
*
|
|
10321
|
-
* @type {StripeStripeResponseStripeStripePriceAllOfLastResponse}
|
|
10322
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10323
|
-
*/
|
|
10324
|
-
'lastResponse': StripeStripeResponseStripeStripePriceAllOfLastResponse;
|
|
10325
|
-
}
|
|
10326
|
-
|
|
10327
|
-
export const StripeStripeResponseStripeStripePriceObjectEnum = {
|
|
10328
|
-
Price: 'price'
|
|
10329
|
-
} as const;
|
|
10330
|
-
|
|
10331
|
-
export type StripeStripeResponseStripeStripePriceObjectEnum = typeof StripeStripeResponseStripeStripePriceObjectEnum[keyof typeof StripeStripeResponseStripeStripePriceObjectEnum];
|
|
10332
|
-
|
|
10333
|
-
/**
|
|
10334
|
-
*
|
|
10335
|
-
* @export
|
|
10336
|
-
* @interface StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10337
|
-
*/
|
|
10338
|
-
export interface StripeStripeResponseStripeStripePriceAllOfLastResponse {
|
|
10339
|
-
/**
|
|
10340
|
-
*
|
|
10341
|
-
* @type {string}
|
|
10342
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10343
|
-
*/
|
|
10344
|
-
'stripeAccount'?: string;
|
|
10345
|
-
/**
|
|
10346
|
-
*
|
|
10347
|
-
* @type {string}
|
|
10348
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10349
|
-
*/
|
|
10350
|
-
'idempotencyKey'?: string;
|
|
10351
|
-
/**
|
|
10352
|
-
*
|
|
10353
|
-
* @type {string}
|
|
10354
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10355
|
-
*/
|
|
10356
|
-
'apiVersion'?: string;
|
|
10357
|
-
/**
|
|
10358
|
-
*
|
|
10359
|
-
* @type {number}
|
|
10360
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10361
|
-
*/
|
|
10362
|
-
'statusCode': number;
|
|
10363
|
-
/**
|
|
10364
|
-
*
|
|
10365
|
-
* @type {string}
|
|
10366
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10367
|
-
*/
|
|
10368
|
-
'requestId': string;
|
|
10369
|
-
/**
|
|
10370
|
-
*
|
|
10371
|
-
* @type {{ [key: string]: string; }}
|
|
10372
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10373
|
-
*/
|
|
10374
|
-
'headers': { [key: string]: string; };
|
|
10375
|
-
}
|
|
10376
|
-
/**
|
|
10377
|
-
* [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
|
|
10378
|
-
* @export
|
|
10379
|
-
* @interface StripeStripeTaxCode
|
|
10380
|
-
*/
|
|
10381
|
-
export interface StripeStripeTaxCode {
|
|
10382
|
-
/**
|
|
10383
|
-
* Unique identifier for the object.
|
|
10384
|
-
* @type {string}
|
|
10385
|
-
* @memberof StripeStripeTaxCode
|
|
10386
|
-
*/
|
|
10387
|
-
'id': string;
|
|
10388
|
-
/**
|
|
10389
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
10390
|
-
* @type {string}
|
|
10391
|
-
* @memberof StripeStripeTaxCode
|
|
10392
|
-
*/
|
|
10393
|
-
'object': StripeStripeTaxCodeObjectEnum;
|
|
10394
|
-
/**
|
|
10395
|
-
* A detailed description of which types of products the tax code represents.
|
|
10396
|
-
* @type {string}
|
|
10397
|
-
* @memberof StripeStripeTaxCode
|
|
10398
|
-
*/
|
|
10399
|
-
'description': string;
|
|
10400
|
-
/**
|
|
10401
|
-
* A short name for the tax code.
|
|
10402
|
-
* @type {string}
|
|
10403
|
-
* @memberof StripeStripeTaxCode
|
|
10404
|
-
*/
|
|
10405
|
-
'name': string;
|
|
10406
|
-
}
|
|
10407
|
-
|
|
10408
|
-
export const StripeStripeTaxCodeObjectEnum = {
|
|
10409
|
-
TaxCode: 'tax_code'
|
|
10410
|
-
} as const;
|
|
10411
|
-
|
|
10412
|
-
export type StripeStripeTaxCodeObjectEnum = typeof StripeStripeTaxCodeObjectEnum[keyof typeof StripeStripeTaxCodeObjectEnum];
|
|
10413
|
-
|
|
10414
9154
|
/**
|
|
10415
9155
|
*
|
|
10416
9156
|
* @export
|
|
@@ -10550,12 +9290,88 @@ export interface SubscriptionPlanDiscountResponse {
|
|
|
10550
9290
|
}
|
|
10551
9291
|
|
|
10552
9292
|
|
|
9293
|
+
/**
|
|
9294
|
+
*
|
|
9295
|
+
* @export
|
|
9296
|
+
* @interface SubscriptionPlanDiscountUpdateRequest
|
|
9297
|
+
*/
|
|
9298
|
+
export interface SubscriptionPlanDiscountUpdateRequest {
|
|
9299
|
+
/**
|
|
9300
|
+
*
|
|
9301
|
+
* @type {DiscountType}
|
|
9302
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9303
|
+
*/
|
|
9304
|
+
'type': DiscountType;
|
|
9305
|
+
/**
|
|
9306
|
+
*
|
|
9307
|
+
* @type {number}
|
|
9308
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9309
|
+
*/
|
|
9310
|
+
'percentage'?: number;
|
|
9311
|
+
/**
|
|
9312
|
+
*
|
|
9313
|
+
* @type {number}
|
|
9314
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9315
|
+
*/
|
|
9316
|
+
'maxDiscountAmountInCents'?: number;
|
|
9317
|
+
/**
|
|
9318
|
+
*
|
|
9319
|
+
* @type {SubscriptionPlanDiscountUpdateRequestValidFrom}
|
|
9320
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9321
|
+
*/
|
|
9322
|
+
'validFrom'?: SubscriptionPlanDiscountUpdateRequestValidFrom;
|
|
9323
|
+
/**
|
|
9324
|
+
*
|
|
9325
|
+
* @type {SubscriptionPlanDiscountUpdateRequestValidFrom}
|
|
9326
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9327
|
+
*/
|
|
9328
|
+
'validTo'?: SubscriptionPlanDiscountUpdateRequestValidFrom;
|
|
9329
|
+
/**
|
|
9330
|
+
*
|
|
9331
|
+
* @type {Array<string>}
|
|
9332
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9333
|
+
*/
|
|
9334
|
+
'offPeakRuleNames'?: Array<string>;
|
|
9335
|
+
/**
|
|
9336
|
+
*
|
|
9337
|
+
* @type {Array<OffPeakRule>}
|
|
9338
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9339
|
+
*/
|
|
9340
|
+
'offPeakRules'?: Array<OffPeakRule>;
|
|
9341
|
+
/**
|
|
9342
|
+
*
|
|
9343
|
+
* @type {Array<string>}
|
|
9344
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9345
|
+
*/
|
|
9346
|
+
'pricingPeriodIds'?: Array<string>;
|
|
9347
|
+
/**
|
|
9348
|
+
*
|
|
9349
|
+
* @type {boolean}
|
|
9350
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9351
|
+
*/
|
|
9352
|
+
'bookingFree'?: boolean;
|
|
9353
|
+
}
|
|
9354
|
+
|
|
9355
|
+
|
|
9356
|
+
/**
|
|
9357
|
+
*
|
|
9358
|
+
* @export
|
|
9359
|
+
* @interface SubscriptionPlanDiscountUpdateRequestValidFrom
|
|
9360
|
+
*/
|
|
9361
|
+
export interface SubscriptionPlanDiscountUpdateRequestValidFrom {
|
|
9362
|
+
}
|
|
10553
9363
|
/**
|
|
10554
9364
|
*
|
|
10555
9365
|
* @export
|
|
10556
9366
|
* @interface SubscriptionPlanResponse
|
|
10557
9367
|
*/
|
|
10558
9368
|
export interface SubscriptionPlanResponse {
|
|
9369
|
+
/**
|
|
9370
|
+
*
|
|
9371
|
+
* @type {string}
|
|
9372
|
+
* @memberof SubscriptionPlanResponse
|
|
9373
|
+
*/
|
|
9374
|
+
'planId': string;
|
|
10559
9375
|
/**
|
|
10560
9376
|
*
|
|
10561
9377
|
* @type {string}
|
|
@@ -11265,25 +10081,6 @@ export interface UpdateLevelBySportsRequestBody {
|
|
|
11265
10081
|
*/
|
|
11266
10082
|
'levelBySports': Array<LevelBySportEntry>;
|
|
11267
10083
|
}
|
|
11268
|
-
/**
|
|
11269
|
-
*
|
|
11270
|
-
* @export
|
|
11271
|
-
* @interface UpdatePlanRequest
|
|
11272
|
-
*/
|
|
11273
|
-
export interface UpdatePlanRequest {
|
|
11274
|
-
/**
|
|
11275
|
-
*
|
|
11276
|
-
* @type {number}
|
|
11277
|
-
* @memberof UpdatePlanRequest
|
|
11278
|
-
*/
|
|
11279
|
-
'newAmountInCents': number;
|
|
11280
|
-
/**
|
|
11281
|
-
*
|
|
11282
|
-
* @type {string}
|
|
11283
|
-
* @memberof UpdatePlanRequest
|
|
11284
|
-
*/
|
|
11285
|
-
'oldPriceId': string;
|
|
11286
|
-
}
|
|
11287
10084
|
/**
|
|
11288
10085
|
*
|
|
11289
10086
|
* @export
|
|
@@ -11499,6 +10296,63 @@ export interface UpdateSubscriptionPlanForClub200Response {
|
|
|
11499
10296
|
*/
|
|
11500
10297
|
'price': any;
|
|
11501
10298
|
}
|
|
10299
|
+
/**
|
|
10300
|
+
*
|
|
10301
|
+
* @export
|
|
10302
|
+
* @interface UpdateSubscriptionPlanRequest
|
|
10303
|
+
*/
|
|
10304
|
+
export interface UpdateSubscriptionPlanRequest {
|
|
10305
|
+
/**
|
|
10306
|
+
*
|
|
10307
|
+
* @type {string}
|
|
10308
|
+
* @memberof UpdateSubscriptionPlanRequest
|
|
10309
|
+
*/
|
|
10310
|
+
'productId': string;
|
|
10311
|
+
/**
|
|
10312
|
+
*
|
|
10313
|
+
* @type {string}
|
|
10314
|
+
* @memberof UpdateSubscriptionPlanRequest
|
|
10315
|
+
*/
|
|
10316
|
+
'priceId'?: string;
|
|
10317
|
+
/**
|
|
10318
|
+
*
|
|
10319
|
+
* @type {string}
|
|
10320
|
+
* @memberof UpdateSubscriptionPlanRequest
|
|
10321
|
+
*/
|
|
10322
|
+
'name'?: string;
|
|
10323
|
+
/**
|
|
10324
|
+
*
|
|
10325
|
+
* @type {string}
|
|
10326
|
+
* @memberof UpdateSubscriptionPlanRequest
|
|
10327
|
+
*/
|
|
10328
|
+
'description'?: string;
|
|
10329
|
+
/**
|
|
10330
|
+
*
|
|
10331
|
+
* @type {string}
|
|
10332
|
+
* @memberof UpdateSubscriptionPlanRequest
|
|
10333
|
+
*/
|
|
10334
|
+
'currency'?: string;
|
|
10335
|
+
/**
|
|
10336
|
+
*
|
|
10337
|
+
* @type {PlanInterval}
|
|
10338
|
+
* @memberof UpdateSubscriptionPlanRequest
|
|
10339
|
+
*/
|
|
10340
|
+
'interval'?: PlanInterval;
|
|
10341
|
+
/**
|
|
10342
|
+
*
|
|
10343
|
+
* @type {SubscriptionPlanDiscountUpdateRequest}
|
|
10344
|
+
* @memberof UpdateSubscriptionPlanRequest
|
|
10345
|
+
*/
|
|
10346
|
+
'discount'?: SubscriptionPlanDiscountUpdateRequest;
|
|
10347
|
+
/**
|
|
10348
|
+
*
|
|
10349
|
+
* @type {number}
|
|
10350
|
+
* @memberof UpdateSubscriptionPlanRequest
|
|
10351
|
+
*/
|
|
10352
|
+
'newAmountInCents'?: number;
|
|
10353
|
+
}
|
|
10354
|
+
|
|
10355
|
+
|
|
11502
10356
|
/**
|
|
11503
10357
|
*
|
|
11504
10358
|
* @export
|
|
@@ -23948,14 +22802,14 @@ export const SubscriptionsManagerApiAxiosParamCreator = function (configuration?
|
|
|
23948
22802
|
};
|
|
23949
22803
|
},
|
|
23950
22804
|
/**
|
|
23951
|
-
* Met à jour un plan en
|
|
23952
|
-
* @param {
|
|
22805
|
+
* Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
|
|
22806
|
+
* @param {UpdateSubscriptionPlanRequest} updateSubscriptionPlanRequest
|
|
23953
22807
|
* @param {*} [options] Override http request option.
|
|
23954
22808
|
* @throws {RequiredError}
|
|
23955
22809
|
*/
|
|
23956
|
-
updatePlan: async (
|
|
23957
|
-
// verify required parameter '
|
|
23958
|
-
assertParamExists('updatePlan', '
|
|
22810
|
+
updatePlan: async (updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22811
|
+
// verify required parameter 'updateSubscriptionPlanRequest' is not null or undefined
|
|
22812
|
+
assertParamExists('updatePlan', 'updateSubscriptionPlanRequest', updateSubscriptionPlanRequest)
|
|
23959
22813
|
const localVarPath = `/api/subscriptions/plans`;
|
|
23960
22814
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23961
22815
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -23979,7 +22833,7 @@ export const SubscriptionsManagerApiAxiosParamCreator = function (configuration?
|
|
|
23979
22833
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23980
22834
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23981
22835
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
23982
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
22836
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateSubscriptionPlanRequest, localVarRequestOptions, configuration)
|
|
23983
22837
|
|
|
23984
22838
|
return {
|
|
23985
22839
|
url: toPathString(localVarUrlObj),
|
|
@@ -24033,13 +22887,13 @@ export const SubscriptionsManagerApiFp = function(configuration?: Configuration)
|
|
|
24033
22887
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24034
22888
|
},
|
|
24035
22889
|
/**
|
|
24036
|
-
* Met à jour un plan en
|
|
24037
|
-
* @param {
|
|
22890
|
+
* Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
|
|
22891
|
+
* @param {UpdateSubscriptionPlanRequest} updateSubscriptionPlanRequest
|
|
24038
22892
|
* @param {*} [options] Override http request option.
|
|
24039
22893
|
* @throws {RequiredError}
|
|
24040
22894
|
*/
|
|
24041
|
-
async updatePlan(
|
|
24042
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlan(
|
|
22895
|
+
async updatePlan(updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
22896
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlan(updateSubscriptionPlanRequest, options);
|
|
24043
22897
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24044
22898
|
const localVarOperationServerBasePath = operationServerMap['SubscriptionsManagerApi.updatePlan']?.[localVarOperationServerIndex]?.url;
|
|
24045
22899
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -24082,13 +22936,13 @@ export const SubscriptionsManagerApiFactory = function (configuration?: Configur
|
|
|
24082
22936
|
return localVarFp.deletePlan(requestParameters.productId, options).then((request) => request(axios, basePath));
|
|
24083
22937
|
},
|
|
24084
22938
|
/**
|
|
24085
|
-
* Met à jour un plan en
|
|
22939
|
+
* Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
|
|
24086
22940
|
* @param {SubscriptionsManagerApiUpdatePlanRequest} requestParameters Request parameters.
|
|
24087
22941
|
* @param {*} [options] Override http request option.
|
|
24088
22942
|
* @throws {RequiredError}
|
|
24089
22943
|
*/
|
|
24090
|
-
updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
24091
|
-
return localVarFp.updatePlan(requestParameters.
|
|
22944
|
+
updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<any> {
|
|
22945
|
+
return localVarFp.updatePlan(requestParameters.updateSubscriptionPlanRequest, options).then((request) => request(axios, basePath));
|
|
24092
22946
|
},
|
|
24093
22947
|
};
|
|
24094
22948
|
};
|
|
@@ -24143,10 +22997,10 @@ export interface SubscriptionsManagerApiDeletePlanRequest {
|
|
|
24143
22997
|
export interface SubscriptionsManagerApiUpdatePlanRequest {
|
|
24144
22998
|
/**
|
|
24145
22999
|
*
|
|
24146
|
-
* @type {
|
|
23000
|
+
* @type {UpdateSubscriptionPlanRequest}
|
|
24147
23001
|
* @memberof SubscriptionsManagerApiUpdatePlan
|
|
24148
23002
|
*/
|
|
24149
|
-
readonly
|
|
23003
|
+
readonly updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest
|
|
24150
23004
|
}
|
|
24151
23005
|
|
|
24152
23006
|
/**
|
|
@@ -24190,14 +23044,14 @@ export class SubscriptionsManagerApi extends BaseAPI {
|
|
|
24190
23044
|
}
|
|
24191
23045
|
|
|
24192
23046
|
/**
|
|
24193
|
-
* Met à jour un plan en
|
|
23047
|
+
* Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
|
|
24194
23048
|
* @param {SubscriptionsManagerApiUpdatePlanRequest} requestParameters Request parameters.
|
|
24195
23049
|
* @param {*} [options] Override http request option.
|
|
24196
23050
|
* @throws {RequiredError}
|
|
24197
23051
|
* @memberof SubscriptionsManagerApi
|
|
24198
23052
|
*/
|
|
24199
23053
|
public updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig) {
|
|
24200
|
-
return SubscriptionsManagerApiFp(this.configuration).updatePlan(requestParameters.
|
|
23054
|
+
return SubscriptionsManagerApiFp(this.configuration).updatePlan(requestParameters.updateSubscriptionPlanRequest, options).then((request) => request(this.axios, this.basePath));
|
|
24201
23055
|
}
|
|
24202
23056
|
}
|
|
24203
23057
|
|