@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.
Files changed (40) hide show
  1. package/.openapi-generator/FILES +337 -362
  2. package/README.md +3 -28
  3. package/api.ts +150 -1296
  4. package/dist/api.d.ts +141 -1243
  5. package/dist/api.js +18 -127
  6. package/dist/esm/api.d.ts +141 -1243
  7. package/dist/esm/api.js +14 -123
  8. package/docs/SubscriptionPlanDiscountUpdateRequest.md +36 -0
  9. package/docs/{UpdatePlanRequest.md → SubscriptionPlanDiscountUpdateRequestValidFrom.md} +3 -7
  10. package/docs/SubscriptionPlanResponse.md +2 -0
  11. package/docs/SubscriptionsManagerApi.md +7 -7
  12. package/docs/UpdateSubscriptionPlanRequest.md +34 -0
  13. package/package.json +1 -1
  14. package/docs/StripeStripeDeletedProduct.md +0 -25
  15. package/docs/StripeStripePrice.md +0 -63
  16. package/docs/StripeStripePriceBillingScheme.md +0 -10
  17. package/docs/StripeStripePriceCurrencyOptions.md +0 -28
  18. package/docs/StripeStripePriceCurrencyOptionsCustomUnitAmount.md +0 -24
  19. package/docs/StripeStripePriceCurrencyOptionsTaxBehavior.md +0 -12
  20. package/docs/StripeStripePriceCurrencyOptionsTier.md +0 -28
  21. package/docs/StripeStripePriceCustomUnitAmount.md +0 -24
  22. package/docs/StripeStripePriceProduct.md +0 -59
  23. package/docs/StripeStripePriceRecurring.md +0 -28
  24. package/docs/StripeStripePriceRecurringInterval.md +0 -14
  25. package/docs/StripeStripePriceRecurringUsageType.md +0 -10
  26. package/docs/StripeStripePriceTaxBehavior.md +0 -12
  27. package/docs/StripeStripePriceTier.md +0 -28
  28. package/docs/StripeStripePriceTiersMode.md +0 -10
  29. package/docs/StripeStripePriceTransformQuantity.md +0 -22
  30. package/docs/StripeStripePriceTransformQuantityRound.md +0 -10
  31. package/docs/StripeStripePriceType.md +0 -10
  32. package/docs/StripeStripeProduct.md +0 -59
  33. package/docs/StripeStripeProductDefaultPrice.md +0 -63
  34. package/docs/StripeStripeProductMarketingFeature.md +0 -20
  35. package/docs/StripeStripeProductPackageDimensions.md +0 -26
  36. package/docs/StripeStripeProductTaxCode.md +0 -27
  37. package/docs/StripeStripeProductType.md +0 -10
  38. package/docs/StripeStripeResponseStripeStripePrice.md +0 -64
  39. package/docs/StripeStripeResponseStripeStripePriceAllOfLastResponse.md +0 -30
  40. package/docs/StripeStripeTaxCode.md +0 -27
package/dist/esm/api.d.ts CHANGED
@@ -8988,1218 +8988,6 @@ export interface StaffUserProfileResponse {
8988
8988
  */
8989
8989
  'creditOnMyClub'?: number;
8990
8990
  }
8991
- /**
8992
- * The DeletedProduct object.
8993
- * @export
8994
- * @interface StripeStripeDeletedProduct
8995
- */
8996
- export interface StripeStripeDeletedProduct {
8997
- /**
8998
- * Unique identifier for the object.
8999
- * @type {string}
9000
- * @memberof StripeStripeDeletedProduct
9001
- */
9002
- 'id': string;
9003
- /**
9004
- * String representing the object\'s type. Objects of the same type share the same value.
9005
- * @type {string}
9006
- * @memberof StripeStripeDeletedProduct
9007
- */
9008
- 'object': StripeStripeDeletedProductObjectEnum;
9009
- /**
9010
- * Always true for a deleted object
9011
- * @type {boolean}
9012
- * @memberof StripeStripeDeletedProduct
9013
- */
9014
- 'deleted': boolean;
9015
- }
9016
- export declare const StripeStripeDeletedProductObjectEnum: {
9017
- readonly Product: "product";
9018
- };
9019
- export type StripeStripeDeletedProductObjectEnum = typeof StripeStripeDeletedProductObjectEnum[keyof typeof StripeStripeDeletedProductObjectEnum];
9020
- /**
9021
- * 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).
9022
- * @export
9023
- * @interface StripeStripePrice
9024
- */
9025
- export interface StripeStripePrice {
9026
- /**
9027
- * Unique identifier for the object.
9028
- * @type {string}
9029
- * @memberof StripeStripePrice
9030
- */
9031
- 'id': string;
9032
- /**
9033
- * String representing the object\'s type. Objects of the same type share the same value.
9034
- * @type {string}
9035
- * @memberof StripeStripePrice
9036
- */
9037
- 'object': StripeStripePriceObjectEnum;
9038
- /**
9039
- * Whether the price can be used for new purchases.
9040
- * @type {boolean}
9041
- * @memberof StripeStripePrice
9042
- */
9043
- 'active': boolean;
9044
- /**
9045
- *
9046
- * @type {StripeStripePriceBillingScheme}
9047
- * @memberof StripeStripePrice
9048
- */
9049
- 'billing_scheme': StripeStripePriceBillingScheme;
9050
- /**
9051
- * Time at which the object was created. Measured in seconds since the Unix epoch.
9052
- * @type {number}
9053
- * @memberof StripeStripePrice
9054
- */
9055
- 'created': number;
9056
- /**
9057
- * 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).
9058
- * @type {string}
9059
- * @memberof StripeStripePrice
9060
- */
9061
- 'currency': string;
9062
- /**
9063
- * 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).
9064
- * @type {{ [key: string]: StripeStripePriceCurrencyOptions; }}
9065
- * @memberof StripeStripePrice
9066
- */
9067
- 'currency_options'?: {
9068
- [key: string]: StripeStripePriceCurrencyOptions;
9069
- };
9070
- /**
9071
- * When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
9072
- * @type {StripeStripePriceCustomUnitAmount}
9073
- * @memberof StripeStripePrice
9074
- */
9075
- 'custom_unit_amount': StripeStripePriceCustomUnitAmount | null;
9076
- /**
9077
- * Always true for a deleted object
9078
- * @type {any}
9079
- * @memberof StripeStripePrice
9080
- */
9081
- 'deleted'?: any;
9082
- /**
9083
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
9084
- * @type {boolean}
9085
- * @memberof StripeStripePrice
9086
- */
9087
- 'livemode': boolean;
9088
- /**
9089
- * A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
9090
- * @type {string}
9091
- * @memberof StripeStripePrice
9092
- */
9093
- 'lookup_key': string | null;
9094
- /**
9095
- * 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.
9096
- * @type {{ [key: string]: string; }}
9097
- * @memberof StripeStripePrice
9098
- */
9099
- 'metadata': {
9100
- [key: string]: string;
9101
- };
9102
- /**
9103
- * A brief description of the price, hidden from customers.
9104
- * @type {string}
9105
- * @memberof StripeStripePrice
9106
- */
9107
- 'nickname': string | null;
9108
- /**
9109
- *
9110
- * @type {StripeStripePriceProduct}
9111
- * @memberof StripeStripePrice
9112
- */
9113
- 'product': StripeStripePriceProduct;
9114
- /**
9115
- * The recurring components of a price such as `interval` and `usage_type`.
9116
- * @type {StripeStripePriceRecurring}
9117
- * @memberof StripeStripePrice
9118
- */
9119
- 'recurring': StripeStripePriceRecurring | null;
9120
- /**
9121
- * 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.
9122
- * @type {StripeStripePriceTaxBehavior}
9123
- * @memberof StripeStripePrice
9124
- */
9125
- 'tax_behavior': StripeStripePriceTaxBehavior | null;
9126
- /**
9127
- * Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
9128
- * @type {Array<StripeStripePriceTier>}
9129
- * @memberof StripeStripePrice
9130
- */
9131
- 'tiers'?: Array<StripeStripePriceTier>;
9132
- /**
9133
- * 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.
9134
- * @type {StripeStripePriceTiersMode}
9135
- * @memberof StripeStripePrice
9136
- */
9137
- 'tiers_mode': StripeStripePriceTiersMode | null;
9138
- /**
9139
- * Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
9140
- * @type {StripeStripePriceTransformQuantity}
9141
- * @memberof StripeStripePrice
9142
- */
9143
- 'transform_quantity': StripeStripePriceTransformQuantity | null;
9144
- /**
9145
- *
9146
- * @type {StripeStripePriceType}
9147
- * @memberof StripeStripePrice
9148
- */
9149
- 'type': StripeStripePriceType;
9150
- /**
9151
- * 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`.
9152
- * @type {number}
9153
- * @memberof StripeStripePrice
9154
- */
9155
- 'unit_amount': number | null;
9156
- /**
9157
- * 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`.
9158
- * @type {string}
9159
- * @memberof StripeStripePrice
9160
- */
9161
- 'unit_amount_decimal': string | null;
9162
- }
9163
- export declare const StripeStripePriceObjectEnum: {
9164
- readonly Price: "price";
9165
- };
9166
- export type StripeStripePriceObjectEnum = typeof StripeStripePriceObjectEnum[keyof typeof StripeStripePriceObjectEnum];
9167
- /**
9168
- *
9169
- * @export
9170
- * @enum {string}
9171
- */
9172
- export declare const StripeStripePriceBillingScheme: {
9173
- readonly PerUnit: "per_unit";
9174
- readonly Tiered: "tiered";
9175
- };
9176
- export type StripeStripePriceBillingScheme = typeof StripeStripePriceBillingScheme[keyof typeof StripeStripePriceBillingScheme];
9177
- /**
9178
- *
9179
- * @export
9180
- * @interface StripeStripePriceCurrencyOptions
9181
- */
9182
- export interface StripeStripePriceCurrencyOptions {
9183
- /**
9184
- * When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
9185
- * @type {StripeStripePriceCurrencyOptionsCustomUnitAmount}
9186
- * @memberof StripeStripePriceCurrencyOptions
9187
- */
9188
- 'custom_unit_amount': StripeStripePriceCurrencyOptionsCustomUnitAmount | null;
9189
- /**
9190
- * 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.
9191
- * @type {StripeStripePriceCurrencyOptionsTaxBehavior}
9192
- * @memberof StripeStripePriceCurrencyOptions
9193
- */
9194
- 'tax_behavior': StripeStripePriceCurrencyOptionsTaxBehavior | null;
9195
- /**
9196
- * Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
9197
- * @type {Array<StripeStripePriceCurrencyOptionsTier>}
9198
- * @memberof StripeStripePriceCurrencyOptions
9199
- */
9200
- 'tiers'?: Array<StripeStripePriceCurrencyOptionsTier>;
9201
- /**
9202
- * 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`.
9203
- * @type {number}
9204
- * @memberof StripeStripePriceCurrencyOptions
9205
- */
9206
- 'unit_amount': number | null;
9207
- /**
9208
- * 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`.
9209
- * @type {string}
9210
- * @memberof StripeStripePriceCurrencyOptions
9211
- */
9212
- 'unit_amount_decimal': string | null;
9213
- }
9214
- /**
9215
- *
9216
- * @export
9217
- * @interface StripeStripePriceCurrencyOptionsCustomUnitAmount
9218
- */
9219
- export interface StripeStripePriceCurrencyOptionsCustomUnitAmount {
9220
- /**
9221
- * The maximum unit amount the customer can specify for this item.
9222
- * @type {number}
9223
- * @memberof StripeStripePriceCurrencyOptionsCustomUnitAmount
9224
- */
9225
- 'maximum': number | null;
9226
- /**
9227
- * The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
9228
- * @type {number}
9229
- * @memberof StripeStripePriceCurrencyOptionsCustomUnitAmount
9230
- */
9231
- 'minimum': number | null;
9232
- /**
9233
- * The starting unit amount which can be updated by the customer.
9234
- * @type {number}
9235
- * @memberof StripeStripePriceCurrencyOptionsCustomUnitAmount
9236
- */
9237
- 'preset': number | null;
9238
- }
9239
- /**
9240
- *
9241
- * @export
9242
- * @enum {string}
9243
- */
9244
- export declare const StripeStripePriceCurrencyOptionsTaxBehavior: {
9245
- readonly Exclusive: "exclusive";
9246
- readonly Inclusive: "inclusive";
9247
- readonly Unspecified: "unspecified";
9248
- };
9249
- export type StripeStripePriceCurrencyOptionsTaxBehavior = typeof StripeStripePriceCurrencyOptionsTaxBehavior[keyof typeof StripeStripePriceCurrencyOptionsTaxBehavior];
9250
- /**
9251
- *
9252
- * @export
9253
- * @interface StripeStripePriceCurrencyOptionsTier
9254
- */
9255
- export interface StripeStripePriceCurrencyOptionsTier {
9256
- /**
9257
- * Price for the entire tier.
9258
- * @type {number}
9259
- * @memberof StripeStripePriceCurrencyOptionsTier
9260
- */
9261
- 'flat_amount': number | null;
9262
- /**
9263
- * Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
9264
- * @type {string}
9265
- * @memberof StripeStripePriceCurrencyOptionsTier
9266
- */
9267
- 'flat_amount_decimal': string | null;
9268
- /**
9269
- * Per unit price for units relevant to the tier.
9270
- * @type {number}
9271
- * @memberof StripeStripePriceCurrencyOptionsTier
9272
- */
9273
- 'unit_amount': number | null;
9274
- /**
9275
- * Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
9276
- * @type {string}
9277
- * @memberof StripeStripePriceCurrencyOptionsTier
9278
- */
9279
- 'unit_amount_decimal': string | null;
9280
- /**
9281
- * Up to and including to this quantity will be contained in the tier.
9282
- * @type {number}
9283
- * @memberof StripeStripePriceCurrencyOptionsTier
9284
- */
9285
- 'up_to': number | null;
9286
- }
9287
- /**
9288
- *
9289
- * @export
9290
- * @interface StripeStripePriceCustomUnitAmount
9291
- */
9292
- export interface StripeStripePriceCustomUnitAmount {
9293
- /**
9294
- * The maximum unit amount the customer can specify for this item.
9295
- * @type {number}
9296
- * @memberof StripeStripePriceCustomUnitAmount
9297
- */
9298
- 'maximum': number | null;
9299
- /**
9300
- * The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
9301
- * @type {number}
9302
- * @memberof StripeStripePriceCustomUnitAmount
9303
- */
9304
- 'minimum': number | null;
9305
- /**
9306
- * The starting unit amount which can be updated by the customer.
9307
- * @type {number}
9308
- * @memberof StripeStripePriceCustomUnitAmount
9309
- */
9310
- 'preset': number | null;
9311
- }
9312
- /**
9313
- * The ID of the product this price is associated with.
9314
- * @export
9315
- * @interface StripeStripePriceProduct
9316
- */
9317
- export interface StripeStripePriceProduct {
9318
- /**
9319
- * Unique identifier for the object.
9320
- * @type {string}
9321
- * @memberof StripeStripePriceProduct
9322
- */
9323
- 'id': string;
9324
- /**
9325
- * String representing the object\'s type. Objects of the same type share the same value.
9326
- * @type {string}
9327
- * @memberof StripeStripePriceProduct
9328
- */
9329
- 'object': StripeStripePriceProductObjectEnum;
9330
- /**
9331
- * Whether the product is currently available for purchase.
9332
- * @type {boolean}
9333
- * @memberof StripeStripePriceProduct
9334
- */
9335
- 'active': boolean;
9336
- /**
9337
- * Time at which the object was created. Measured in seconds since the Unix epoch.
9338
- * @type {number}
9339
- * @memberof StripeStripePriceProduct
9340
- */
9341
- 'created': number;
9342
- /**
9343
- *
9344
- * @type {StripeStripeProductDefaultPrice}
9345
- * @memberof StripeStripePriceProduct
9346
- */
9347
- 'default_price'?: StripeStripeProductDefaultPrice | null;
9348
- /**
9349
- * Always true for a deleted object
9350
- * @type {boolean}
9351
- * @memberof StripeStripePriceProduct
9352
- */
9353
- 'deleted': boolean;
9354
- /**
9355
- * 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.
9356
- * @type {string}
9357
- * @memberof StripeStripePriceProduct
9358
- */
9359
- 'description': string | null;
9360
- /**
9361
- * A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
9362
- * @type {Array<string>}
9363
- * @memberof StripeStripePriceProduct
9364
- */
9365
- 'images': Array<string>;
9366
- /**
9367
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
9368
- * @type {boolean}
9369
- * @memberof StripeStripePriceProduct
9370
- */
9371
- 'livemode': boolean;
9372
- /**
9373
- * 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).
9374
- * @type {Array<StripeStripeProductMarketingFeature>}
9375
- * @memberof StripeStripePriceProduct
9376
- */
9377
- 'marketing_features': Array<StripeStripeProductMarketingFeature>;
9378
- /**
9379
- * 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.
9380
- * @type {{ [key: string]: string; }}
9381
- * @memberof StripeStripePriceProduct
9382
- */
9383
- 'metadata': {
9384
- [key: string]: string;
9385
- };
9386
- /**
9387
- * The product\'s name, meant to be displayable to the customer.
9388
- * @type {string}
9389
- * @memberof StripeStripePriceProduct
9390
- */
9391
- 'name': string;
9392
- /**
9393
- * The dimensions of this product for shipping purposes.
9394
- * @type {StripeStripeProductPackageDimensions}
9395
- * @memberof StripeStripePriceProduct
9396
- */
9397
- 'package_dimensions': StripeStripeProductPackageDimensions | null;
9398
- /**
9399
- * Whether this product is shipped (i.e., physical goods).
9400
- * @type {boolean}
9401
- * @memberof StripeStripePriceProduct
9402
- */
9403
- 'shippable': boolean | null;
9404
- /**
9405
- * 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.
9406
- * @type {string}
9407
- * @memberof StripeStripePriceProduct
9408
- */
9409
- 'statement_descriptor'?: string | null;
9410
- /**
9411
- *
9412
- * @type {StripeStripeProductTaxCode}
9413
- * @memberof StripeStripePriceProduct
9414
- */
9415
- 'tax_code': StripeStripeProductTaxCode | null;
9416
- /**
9417
- *
9418
- * @type {StripeStripeProductType}
9419
- * @memberof StripeStripePriceProduct
9420
- */
9421
- 'type': StripeStripeProductType;
9422
- /**
9423
- * A label that represents units of this product. When set, this will be included in customers\' receipts, invoices, Checkout, and the customer portal.
9424
- * @type {string}
9425
- * @memberof StripeStripePriceProduct
9426
- */
9427
- 'unit_label'?: string | null;
9428
- /**
9429
- * Time at which the object was last updated. Measured in seconds since the Unix epoch.
9430
- * @type {number}
9431
- * @memberof StripeStripePriceProduct
9432
- */
9433
- 'updated': number;
9434
- /**
9435
- * A URL of a publicly-accessible webpage for this product.
9436
- * @type {string}
9437
- * @memberof StripeStripePriceProduct
9438
- */
9439
- 'url': string | null;
9440
- }
9441
- export declare const StripeStripePriceProductObjectEnum: {
9442
- readonly Product: "product";
9443
- };
9444
- export type StripeStripePriceProductObjectEnum = typeof StripeStripePriceProductObjectEnum[keyof typeof StripeStripePriceProductObjectEnum];
9445
- /**
9446
- *
9447
- * @export
9448
- * @interface StripeStripePriceRecurring
9449
- */
9450
- export interface StripeStripePriceRecurring {
9451
- /**
9452
- *
9453
- * @type {StripeStripePriceRecurringInterval}
9454
- * @memberof StripeStripePriceRecurring
9455
- */
9456
- 'interval': StripeStripePriceRecurringInterval;
9457
- /**
9458
- * The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
9459
- * @type {number}
9460
- * @memberof StripeStripePriceRecurring
9461
- */
9462
- 'interval_count': number;
9463
- /**
9464
- * The meter tracking the usage of a metered price
9465
- * @type {string}
9466
- * @memberof StripeStripePriceRecurring
9467
- */
9468
- 'meter': string | null;
9469
- /**
9470
- * 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).
9471
- * @type {number}
9472
- * @memberof StripeStripePriceRecurring
9473
- */
9474
- 'trial_period_days': number | null;
9475
- /**
9476
- *
9477
- * @type {StripeStripePriceRecurringUsageType}
9478
- * @memberof StripeStripePriceRecurring
9479
- */
9480
- 'usage_type': StripeStripePriceRecurringUsageType;
9481
- }
9482
- /**
9483
- *
9484
- * @export
9485
- * @enum {string}
9486
- */
9487
- export declare const StripeStripePriceRecurringInterval: {
9488
- readonly Day: "day";
9489
- readonly Month: "month";
9490
- readonly Week: "week";
9491
- readonly Year: "year";
9492
- };
9493
- export type StripeStripePriceRecurringInterval = typeof StripeStripePriceRecurringInterval[keyof typeof StripeStripePriceRecurringInterval];
9494
- /**
9495
- *
9496
- * @export
9497
- * @enum {string}
9498
- */
9499
- export declare const StripeStripePriceRecurringUsageType: {
9500
- readonly Licensed: "licensed";
9501
- readonly Metered: "metered";
9502
- };
9503
- export type StripeStripePriceRecurringUsageType = typeof StripeStripePriceRecurringUsageType[keyof typeof StripeStripePriceRecurringUsageType];
9504
- /**
9505
- *
9506
- * @export
9507
- * @enum {string}
9508
- */
9509
- export declare const StripeStripePriceTaxBehavior: {
9510
- readonly Exclusive: "exclusive";
9511
- readonly Inclusive: "inclusive";
9512
- readonly Unspecified: "unspecified";
9513
- };
9514
- export type StripeStripePriceTaxBehavior = typeof StripeStripePriceTaxBehavior[keyof typeof StripeStripePriceTaxBehavior];
9515
- /**
9516
- *
9517
- * @export
9518
- * @interface StripeStripePriceTier
9519
- */
9520
- export interface StripeStripePriceTier {
9521
- /**
9522
- * Price for the entire tier.
9523
- * @type {number}
9524
- * @memberof StripeStripePriceTier
9525
- */
9526
- 'flat_amount': number | null;
9527
- /**
9528
- * Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
9529
- * @type {string}
9530
- * @memberof StripeStripePriceTier
9531
- */
9532
- 'flat_amount_decimal': string | null;
9533
- /**
9534
- * Per unit price for units relevant to the tier.
9535
- * @type {number}
9536
- * @memberof StripeStripePriceTier
9537
- */
9538
- 'unit_amount': number | null;
9539
- /**
9540
- * Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
9541
- * @type {string}
9542
- * @memberof StripeStripePriceTier
9543
- */
9544
- 'unit_amount_decimal': string | null;
9545
- /**
9546
- * Up to and including to this quantity will be contained in the tier.
9547
- * @type {number}
9548
- * @memberof StripeStripePriceTier
9549
- */
9550
- 'up_to': number | null;
9551
- }
9552
- /**
9553
- *
9554
- * @export
9555
- * @enum {string}
9556
- */
9557
- export declare const StripeStripePriceTiersMode: {
9558
- readonly Graduated: "graduated";
9559
- readonly Volume: "volume";
9560
- };
9561
- export type StripeStripePriceTiersMode = typeof StripeStripePriceTiersMode[keyof typeof StripeStripePriceTiersMode];
9562
- /**
9563
- *
9564
- * @export
9565
- * @interface StripeStripePriceTransformQuantity
9566
- */
9567
- export interface StripeStripePriceTransformQuantity {
9568
- /**
9569
- * Divide usage by this number.
9570
- * @type {number}
9571
- * @memberof StripeStripePriceTransformQuantity
9572
- */
9573
- 'divide_by': number;
9574
- /**
9575
- *
9576
- * @type {StripeStripePriceTransformQuantityRound}
9577
- * @memberof StripeStripePriceTransformQuantity
9578
- */
9579
- 'round': StripeStripePriceTransformQuantityRound;
9580
- }
9581
- /**
9582
- *
9583
- * @export
9584
- * @enum {string}
9585
- */
9586
- export declare const StripeStripePriceTransformQuantityRound: {
9587
- readonly Down: "down";
9588
- readonly Up: "up";
9589
- };
9590
- export type StripeStripePriceTransformQuantityRound = typeof StripeStripePriceTransformQuantityRound[keyof typeof StripeStripePriceTransformQuantityRound];
9591
- /**
9592
- *
9593
- * @export
9594
- * @enum {string}
9595
- */
9596
- export declare const StripeStripePriceType: {
9597
- readonly OneTime: "one_time";
9598
- readonly Recurring: "recurring";
9599
- };
9600
- export type StripeStripePriceType = typeof StripeStripePriceType[keyof typeof StripeStripePriceType];
9601
- /**
9602
- * 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)
9603
- * @export
9604
- * @interface StripeStripeProduct
9605
- */
9606
- export interface StripeStripeProduct {
9607
- /**
9608
- * Unique identifier for the object.
9609
- * @type {string}
9610
- * @memberof StripeStripeProduct
9611
- */
9612
- 'id': string;
9613
- /**
9614
- * String representing the object\'s type. Objects of the same type share the same value.
9615
- * @type {string}
9616
- * @memberof StripeStripeProduct
9617
- */
9618
- 'object': StripeStripeProductObjectEnum;
9619
- /**
9620
- * Whether the product is currently available for purchase.
9621
- * @type {boolean}
9622
- * @memberof StripeStripeProduct
9623
- */
9624
- 'active': boolean;
9625
- /**
9626
- * Time at which the object was created. Measured in seconds since the Unix epoch.
9627
- * @type {number}
9628
- * @memberof StripeStripeProduct
9629
- */
9630
- 'created': number;
9631
- /**
9632
- *
9633
- * @type {StripeStripeProductDefaultPrice}
9634
- * @memberof StripeStripeProduct
9635
- */
9636
- 'default_price'?: StripeStripeProductDefaultPrice | null;
9637
- /**
9638
- * Always true for a deleted object
9639
- * @type {any}
9640
- * @memberof StripeStripeProduct
9641
- */
9642
- 'deleted'?: any;
9643
- /**
9644
- * 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.
9645
- * @type {string}
9646
- * @memberof StripeStripeProduct
9647
- */
9648
- 'description': string | null;
9649
- /**
9650
- * A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
9651
- * @type {Array<string>}
9652
- * @memberof StripeStripeProduct
9653
- */
9654
- 'images': Array<string>;
9655
- /**
9656
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
9657
- * @type {boolean}
9658
- * @memberof StripeStripeProduct
9659
- */
9660
- 'livemode': boolean;
9661
- /**
9662
- * 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).
9663
- * @type {Array<StripeStripeProductMarketingFeature>}
9664
- * @memberof StripeStripeProduct
9665
- */
9666
- 'marketing_features': Array<StripeStripeProductMarketingFeature>;
9667
- /**
9668
- * 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.
9669
- * @type {{ [key: string]: string; }}
9670
- * @memberof StripeStripeProduct
9671
- */
9672
- 'metadata': {
9673
- [key: string]: string;
9674
- };
9675
- /**
9676
- * The product\'s name, meant to be displayable to the customer.
9677
- * @type {string}
9678
- * @memberof StripeStripeProduct
9679
- */
9680
- 'name': string;
9681
- /**
9682
- * The dimensions of this product for shipping purposes.
9683
- * @type {StripeStripeProductPackageDimensions}
9684
- * @memberof StripeStripeProduct
9685
- */
9686
- 'package_dimensions': StripeStripeProductPackageDimensions | null;
9687
- /**
9688
- * Whether this product is shipped (i.e., physical goods).
9689
- * @type {boolean}
9690
- * @memberof StripeStripeProduct
9691
- */
9692
- 'shippable': boolean | null;
9693
- /**
9694
- * 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.
9695
- * @type {string}
9696
- * @memberof StripeStripeProduct
9697
- */
9698
- 'statement_descriptor'?: string | null;
9699
- /**
9700
- *
9701
- * @type {StripeStripeProductTaxCode}
9702
- * @memberof StripeStripeProduct
9703
- */
9704
- 'tax_code': StripeStripeProductTaxCode | null;
9705
- /**
9706
- *
9707
- * @type {StripeStripeProductType}
9708
- * @memberof StripeStripeProduct
9709
- */
9710
- 'type': StripeStripeProductType;
9711
- /**
9712
- * A label that represents units of this product. When set, this will be included in customers\' receipts, invoices, Checkout, and the customer portal.
9713
- * @type {string}
9714
- * @memberof StripeStripeProduct
9715
- */
9716
- 'unit_label'?: string | null;
9717
- /**
9718
- * Time at which the object was last updated. Measured in seconds since the Unix epoch.
9719
- * @type {number}
9720
- * @memberof StripeStripeProduct
9721
- */
9722
- 'updated': number;
9723
- /**
9724
- * A URL of a publicly-accessible webpage for this product.
9725
- * @type {string}
9726
- * @memberof StripeStripeProduct
9727
- */
9728
- 'url': string | null;
9729
- }
9730
- export declare const StripeStripeProductObjectEnum: {
9731
- readonly Product: "product";
9732
- };
9733
- export type StripeStripeProductObjectEnum = typeof StripeStripeProductObjectEnum[keyof typeof StripeStripeProductObjectEnum];
9734
- /**
9735
- * The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
9736
- * @export
9737
- * @interface StripeStripeProductDefaultPrice
9738
- */
9739
- export interface StripeStripeProductDefaultPrice {
9740
- /**
9741
- * Unique identifier for the object.
9742
- * @type {string}
9743
- * @memberof StripeStripeProductDefaultPrice
9744
- */
9745
- 'id': string;
9746
- /**
9747
- * String representing the object\'s type. Objects of the same type share the same value.
9748
- * @type {string}
9749
- * @memberof StripeStripeProductDefaultPrice
9750
- */
9751
- 'object': StripeStripeProductDefaultPriceObjectEnum;
9752
- /**
9753
- * Whether the price can be used for new purchases.
9754
- * @type {boolean}
9755
- * @memberof StripeStripeProductDefaultPrice
9756
- */
9757
- 'active': boolean;
9758
- /**
9759
- *
9760
- * @type {StripeStripePriceBillingScheme}
9761
- * @memberof StripeStripeProductDefaultPrice
9762
- */
9763
- 'billing_scheme': StripeStripePriceBillingScheme;
9764
- /**
9765
- * Time at which the object was created. Measured in seconds since the Unix epoch.
9766
- * @type {number}
9767
- * @memberof StripeStripeProductDefaultPrice
9768
- */
9769
- 'created': number;
9770
- /**
9771
- * 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).
9772
- * @type {string}
9773
- * @memberof StripeStripeProductDefaultPrice
9774
- */
9775
- 'currency': string;
9776
- /**
9777
- * 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).
9778
- * @type {{ [key: string]: StripeStripePriceCurrencyOptions; }}
9779
- * @memberof StripeStripeProductDefaultPrice
9780
- */
9781
- 'currency_options'?: {
9782
- [key: string]: StripeStripePriceCurrencyOptions;
9783
- };
9784
- /**
9785
- * When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
9786
- * @type {StripeStripePriceCustomUnitAmount}
9787
- * @memberof StripeStripeProductDefaultPrice
9788
- */
9789
- 'custom_unit_amount': StripeStripePriceCustomUnitAmount | null;
9790
- /**
9791
- * Always true for a deleted object
9792
- * @type {any}
9793
- * @memberof StripeStripeProductDefaultPrice
9794
- */
9795
- 'deleted'?: any;
9796
- /**
9797
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
9798
- * @type {boolean}
9799
- * @memberof StripeStripeProductDefaultPrice
9800
- */
9801
- 'livemode': boolean;
9802
- /**
9803
- * A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
9804
- * @type {string}
9805
- * @memberof StripeStripeProductDefaultPrice
9806
- */
9807
- 'lookup_key': string | null;
9808
- /**
9809
- * 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.
9810
- * @type {{ [key: string]: string; }}
9811
- * @memberof StripeStripeProductDefaultPrice
9812
- */
9813
- 'metadata': {
9814
- [key: string]: string;
9815
- };
9816
- /**
9817
- * A brief description of the price, hidden from customers.
9818
- * @type {string}
9819
- * @memberof StripeStripeProductDefaultPrice
9820
- */
9821
- 'nickname': string | null;
9822
- /**
9823
- *
9824
- * @type {StripeStripePriceProduct}
9825
- * @memberof StripeStripeProductDefaultPrice
9826
- */
9827
- 'product': StripeStripePriceProduct;
9828
- /**
9829
- * The recurring components of a price such as `interval` and `usage_type`.
9830
- * @type {StripeStripePriceRecurring}
9831
- * @memberof StripeStripeProductDefaultPrice
9832
- */
9833
- 'recurring': StripeStripePriceRecurring | null;
9834
- /**
9835
- * 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.
9836
- * @type {StripeStripePriceTaxBehavior}
9837
- * @memberof StripeStripeProductDefaultPrice
9838
- */
9839
- 'tax_behavior': StripeStripePriceTaxBehavior | null;
9840
- /**
9841
- * Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
9842
- * @type {Array<StripeStripePriceTier>}
9843
- * @memberof StripeStripeProductDefaultPrice
9844
- */
9845
- 'tiers'?: Array<StripeStripePriceTier>;
9846
- /**
9847
- * 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.
9848
- * @type {StripeStripePriceTiersMode}
9849
- * @memberof StripeStripeProductDefaultPrice
9850
- */
9851
- 'tiers_mode': StripeStripePriceTiersMode | null;
9852
- /**
9853
- * Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
9854
- * @type {StripeStripePriceTransformQuantity}
9855
- * @memberof StripeStripeProductDefaultPrice
9856
- */
9857
- 'transform_quantity': StripeStripePriceTransformQuantity | null;
9858
- /**
9859
- *
9860
- * @type {StripeStripePriceType}
9861
- * @memberof StripeStripeProductDefaultPrice
9862
- */
9863
- 'type': StripeStripePriceType;
9864
- /**
9865
- * 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`.
9866
- * @type {number}
9867
- * @memberof StripeStripeProductDefaultPrice
9868
- */
9869
- 'unit_amount': number | null;
9870
- /**
9871
- * 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`.
9872
- * @type {string}
9873
- * @memberof StripeStripeProductDefaultPrice
9874
- */
9875
- 'unit_amount_decimal': string | null;
9876
- }
9877
- export declare const StripeStripeProductDefaultPriceObjectEnum: {
9878
- readonly Price: "price";
9879
- };
9880
- export type StripeStripeProductDefaultPriceObjectEnum = typeof StripeStripeProductDefaultPriceObjectEnum[keyof typeof StripeStripeProductDefaultPriceObjectEnum];
9881
- /**
9882
- *
9883
- * @export
9884
- * @interface StripeStripeProductMarketingFeature
9885
- */
9886
- export interface StripeStripeProductMarketingFeature {
9887
- /**
9888
- * The marketing feature name. Up to 80 characters long.
9889
- * @type {string}
9890
- * @memberof StripeStripeProductMarketingFeature
9891
- */
9892
- 'name'?: string;
9893
- }
9894
- /**
9895
- *
9896
- * @export
9897
- * @interface StripeStripeProductPackageDimensions
9898
- */
9899
- export interface StripeStripeProductPackageDimensions {
9900
- /**
9901
- * Height, in inches.
9902
- * @type {number}
9903
- * @memberof StripeStripeProductPackageDimensions
9904
- */
9905
- 'height': number;
9906
- /**
9907
- * Length, in inches.
9908
- * @type {number}
9909
- * @memberof StripeStripeProductPackageDimensions
9910
- */
9911
- 'length': number;
9912
- /**
9913
- * Weight, in ounces.
9914
- * @type {number}
9915
- * @memberof StripeStripeProductPackageDimensions
9916
- */
9917
- 'weight': number;
9918
- /**
9919
- * Width, in inches.
9920
- * @type {number}
9921
- * @memberof StripeStripeProductPackageDimensions
9922
- */
9923
- 'width': number;
9924
- }
9925
- /**
9926
- * A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
9927
- * @export
9928
- * @interface StripeStripeProductTaxCode
9929
- */
9930
- export interface StripeStripeProductTaxCode {
9931
- /**
9932
- * Unique identifier for the object.
9933
- * @type {string}
9934
- * @memberof StripeStripeProductTaxCode
9935
- */
9936
- 'id': string;
9937
- /**
9938
- * String representing the object\'s type. Objects of the same type share the same value.
9939
- * @type {string}
9940
- * @memberof StripeStripeProductTaxCode
9941
- */
9942
- 'object': StripeStripeProductTaxCodeObjectEnum;
9943
- /**
9944
- * A detailed description of which types of products the tax code represents.
9945
- * @type {string}
9946
- * @memberof StripeStripeProductTaxCode
9947
- */
9948
- 'description': string;
9949
- /**
9950
- * A short name for the tax code.
9951
- * @type {string}
9952
- * @memberof StripeStripeProductTaxCode
9953
- */
9954
- 'name': string;
9955
- }
9956
- export declare const StripeStripeProductTaxCodeObjectEnum: {
9957
- readonly TaxCode: "tax_code";
9958
- };
9959
- export type StripeStripeProductTaxCodeObjectEnum = typeof StripeStripeProductTaxCodeObjectEnum[keyof typeof StripeStripeProductTaxCodeObjectEnum];
9960
- /**
9961
- *
9962
- * @export
9963
- * @enum {string}
9964
- */
9965
- export declare const StripeStripeProductType: {
9966
- readonly Good: "good";
9967
- readonly Service: "service";
9968
- };
9969
- export type StripeStripeProductType = typeof StripeStripeProductType[keyof typeof StripeStripeProductType];
9970
- /**
9971
- *
9972
- * @export
9973
- * @interface StripeStripeResponseStripeStripePrice
9974
- */
9975
- export interface StripeStripeResponseStripeStripePrice {
9976
- /**
9977
- * Unique identifier for the object.
9978
- * @type {string}
9979
- * @memberof StripeStripeResponseStripeStripePrice
9980
- */
9981
- 'id': string;
9982
- /**
9983
- * String representing the object\'s type. Objects of the same type share the same value.
9984
- * @type {string}
9985
- * @memberof StripeStripeResponseStripeStripePrice
9986
- */
9987
- 'object': StripeStripeResponseStripeStripePriceObjectEnum;
9988
- /**
9989
- * Whether the price can be used for new purchases.
9990
- * @type {boolean}
9991
- * @memberof StripeStripeResponseStripeStripePrice
9992
- */
9993
- 'active': boolean;
9994
- /**
9995
- *
9996
- * @type {StripeStripePriceBillingScheme}
9997
- * @memberof StripeStripeResponseStripeStripePrice
9998
- */
9999
- 'billing_scheme': StripeStripePriceBillingScheme;
10000
- /**
10001
- * Time at which the object was created. Measured in seconds since the Unix epoch.
10002
- * @type {number}
10003
- * @memberof StripeStripeResponseStripeStripePrice
10004
- */
10005
- 'created': number;
10006
- /**
10007
- * 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).
10008
- * @type {string}
10009
- * @memberof StripeStripeResponseStripeStripePrice
10010
- */
10011
- 'currency': string;
10012
- /**
10013
- * 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).
10014
- * @type {{ [key: string]: StripeStripePriceCurrencyOptions; }}
10015
- * @memberof StripeStripeResponseStripeStripePrice
10016
- */
10017
- 'currency_options'?: {
10018
- [key: string]: StripeStripePriceCurrencyOptions;
10019
- };
10020
- /**
10021
- * When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
10022
- * @type {StripeStripePriceCustomUnitAmount}
10023
- * @memberof StripeStripeResponseStripeStripePrice
10024
- */
10025
- 'custom_unit_amount': StripeStripePriceCustomUnitAmount | null;
10026
- /**
10027
- * Always true for a deleted object
10028
- * @type {any}
10029
- * @memberof StripeStripeResponseStripeStripePrice
10030
- */
10031
- 'deleted'?: any;
10032
- /**
10033
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
10034
- * @type {boolean}
10035
- * @memberof StripeStripeResponseStripeStripePrice
10036
- */
10037
- 'livemode': boolean;
10038
- /**
10039
- * A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
10040
- * @type {string}
10041
- * @memberof StripeStripeResponseStripeStripePrice
10042
- */
10043
- 'lookup_key': string | null;
10044
- /**
10045
- * 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.
10046
- * @type {{ [key: string]: string; }}
10047
- * @memberof StripeStripeResponseStripeStripePrice
10048
- */
10049
- 'metadata': {
10050
- [key: string]: string;
10051
- };
10052
- /**
10053
- * A brief description of the price, hidden from customers.
10054
- * @type {string}
10055
- * @memberof StripeStripeResponseStripeStripePrice
10056
- */
10057
- 'nickname': string | null;
10058
- /**
10059
- *
10060
- * @type {StripeStripePriceProduct}
10061
- * @memberof StripeStripeResponseStripeStripePrice
10062
- */
10063
- 'product': StripeStripePriceProduct;
10064
- /**
10065
- * The recurring components of a price such as `interval` and `usage_type`.
10066
- * @type {StripeStripePriceRecurring}
10067
- * @memberof StripeStripeResponseStripeStripePrice
10068
- */
10069
- 'recurring': StripeStripePriceRecurring | null;
10070
- /**
10071
- * 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.
10072
- * @type {StripeStripePriceTaxBehavior}
10073
- * @memberof StripeStripeResponseStripeStripePrice
10074
- */
10075
- 'tax_behavior': StripeStripePriceTaxBehavior | null;
10076
- /**
10077
- * Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
10078
- * @type {Array<StripeStripePriceTier>}
10079
- * @memberof StripeStripeResponseStripeStripePrice
10080
- */
10081
- 'tiers'?: Array<StripeStripePriceTier>;
10082
- /**
10083
- * 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.
10084
- * @type {StripeStripePriceTiersMode}
10085
- * @memberof StripeStripeResponseStripeStripePrice
10086
- */
10087
- 'tiers_mode': StripeStripePriceTiersMode | null;
10088
- /**
10089
- * Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
10090
- * @type {StripeStripePriceTransformQuantity}
10091
- * @memberof StripeStripeResponseStripeStripePrice
10092
- */
10093
- 'transform_quantity': StripeStripePriceTransformQuantity | null;
10094
- /**
10095
- *
10096
- * @type {StripeStripePriceType}
10097
- * @memberof StripeStripeResponseStripeStripePrice
10098
- */
10099
- 'type': StripeStripePriceType;
10100
- /**
10101
- * 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`.
10102
- * @type {number}
10103
- * @memberof StripeStripeResponseStripeStripePrice
10104
- */
10105
- 'unit_amount': number | null;
10106
- /**
10107
- * 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`.
10108
- * @type {string}
10109
- * @memberof StripeStripeResponseStripeStripePrice
10110
- */
10111
- 'unit_amount_decimal': string | null;
10112
- /**
10113
- *
10114
- * @type {StripeStripeResponseStripeStripePriceAllOfLastResponse}
10115
- * @memberof StripeStripeResponseStripeStripePrice
10116
- */
10117
- 'lastResponse': StripeStripeResponseStripeStripePriceAllOfLastResponse;
10118
- }
10119
- export declare const StripeStripeResponseStripeStripePriceObjectEnum: {
10120
- readonly Price: "price";
10121
- };
10122
- export type StripeStripeResponseStripeStripePriceObjectEnum = typeof StripeStripeResponseStripeStripePriceObjectEnum[keyof typeof StripeStripeResponseStripeStripePriceObjectEnum];
10123
- /**
10124
- *
10125
- * @export
10126
- * @interface StripeStripeResponseStripeStripePriceAllOfLastResponse
10127
- */
10128
- export interface StripeStripeResponseStripeStripePriceAllOfLastResponse {
10129
- /**
10130
- *
10131
- * @type {string}
10132
- * @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
10133
- */
10134
- 'stripeAccount'?: string;
10135
- /**
10136
- *
10137
- * @type {string}
10138
- * @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
10139
- */
10140
- 'idempotencyKey'?: string;
10141
- /**
10142
- *
10143
- * @type {string}
10144
- * @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
10145
- */
10146
- 'apiVersion'?: string;
10147
- /**
10148
- *
10149
- * @type {number}
10150
- * @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
10151
- */
10152
- 'statusCode': number;
10153
- /**
10154
- *
10155
- * @type {string}
10156
- * @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
10157
- */
10158
- 'requestId': string;
10159
- /**
10160
- *
10161
- * @type {{ [key: string]: string; }}
10162
- * @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
10163
- */
10164
- 'headers': {
10165
- [key: string]: string;
10166
- };
10167
- }
10168
- /**
10169
- * [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
10170
- * @export
10171
- * @interface StripeStripeTaxCode
10172
- */
10173
- export interface StripeStripeTaxCode {
10174
- /**
10175
- * Unique identifier for the object.
10176
- * @type {string}
10177
- * @memberof StripeStripeTaxCode
10178
- */
10179
- 'id': string;
10180
- /**
10181
- * String representing the object\'s type. Objects of the same type share the same value.
10182
- * @type {string}
10183
- * @memberof StripeStripeTaxCode
10184
- */
10185
- 'object': StripeStripeTaxCodeObjectEnum;
10186
- /**
10187
- * A detailed description of which types of products the tax code represents.
10188
- * @type {string}
10189
- * @memberof StripeStripeTaxCode
10190
- */
10191
- 'description': string;
10192
- /**
10193
- * A short name for the tax code.
10194
- * @type {string}
10195
- * @memberof StripeStripeTaxCode
10196
- */
10197
- 'name': string;
10198
- }
10199
- export declare const StripeStripeTaxCodeObjectEnum: {
10200
- readonly TaxCode: "tax_code";
10201
- };
10202
- export type StripeStripeTaxCodeObjectEnum = typeof StripeStripeTaxCodeObjectEnum[keyof typeof StripeStripeTaxCodeObjectEnum];
10203
8991
  /**
10204
8992
  *
10205
8993
  * @export
@@ -10339,12 +9127,86 @@ export interface SubscriptionPlanDiscountResponse {
10339
9127
  */
10340
9128
  'bookingFree'?: boolean;
10341
9129
  }
9130
+ /**
9131
+ *
9132
+ * @export
9133
+ * @interface SubscriptionPlanDiscountUpdateRequest
9134
+ */
9135
+ export interface SubscriptionPlanDiscountUpdateRequest {
9136
+ /**
9137
+ *
9138
+ * @type {DiscountType}
9139
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9140
+ */
9141
+ 'type': DiscountType;
9142
+ /**
9143
+ *
9144
+ * @type {number}
9145
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9146
+ */
9147
+ 'percentage'?: number;
9148
+ /**
9149
+ *
9150
+ * @type {number}
9151
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9152
+ */
9153
+ 'maxDiscountAmountInCents'?: number;
9154
+ /**
9155
+ *
9156
+ * @type {SubscriptionPlanDiscountUpdateRequestValidFrom}
9157
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9158
+ */
9159
+ 'validFrom'?: SubscriptionPlanDiscountUpdateRequestValidFrom;
9160
+ /**
9161
+ *
9162
+ * @type {SubscriptionPlanDiscountUpdateRequestValidFrom}
9163
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9164
+ */
9165
+ 'validTo'?: SubscriptionPlanDiscountUpdateRequestValidFrom;
9166
+ /**
9167
+ *
9168
+ * @type {Array<string>}
9169
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9170
+ */
9171
+ 'offPeakRuleNames'?: Array<string>;
9172
+ /**
9173
+ *
9174
+ * @type {Array<OffPeakRule>}
9175
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9176
+ */
9177
+ 'offPeakRules'?: Array<OffPeakRule>;
9178
+ /**
9179
+ *
9180
+ * @type {Array<string>}
9181
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9182
+ */
9183
+ 'pricingPeriodIds'?: Array<string>;
9184
+ /**
9185
+ *
9186
+ * @type {boolean}
9187
+ * @memberof SubscriptionPlanDiscountUpdateRequest
9188
+ */
9189
+ 'bookingFree'?: boolean;
9190
+ }
9191
+ /**
9192
+ *
9193
+ * @export
9194
+ * @interface SubscriptionPlanDiscountUpdateRequestValidFrom
9195
+ */
9196
+ export interface SubscriptionPlanDiscountUpdateRequestValidFrom {
9197
+ }
10342
9198
  /**
10343
9199
  *
10344
9200
  * @export
10345
9201
  * @interface SubscriptionPlanResponse
10346
9202
  */
10347
9203
  export interface SubscriptionPlanResponse {
9204
+ /**
9205
+ *
9206
+ * @type {string}
9207
+ * @memberof SubscriptionPlanResponse
9208
+ */
9209
+ 'planId': string;
10348
9210
  /**
10349
9211
  *
10350
9212
  * @type {string}
@@ -11038,25 +9900,6 @@ export interface UpdateLevelBySportsRequestBody {
11038
9900
  */
11039
9901
  'levelBySports': Array<LevelBySportEntry>;
11040
9902
  }
11041
- /**
11042
- *
11043
- * @export
11044
- * @interface UpdatePlanRequest
11045
- */
11046
- export interface UpdatePlanRequest {
11047
- /**
11048
- *
11049
- * @type {number}
11050
- * @memberof UpdatePlanRequest
11051
- */
11052
- 'newAmountInCents': number;
11053
- /**
11054
- *
11055
- * @type {string}
11056
- * @memberof UpdatePlanRequest
11057
- */
11058
- 'oldPriceId': string;
11059
- }
11060
9903
  /**
11061
9904
  *
11062
9905
  * @export
@@ -11264,6 +10107,61 @@ export interface UpdateSubscriptionPlanForClub200Response {
11264
10107
  */
11265
10108
  'price': any;
11266
10109
  }
10110
+ /**
10111
+ *
10112
+ * @export
10113
+ * @interface UpdateSubscriptionPlanRequest
10114
+ */
10115
+ export interface UpdateSubscriptionPlanRequest {
10116
+ /**
10117
+ *
10118
+ * @type {string}
10119
+ * @memberof UpdateSubscriptionPlanRequest
10120
+ */
10121
+ 'productId': string;
10122
+ /**
10123
+ *
10124
+ * @type {string}
10125
+ * @memberof UpdateSubscriptionPlanRequest
10126
+ */
10127
+ 'priceId'?: string;
10128
+ /**
10129
+ *
10130
+ * @type {string}
10131
+ * @memberof UpdateSubscriptionPlanRequest
10132
+ */
10133
+ 'name'?: string;
10134
+ /**
10135
+ *
10136
+ * @type {string}
10137
+ * @memberof UpdateSubscriptionPlanRequest
10138
+ */
10139
+ 'description'?: string;
10140
+ /**
10141
+ *
10142
+ * @type {string}
10143
+ * @memberof UpdateSubscriptionPlanRequest
10144
+ */
10145
+ 'currency'?: string;
10146
+ /**
10147
+ *
10148
+ * @type {PlanInterval}
10149
+ * @memberof UpdateSubscriptionPlanRequest
10150
+ */
10151
+ 'interval'?: PlanInterval;
10152
+ /**
10153
+ *
10154
+ * @type {SubscriptionPlanDiscountUpdateRequest}
10155
+ * @memberof UpdateSubscriptionPlanRequest
10156
+ */
10157
+ 'discount'?: SubscriptionPlanDiscountUpdateRequest;
10158
+ /**
10159
+ *
10160
+ * @type {number}
10161
+ * @memberof UpdateSubscriptionPlanRequest
10162
+ */
10163
+ 'newAmountInCents'?: number;
10164
+ }
11267
10165
  /**
11268
10166
  *
11269
10167
  * @export
@@ -18025,12 +16923,12 @@ export declare const SubscriptionsManagerApiAxiosParamCreator: (configuration?:
18025
16923
  */
18026
16924
  deletePlan: (productId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18027
16925
  /**
18028
- * Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
18029
- * @param {UpdatePlanRequest} updatePlanRequest
16926
+ * Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
16927
+ * @param {UpdateSubscriptionPlanRequest} updateSubscriptionPlanRequest
18030
16928
  * @param {*} [options] Override http request option.
18031
16929
  * @throws {RequiredError}
18032
16930
  */
18033
- updatePlan: (updatePlanRequest: UpdatePlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
16931
+ updatePlan: (updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18034
16932
  };
18035
16933
  /**
18036
16934
  * SubscriptionsManagerApi - functional programming interface
@@ -18059,12 +16957,12 @@ export declare const SubscriptionsManagerApiFp: (configuration?: Configuration)
18059
16957
  */
18060
16958
  deletePlan(productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSubscriptionPlanResponse>>;
18061
16959
  /**
18062
- * Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
18063
- * @param {UpdatePlanRequest} updatePlanRequest
16960
+ * Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
16961
+ * @param {UpdateSubscriptionPlanRequest} updateSubscriptionPlanRequest
18064
16962
  * @param {*} [options] Override http request option.
18065
16963
  * @throws {RequiredError}
18066
16964
  */
18067
- updatePlan(updatePlanRequest: UpdatePlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StripeStripeResponseStripeStripePrice>>;
16965
+ updatePlan(updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
18068
16966
  };
18069
16967
  /**
18070
16968
  * SubscriptionsManagerApi - factory interface
@@ -18093,12 +16991,12 @@ export declare const SubscriptionsManagerApiFactory: (configuration?: Configurat
18093
16991
  */
18094
16992
  deletePlan(requestParameters: SubscriptionsManagerApiDeletePlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteSubscriptionPlanResponse>;
18095
16993
  /**
18096
- * Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
16994
+ * Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
18097
16995
  * @param {SubscriptionsManagerApiUpdatePlanRequest} requestParameters Request parameters.
18098
16996
  * @param {*} [options] Override http request option.
18099
16997
  * @throws {RequiredError}
18100
16998
  */
18101
- updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<StripeStripeResponseStripeStripePrice>;
16999
+ updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
18102
17000
  };
18103
17001
  /**
18104
17002
  * Request parameters for archivePlan operation in SubscriptionsManagerApi.
@@ -18147,10 +17045,10 @@ export interface SubscriptionsManagerApiDeletePlanRequest {
18147
17045
  export interface SubscriptionsManagerApiUpdatePlanRequest {
18148
17046
  /**
18149
17047
  *
18150
- * @type {UpdatePlanRequest}
17048
+ * @type {UpdateSubscriptionPlanRequest}
18151
17049
  * @memberof SubscriptionsManagerApiUpdatePlan
18152
17050
  */
18153
- readonly updatePlanRequest: UpdatePlanRequest;
17051
+ readonly updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest;
18154
17052
  }
18155
17053
  /**
18156
17054
  * SubscriptionsManagerApi - object-oriented interface
@@ -18184,13 +17082,13 @@ export declare class SubscriptionsManagerApi extends BaseAPI {
18184
17082
  */
18185
17083
  deletePlan(requestParameters: SubscriptionsManagerApiDeletePlanRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteSubscriptionPlanResponse, any, {}>>;
18186
17084
  /**
18187
- * Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
17085
+ * Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
18188
17086
  * @param {SubscriptionsManagerApiUpdatePlanRequest} requestParameters Request parameters.
18189
17087
  * @param {*} [options] Override http request option.
18190
17088
  * @throws {RequiredError}
18191
17089
  * @memberof SubscriptionsManagerApi
18192
17090
  */
18193
- updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StripeStripeResponseStripeStripePrice, any, {}>>;
17091
+ updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
18194
17092
  }
18195
17093
  /**
18196
17094
  * SubscriptionsPublicApi - axios parameter creator