@tennac-booking/sdk 1.0.131 → 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 -361
- package/README.md +6 -30
- package/api.ts +325 -1422
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +322 -1375
- package/dist/api.js +19 -128
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +322 -1375
- package/dist/esm/api.js +15 -124
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/EventBookingResponse.md +2 -0
- package/docs/EventBookingResponsePaymentPerPlayersInner.md +30 -0
- 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/index.ts +1 -1
- 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
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* openapi.json
|
|
5
5
|
* Pandook API Documentation
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.
|
|
7
|
+
* The version of the OpenAPI document: 1.0.132
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4605,6 +4605,12 @@ export interface EventBookingResponse {
|
|
|
4605
4605
|
* @memberof EventBookingResponse
|
|
4606
4606
|
*/
|
|
4607
4607
|
'players': Array<EventBookingResponsePlayersInner>;
|
|
4608
|
+
/**
|
|
4609
|
+
*
|
|
4610
|
+
* @type {Array<EventBookingResponsePaymentPerPlayersInner>}
|
|
4611
|
+
* @memberof EventBookingResponse
|
|
4612
|
+
*/
|
|
4613
|
+
'paymentPerPlayers'?: Array<EventBookingResponsePaymentPerPlayersInner>;
|
|
4608
4614
|
/**
|
|
4609
4615
|
*
|
|
4610
4616
|
* @type {string}
|
|
@@ -4638,6 +4644,49 @@ export interface EventBookingResponse {
|
|
|
4638
4644
|
}
|
|
4639
4645
|
|
|
4640
4646
|
|
|
4647
|
+
/**
|
|
4648
|
+
*
|
|
4649
|
+
* @export
|
|
4650
|
+
* @interface EventBookingResponsePaymentPerPlayersInner
|
|
4651
|
+
*/
|
|
4652
|
+
export interface EventBookingResponsePaymentPerPlayersInner {
|
|
4653
|
+
/**
|
|
4654
|
+
*
|
|
4655
|
+
* @type {number}
|
|
4656
|
+
* @memberof EventBookingResponsePaymentPerPlayersInner
|
|
4657
|
+
*/
|
|
4658
|
+
'amount'?: number | null;
|
|
4659
|
+
/**
|
|
4660
|
+
*
|
|
4661
|
+
* @type {EventBookingResponsePlayersInnerInvoiceStatus}
|
|
4662
|
+
* @memberof EventBookingResponsePaymentPerPlayersInner
|
|
4663
|
+
*/
|
|
4664
|
+
'status'?: EventBookingResponsePlayersInnerInvoiceStatus | null;
|
|
4665
|
+
/**
|
|
4666
|
+
*
|
|
4667
|
+
* @type {string}
|
|
4668
|
+
* @memberof EventBookingResponsePaymentPerPlayersInner
|
|
4669
|
+
*/
|
|
4670
|
+
'photo'?: string | null;
|
|
4671
|
+
/**
|
|
4672
|
+
*
|
|
4673
|
+
* @type {string}
|
|
4674
|
+
* @memberof EventBookingResponsePaymentPerPlayersInner
|
|
4675
|
+
*/
|
|
4676
|
+
'lastName'?: string | null;
|
|
4677
|
+
/**
|
|
4678
|
+
*
|
|
4679
|
+
* @type {string}
|
|
4680
|
+
* @memberof EventBookingResponsePaymentPerPlayersInner
|
|
4681
|
+
*/
|
|
4682
|
+
'firstName'?: string | null;
|
|
4683
|
+
/**
|
|
4684
|
+
*
|
|
4685
|
+
* @type {string}
|
|
4686
|
+
* @memberof EventBookingResponsePaymentPerPlayersInner
|
|
4687
|
+
*/
|
|
4688
|
+
'id': string;
|
|
4689
|
+
}
|
|
4641
4690
|
/**
|
|
4642
4691
|
*
|
|
4643
4692
|
* @export
|
|
@@ -9103,1500 +9152,316 @@ export interface StaffUserProfileResponse {
|
|
|
9103
9152
|
|
|
9104
9153
|
|
|
9105
9154
|
/**
|
|
9106
|
-
*
|
|
9155
|
+
*
|
|
9107
9156
|
* @export
|
|
9108
|
-
* @interface
|
|
9157
|
+
* @interface SubscribeRequestBody
|
|
9109
9158
|
*/
|
|
9110
|
-
export interface
|
|
9159
|
+
export interface SubscribeRequestBody {
|
|
9111
9160
|
/**
|
|
9112
|
-
*
|
|
9161
|
+
*
|
|
9113
9162
|
* @type {string}
|
|
9114
|
-
* @memberof
|
|
9163
|
+
* @memberof SubscribeRequestBody
|
|
9115
9164
|
*/
|
|
9116
|
-
'
|
|
9165
|
+
'clubId': string;
|
|
9117
9166
|
/**
|
|
9118
|
-
*
|
|
9167
|
+
*
|
|
9119
9168
|
* @type {string}
|
|
9120
|
-
* @memberof
|
|
9169
|
+
* @memberof SubscribeRequestBody
|
|
9121
9170
|
*/
|
|
9122
|
-
'
|
|
9171
|
+
'priceId': string;
|
|
9123
9172
|
/**
|
|
9124
|
-
*
|
|
9173
|
+
*
|
|
9125
9174
|
* @type {boolean}
|
|
9126
|
-
* @memberof
|
|
9175
|
+
* @memberof SubscribeRequestBody
|
|
9127
9176
|
*/
|
|
9128
|
-
'
|
|
9177
|
+
'useDefaultPaymentMethod'?: boolean;
|
|
9129
9178
|
}
|
|
9130
|
-
|
|
9131
|
-
export const StripeStripeDeletedProductObjectEnum = {
|
|
9132
|
-
Product: 'product'
|
|
9133
|
-
} as const;
|
|
9134
|
-
|
|
9135
|
-
export type StripeStripeDeletedProductObjectEnum = typeof StripeStripeDeletedProductObjectEnum[keyof typeof StripeStripeDeletedProductObjectEnum];
|
|
9136
|
-
|
|
9137
9179
|
/**
|
|
9138
|
-
*
|
|
9180
|
+
*
|
|
9139
9181
|
* @export
|
|
9140
|
-
* @interface
|
|
9182
|
+
* @interface SubscriberPrice
|
|
9141
9183
|
*/
|
|
9142
|
-
export interface
|
|
9184
|
+
export interface SubscriberPrice {
|
|
9143
9185
|
/**
|
|
9144
|
-
*
|
|
9186
|
+
*
|
|
9145
9187
|
* @type {string}
|
|
9146
|
-
* @memberof
|
|
9188
|
+
* @memberof SubscriberPrice
|
|
9147
9189
|
*/
|
|
9148
|
-
'
|
|
9190
|
+
'subscriptionPlanId': string;
|
|
9149
9191
|
/**
|
|
9150
|
-
*
|
|
9151
|
-
* @type {
|
|
9152
|
-
* @memberof
|
|
9192
|
+
*
|
|
9193
|
+
* @type {number}
|
|
9194
|
+
* @memberof SubscriberPrice
|
|
9153
9195
|
*/
|
|
9154
|
-
'
|
|
9196
|
+
'amount': number;
|
|
9197
|
+
}
|
|
9198
|
+
/**
|
|
9199
|
+
*
|
|
9200
|
+
* @export
|
|
9201
|
+
* @interface SubscriptionInfo
|
|
9202
|
+
*/
|
|
9203
|
+
export interface SubscriptionInfo {
|
|
9155
9204
|
/**
|
|
9156
|
-
*
|
|
9157
|
-
* @type {
|
|
9158
|
-
* @memberof
|
|
9205
|
+
*
|
|
9206
|
+
* @type {string}
|
|
9207
|
+
* @memberof SubscriptionInfo
|
|
9159
9208
|
*/
|
|
9160
|
-
'
|
|
9209
|
+
'subscriptionPlanName'?: string;
|
|
9161
9210
|
/**
|
|
9162
9211
|
*
|
|
9163
|
-
* @type {
|
|
9164
|
-
* @memberof
|
|
9212
|
+
* @type {string}
|
|
9213
|
+
* @memberof SubscriptionInfo
|
|
9165
9214
|
*/
|
|
9166
|
-
'
|
|
9215
|
+
'subscriptionDescription'?: string;
|
|
9167
9216
|
/**
|
|
9168
|
-
*
|
|
9217
|
+
*
|
|
9169
9218
|
* @type {number}
|
|
9170
|
-
* @memberof
|
|
9219
|
+
* @memberof SubscriptionInfo
|
|
9171
9220
|
*/
|
|
9172
|
-
'
|
|
9221
|
+
'reducedAmountInCents'?: number;
|
|
9222
|
+
}
|
|
9223
|
+
/**
|
|
9224
|
+
*
|
|
9225
|
+
* @export
|
|
9226
|
+
* @interface SubscriptionMutationResponse
|
|
9227
|
+
*/
|
|
9228
|
+
export interface SubscriptionMutationResponse {
|
|
9173
9229
|
/**
|
|
9174
|
-
*
|
|
9175
|
-
* @type {string}
|
|
9176
|
-
* @memberof
|
|
9230
|
+
* Construct a type with a set of properties K of type T
|
|
9231
|
+
* @type {{ [key: string]: any; }}
|
|
9232
|
+
* @memberof SubscriptionMutationResponse
|
|
9177
9233
|
*/
|
|
9178
|
-
'
|
|
9234
|
+
'subscription': { [key: string]: any; };
|
|
9235
|
+
}
|
|
9236
|
+
/**
|
|
9237
|
+
*
|
|
9238
|
+
* @export
|
|
9239
|
+
* @interface SubscriptionPlanDiscountResponse
|
|
9240
|
+
*/
|
|
9241
|
+
export interface SubscriptionPlanDiscountResponse {
|
|
9179
9242
|
/**
|
|
9180
|
-
*
|
|
9181
|
-
* @type {
|
|
9182
|
-
* @memberof
|
|
9243
|
+
*
|
|
9244
|
+
* @type {DiscountType}
|
|
9245
|
+
* @memberof SubscriptionPlanDiscountResponse
|
|
9183
9246
|
*/
|
|
9184
|
-
'
|
|
9247
|
+
'type': DiscountType;
|
|
9185
9248
|
/**
|
|
9186
|
-
*
|
|
9187
|
-
* @type {
|
|
9188
|
-
* @memberof
|
|
9249
|
+
*
|
|
9250
|
+
* @type {number}
|
|
9251
|
+
* @memberof SubscriptionPlanDiscountResponse
|
|
9189
9252
|
*/
|
|
9190
|
-
'
|
|
9253
|
+
'percentage'?: number;
|
|
9191
9254
|
/**
|
|
9192
|
-
*
|
|
9193
|
-
* @type {
|
|
9194
|
-
* @memberof
|
|
9255
|
+
*
|
|
9256
|
+
* @type {number}
|
|
9257
|
+
* @memberof SubscriptionPlanDiscountResponse
|
|
9195
9258
|
*/
|
|
9196
|
-
'
|
|
9259
|
+
'maxDiscountAmountInCents'?: number;
|
|
9197
9260
|
/**
|
|
9198
|
-
*
|
|
9199
|
-
* @type {
|
|
9200
|
-
* @memberof
|
|
9261
|
+
*
|
|
9262
|
+
* @type {string}
|
|
9263
|
+
* @memberof SubscriptionPlanDiscountResponse
|
|
9201
9264
|
*/
|
|
9202
|
-
'
|
|
9265
|
+
'validFrom'?: string;
|
|
9203
9266
|
/**
|
|
9204
|
-
*
|
|
9267
|
+
*
|
|
9205
9268
|
* @type {string}
|
|
9206
|
-
* @memberof
|
|
9269
|
+
* @memberof SubscriptionPlanDiscountResponse
|
|
9207
9270
|
*/
|
|
9208
|
-
'
|
|
9271
|
+
'validTo'?: string;
|
|
9209
9272
|
/**
|
|
9210
|
-
*
|
|
9211
|
-
* @type {
|
|
9212
|
-
* @memberof
|
|
9273
|
+
*
|
|
9274
|
+
* @type {Array<string>}
|
|
9275
|
+
* @memberof SubscriptionPlanDiscountResponse
|
|
9213
9276
|
*/
|
|
9214
|
-
'
|
|
9277
|
+
'offPeakRuleNames'?: Array<string>;
|
|
9215
9278
|
/**
|
|
9216
|
-
*
|
|
9217
|
-
* @type {
|
|
9218
|
-
* @memberof
|
|
9279
|
+
*
|
|
9280
|
+
* @type {Array<OffPeakRule>}
|
|
9281
|
+
* @memberof SubscriptionPlanDiscountResponse
|
|
9219
9282
|
*/
|
|
9220
|
-
'
|
|
9283
|
+
'offPeakRules'?: Array<OffPeakRule>;
|
|
9221
9284
|
/**
|
|
9222
9285
|
*
|
|
9223
|
-
* @type {
|
|
9224
|
-
* @memberof
|
|
9286
|
+
* @type {boolean}
|
|
9287
|
+
* @memberof SubscriptionPlanDiscountResponse
|
|
9225
9288
|
*/
|
|
9226
|
-
'
|
|
9289
|
+
'bookingFree'?: boolean;
|
|
9290
|
+
}
|
|
9291
|
+
|
|
9292
|
+
|
|
9293
|
+
/**
|
|
9294
|
+
*
|
|
9295
|
+
* @export
|
|
9296
|
+
* @interface SubscriptionPlanDiscountUpdateRequest
|
|
9297
|
+
*/
|
|
9298
|
+
export interface SubscriptionPlanDiscountUpdateRequest {
|
|
9227
9299
|
/**
|
|
9228
|
-
*
|
|
9229
|
-
* @type {
|
|
9230
|
-
* @memberof
|
|
9300
|
+
*
|
|
9301
|
+
* @type {DiscountType}
|
|
9302
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9231
9303
|
*/
|
|
9232
|
-
'
|
|
9304
|
+
'type': DiscountType;
|
|
9233
9305
|
/**
|
|
9234
|
-
*
|
|
9235
|
-
* @type {
|
|
9236
|
-
* @memberof
|
|
9306
|
+
*
|
|
9307
|
+
* @type {number}
|
|
9308
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9237
9309
|
*/
|
|
9238
|
-
'
|
|
9310
|
+
'percentage'?: number;
|
|
9239
9311
|
/**
|
|
9240
|
-
*
|
|
9241
|
-
* @type {
|
|
9242
|
-
* @memberof
|
|
9312
|
+
*
|
|
9313
|
+
* @type {number}
|
|
9314
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9243
9315
|
*/
|
|
9244
|
-
'
|
|
9316
|
+
'maxDiscountAmountInCents'?: number;
|
|
9245
9317
|
/**
|
|
9246
|
-
*
|
|
9247
|
-
* @type {
|
|
9248
|
-
* @memberof
|
|
9318
|
+
*
|
|
9319
|
+
* @type {SubscriptionPlanDiscountUpdateRequestValidFrom}
|
|
9320
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9249
9321
|
*/
|
|
9250
|
-
'
|
|
9322
|
+
'validFrom'?: SubscriptionPlanDiscountUpdateRequestValidFrom;
|
|
9251
9323
|
/**
|
|
9252
|
-
*
|
|
9253
|
-
* @type {
|
|
9254
|
-
* @memberof
|
|
9324
|
+
*
|
|
9325
|
+
* @type {SubscriptionPlanDiscountUpdateRequestValidFrom}
|
|
9326
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9255
9327
|
*/
|
|
9256
|
-
'
|
|
9328
|
+
'validTo'?: SubscriptionPlanDiscountUpdateRequestValidFrom;
|
|
9257
9329
|
/**
|
|
9258
9330
|
*
|
|
9259
|
-
* @type {
|
|
9260
|
-
* @memberof
|
|
9331
|
+
* @type {Array<string>}
|
|
9332
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9261
9333
|
*/
|
|
9262
|
-
'
|
|
9334
|
+
'offPeakRuleNames'?: Array<string>;
|
|
9263
9335
|
/**
|
|
9264
|
-
*
|
|
9265
|
-
* @type {
|
|
9266
|
-
* @memberof
|
|
9336
|
+
*
|
|
9337
|
+
* @type {Array<OffPeakRule>}
|
|
9338
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9267
9339
|
*/
|
|
9268
|
-
'
|
|
9340
|
+
'offPeakRules'?: Array<OffPeakRule>;
|
|
9269
9341
|
/**
|
|
9270
|
-
*
|
|
9271
|
-
* @type {string}
|
|
9272
|
-
* @memberof
|
|
9342
|
+
*
|
|
9343
|
+
* @type {Array<string>}
|
|
9344
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9345
|
+
*/
|
|
9346
|
+
'pricingPeriodIds'?: Array<string>;
|
|
9347
|
+
/**
|
|
9348
|
+
*
|
|
9349
|
+
* @type {boolean}
|
|
9350
|
+
* @memberof SubscriptionPlanDiscountUpdateRequest
|
|
9273
9351
|
*/
|
|
9274
|
-
'
|
|
9352
|
+
'bookingFree'?: boolean;
|
|
9275
9353
|
}
|
|
9276
9354
|
|
|
9277
|
-
export const StripeStripePriceObjectEnum = {
|
|
9278
|
-
Price: 'price'
|
|
9279
|
-
} as const;
|
|
9280
|
-
|
|
9281
|
-
export type StripeStripePriceObjectEnum = typeof StripeStripePriceObjectEnum[keyof typeof StripeStripePriceObjectEnum];
|
|
9282
9355
|
|
|
9283
9356
|
/**
|
|
9284
9357
|
*
|
|
9285
9358
|
* @export
|
|
9286
|
-
* @
|
|
9359
|
+
* @interface SubscriptionPlanDiscountUpdateRequestValidFrom
|
|
9287
9360
|
*/
|
|
9288
|
-
|
|
9289
|
-
|
|
9290
|
-
PerUnit: 'per_unit',
|
|
9291
|
-
Tiered: 'tiered'
|
|
9292
|
-
} as const;
|
|
9293
|
-
|
|
9294
|
-
export type StripeStripePriceBillingScheme = typeof StripeStripePriceBillingScheme[keyof typeof StripeStripePriceBillingScheme];
|
|
9295
|
-
|
|
9296
|
-
|
|
9361
|
+
export interface SubscriptionPlanDiscountUpdateRequestValidFrom {
|
|
9362
|
+
}
|
|
9297
9363
|
/**
|
|
9298
9364
|
*
|
|
9299
9365
|
* @export
|
|
9300
|
-
* @interface
|
|
9366
|
+
* @interface SubscriptionPlanResponse
|
|
9301
9367
|
*/
|
|
9302
|
-
export interface
|
|
9368
|
+
export interface SubscriptionPlanResponse {
|
|
9369
|
+
/**
|
|
9370
|
+
*
|
|
9371
|
+
* @type {string}
|
|
9372
|
+
* @memberof SubscriptionPlanResponse
|
|
9373
|
+
*/
|
|
9374
|
+
'planId': string;
|
|
9375
|
+
/**
|
|
9376
|
+
*
|
|
9377
|
+
* @type {string}
|
|
9378
|
+
* @memberof SubscriptionPlanResponse
|
|
9379
|
+
*/
|
|
9380
|
+
'productId': string;
|
|
9303
9381
|
/**
|
|
9304
|
-
*
|
|
9305
|
-
* @type {
|
|
9306
|
-
* @memberof
|
|
9382
|
+
*
|
|
9383
|
+
* @type {string}
|
|
9384
|
+
* @memberof SubscriptionPlanResponse
|
|
9307
9385
|
*/
|
|
9308
|
-
'
|
|
9386
|
+
'productName': string;
|
|
9309
9387
|
/**
|
|
9310
|
-
*
|
|
9311
|
-
* @type {
|
|
9312
|
-
* @memberof
|
|
9388
|
+
*
|
|
9389
|
+
* @type {boolean}
|
|
9390
|
+
* @memberof SubscriptionPlanResponse
|
|
9313
9391
|
*/
|
|
9314
|
-
'
|
|
9392
|
+
'productActive': boolean;
|
|
9315
9393
|
/**
|
|
9316
|
-
*
|
|
9317
|
-
* @type {
|
|
9318
|
-
* @memberof
|
|
9394
|
+
*
|
|
9395
|
+
* @type {string}
|
|
9396
|
+
* @memberof SubscriptionPlanResponse
|
|
9319
9397
|
*/
|
|
9320
|
-
'
|
|
9398
|
+
'priceId': string;
|
|
9321
9399
|
/**
|
|
9322
|
-
*
|
|
9400
|
+
*
|
|
9323
9401
|
* @type {number}
|
|
9324
|
-
* @memberof
|
|
9402
|
+
* @memberof SubscriptionPlanResponse
|
|
9325
9403
|
*/
|
|
9326
|
-
'
|
|
9404
|
+
'amountInCents'?: number;
|
|
9327
9405
|
/**
|
|
9328
|
-
*
|
|
9406
|
+
*
|
|
9329
9407
|
* @type {string}
|
|
9330
|
-
* @memberof
|
|
9408
|
+
* @memberof SubscriptionPlanResponse
|
|
9331
9409
|
*/
|
|
9332
|
-
'
|
|
9333
|
-
}
|
|
9334
|
-
|
|
9335
|
-
|
|
9336
|
-
/**
|
|
9337
|
-
*
|
|
9338
|
-
* @export
|
|
9339
|
-
* @interface StripeStripePriceCurrencyOptionsCustomUnitAmount
|
|
9340
|
-
*/
|
|
9341
|
-
export interface StripeStripePriceCurrencyOptionsCustomUnitAmount {
|
|
9410
|
+
'currency': string;
|
|
9342
9411
|
/**
|
|
9343
|
-
*
|
|
9344
|
-
* @type {
|
|
9345
|
-
* @memberof
|
|
9412
|
+
*
|
|
9413
|
+
* @type {Array<PlanPrice>}
|
|
9414
|
+
* @memberof SubscriptionPlanResponse
|
|
9346
9415
|
*/
|
|
9347
|
-
'
|
|
9416
|
+
'prices': Array<PlanPrice>;
|
|
9348
9417
|
/**
|
|
9349
|
-
*
|
|
9350
|
-
* @type {
|
|
9351
|
-
* @memberof
|
|
9418
|
+
*
|
|
9419
|
+
* @type {PlanInterval}
|
|
9420
|
+
* @memberof SubscriptionPlanResponse
|
|
9352
9421
|
*/
|
|
9353
|
-
'
|
|
9422
|
+
'interval'?: PlanInterval;
|
|
9354
9423
|
/**
|
|
9355
|
-
*
|
|
9356
|
-
* @type {
|
|
9357
|
-
* @memberof
|
|
9424
|
+
*
|
|
9425
|
+
* @type {boolean}
|
|
9426
|
+
* @memberof SubscriptionPlanResponse
|
|
9427
|
+
*/
|
|
9428
|
+
'priceActive': boolean;
|
|
9429
|
+
/**
|
|
9430
|
+
*
|
|
9431
|
+
* @type {string}
|
|
9432
|
+
* @memberof SubscriptionPlanResponse
|
|
9433
|
+
*/
|
|
9434
|
+
'description'?: string;
|
|
9435
|
+
/**
|
|
9436
|
+
*
|
|
9437
|
+
* @type {SubscriptionPlanDiscountResponse}
|
|
9438
|
+
* @memberof SubscriptionPlanResponse
|
|
9358
9439
|
*/
|
|
9359
|
-
'
|
|
9440
|
+
'discount'?: SubscriptionPlanDiscountResponse;
|
|
9360
9441
|
}
|
|
9442
|
+
|
|
9443
|
+
|
|
9361
9444
|
/**
|
|
9362
9445
|
*
|
|
9363
9446
|
* @export
|
|
9364
9447
|
* @enum {string}
|
|
9365
9448
|
*/
|
|
9366
9449
|
|
|
9367
|
-
export const
|
|
9368
|
-
|
|
9369
|
-
|
|
9370
|
-
|
|
9450
|
+
export const SurfaceType = {
|
|
9451
|
+
Clay: 'clay',
|
|
9452
|
+
Grass: 'grass',
|
|
9453
|
+
Hard: 'hard'
|
|
9371
9454
|
} as const;
|
|
9372
9455
|
|
|
9373
|
-
export type
|
|
9456
|
+
export type SurfaceType = typeof SurfaceType[keyof typeof SurfaceType];
|
|
9374
9457
|
|
|
9375
9458
|
|
|
9376
9459
|
/**
|
|
9377
9460
|
*
|
|
9378
9461
|
* @export
|
|
9379
|
-
* @interface
|
|
9462
|
+
* @interface Team
|
|
9380
9463
|
*/
|
|
9381
|
-
export interface
|
|
9382
|
-
/**
|
|
9383
|
-
* Price for the entire tier.
|
|
9384
|
-
* @type {number}
|
|
9385
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9386
|
-
*/
|
|
9387
|
-
'flat_amount': number | null;
|
|
9388
|
-
/**
|
|
9389
|
-
* Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
|
|
9390
|
-
* @type {string}
|
|
9391
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9392
|
-
*/
|
|
9393
|
-
'flat_amount_decimal': string | null;
|
|
9394
|
-
/**
|
|
9395
|
-
* Per unit price for units relevant to the tier.
|
|
9396
|
-
* @type {number}
|
|
9397
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9398
|
-
*/
|
|
9399
|
-
'unit_amount': number | null;
|
|
9400
|
-
/**
|
|
9401
|
-
* Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
|
|
9402
|
-
* @type {string}
|
|
9403
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9404
|
-
*/
|
|
9405
|
-
'unit_amount_decimal': string | null;
|
|
9406
|
-
/**
|
|
9407
|
-
* Up to and including to this quantity will be contained in the tier.
|
|
9408
|
-
* @type {number}
|
|
9409
|
-
* @memberof StripeStripePriceCurrencyOptionsTier
|
|
9410
|
-
*/
|
|
9411
|
-
'up_to': number | null;
|
|
9412
|
-
}
|
|
9413
|
-
/**
|
|
9414
|
-
*
|
|
9415
|
-
* @export
|
|
9416
|
-
* @interface StripeStripePriceCustomUnitAmount
|
|
9417
|
-
*/
|
|
9418
|
-
export interface StripeStripePriceCustomUnitAmount {
|
|
9419
|
-
/**
|
|
9420
|
-
* The maximum unit amount the customer can specify for this item.
|
|
9421
|
-
* @type {number}
|
|
9422
|
-
* @memberof StripeStripePriceCustomUnitAmount
|
|
9423
|
-
*/
|
|
9424
|
-
'maximum': number | null;
|
|
9425
|
-
/**
|
|
9426
|
-
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
|
9427
|
-
* @type {number}
|
|
9428
|
-
* @memberof StripeStripePriceCustomUnitAmount
|
|
9429
|
-
*/
|
|
9430
|
-
'minimum': number | null;
|
|
9431
|
-
/**
|
|
9432
|
-
* The starting unit amount which can be updated by the customer.
|
|
9433
|
-
* @type {number}
|
|
9434
|
-
* @memberof StripeStripePriceCustomUnitAmount
|
|
9435
|
-
*/
|
|
9436
|
-
'preset': number | null;
|
|
9437
|
-
}
|
|
9438
|
-
/**
|
|
9439
|
-
* The ID of the product this price is associated with.
|
|
9440
|
-
* @export
|
|
9441
|
-
* @interface StripeStripePriceProduct
|
|
9442
|
-
*/
|
|
9443
|
-
export interface StripeStripePriceProduct {
|
|
9444
|
-
/**
|
|
9445
|
-
* Unique identifier for the object.
|
|
9446
|
-
* @type {string}
|
|
9447
|
-
* @memberof StripeStripePriceProduct
|
|
9448
|
-
*/
|
|
9449
|
-
'id': string;
|
|
9450
|
-
/**
|
|
9451
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
9452
|
-
* @type {string}
|
|
9453
|
-
* @memberof StripeStripePriceProduct
|
|
9454
|
-
*/
|
|
9455
|
-
'object': StripeStripePriceProductObjectEnum;
|
|
9456
|
-
/**
|
|
9457
|
-
* Whether the product is currently available for purchase.
|
|
9458
|
-
* @type {boolean}
|
|
9459
|
-
* @memberof StripeStripePriceProduct
|
|
9460
|
-
*/
|
|
9461
|
-
'active': boolean;
|
|
9462
|
-
/**
|
|
9463
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
9464
|
-
* @type {number}
|
|
9465
|
-
* @memberof StripeStripePriceProduct
|
|
9466
|
-
*/
|
|
9467
|
-
'created': number;
|
|
9468
|
-
/**
|
|
9469
|
-
*
|
|
9470
|
-
* @type {StripeStripeProductDefaultPrice}
|
|
9471
|
-
* @memberof StripeStripePriceProduct
|
|
9472
|
-
*/
|
|
9473
|
-
'default_price'?: StripeStripeProductDefaultPrice | null;
|
|
9474
|
-
/**
|
|
9475
|
-
* Always true for a deleted object
|
|
9476
|
-
* @type {boolean}
|
|
9477
|
-
* @memberof StripeStripePriceProduct
|
|
9478
|
-
*/
|
|
9479
|
-
'deleted': boolean;
|
|
9480
|
-
/**
|
|
9481
|
-
* 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.
|
|
9482
|
-
* @type {string}
|
|
9483
|
-
* @memberof StripeStripePriceProduct
|
|
9484
|
-
*/
|
|
9485
|
-
'description': string | null;
|
|
9486
|
-
/**
|
|
9487
|
-
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
9488
|
-
* @type {Array<string>}
|
|
9489
|
-
* @memberof StripeStripePriceProduct
|
|
9490
|
-
*/
|
|
9491
|
-
'images': Array<string>;
|
|
9492
|
-
/**
|
|
9493
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
9494
|
-
* @type {boolean}
|
|
9495
|
-
* @memberof StripeStripePriceProduct
|
|
9496
|
-
*/
|
|
9497
|
-
'livemode': boolean;
|
|
9498
|
-
/**
|
|
9499
|
-
* 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).
|
|
9500
|
-
* @type {Array<StripeStripeProductMarketingFeature>}
|
|
9501
|
-
* @memberof StripeStripePriceProduct
|
|
9502
|
-
*/
|
|
9503
|
-
'marketing_features': Array<StripeStripeProductMarketingFeature>;
|
|
9504
|
-
/**
|
|
9505
|
-
* 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.
|
|
9506
|
-
* @type {{ [key: string]: string; }}
|
|
9507
|
-
* @memberof StripeStripePriceProduct
|
|
9508
|
-
*/
|
|
9509
|
-
'metadata': { [key: string]: string; };
|
|
9510
|
-
/**
|
|
9511
|
-
* The product\'s name, meant to be displayable to the customer.
|
|
9512
|
-
* @type {string}
|
|
9513
|
-
* @memberof StripeStripePriceProduct
|
|
9514
|
-
*/
|
|
9515
|
-
'name': string;
|
|
9516
|
-
/**
|
|
9517
|
-
* The dimensions of this product for shipping purposes.
|
|
9518
|
-
* @type {StripeStripeProductPackageDimensions}
|
|
9519
|
-
* @memberof StripeStripePriceProduct
|
|
9520
|
-
*/
|
|
9521
|
-
'package_dimensions': StripeStripeProductPackageDimensions | null;
|
|
9522
|
-
/**
|
|
9523
|
-
* Whether this product is shipped (i.e., physical goods).
|
|
9524
|
-
* @type {boolean}
|
|
9525
|
-
* @memberof StripeStripePriceProduct
|
|
9526
|
-
*/
|
|
9527
|
-
'shippable': boolean | null;
|
|
9528
|
-
/**
|
|
9529
|
-
* 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.
|
|
9530
|
-
* @type {string}
|
|
9531
|
-
* @memberof StripeStripePriceProduct
|
|
9532
|
-
*/
|
|
9533
|
-
'statement_descriptor'?: string | null;
|
|
9534
|
-
/**
|
|
9535
|
-
*
|
|
9536
|
-
* @type {StripeStripeProductTaxCode}
|
|
9537
|
-
* @memberof StripeStripePriceProduct
|
|
9538
|
-
*/
|
|
9539
|
-
'tax_code': StripeStripeProductTaxCode | null;
|
|
9540
|
-
/**
|
|
9541
|
-
*
|
|
9542
|
-
* @type {StripeStripeProductType}
|
|
9543
|
-
* @memberof StripeStripePriceProduct
|
|
9544
|
-
*/
|
|
9545
|
-
'type': StripeStripeProductType;
|
|
9546
|
-
/**
|
|
9547
|
-
* A label that represents units of this product. When set, this will be included in customers\' receipts, invoices, Checkout, and the customer portal.
|
|
9548
|
-
* @type {string}
|
|
9549
|
-
* @memberof StripeStripePriceProduct
|
|
9550
|
-
*/
|
|
9551
|
-
'unit_label'?: string | null;
|
|
9552
|
-
/**
|
|
9553
|
-
* Time at which the object was last updated. Measured in seconds since the Unix epoch.
|
|
9554
|
-
* @type {number}
|
|
9555
|
-
* @memberof StripeStripePriceProduct
|
|
9556
|
-
*/
|
|
9557
|
-
'updated': number;
|
|
9558
|
-
/**
|
|
9559
|
-
* A URL of a publicly-accessible webpage for this product.
|
|
9560
|
-
* @type {string}
|
|
9561
|
-
* @memberof StripeStripePriceProduct
|
|
9562
|
-
*/
|
|
9563
|
-
'url': string | null;
|
|
9564
|
-
}
|
|
9565
|
-
|
|
9566
|
-
export const StripeStripePriceProductObjectEnum = {
|
|
9567
|
-
Product: 'product'
|
|
9568
|
-
} as const;
|
|
9569
|
-
|
|
9570
|
-
export type StripeStripePriceProductObjectEnum = typeof StripeStripePriceProductObjectEnum[keyof typeof StripeStripePriceProductObjectEnum];
|
|
9571
|
-
|
|
9572
|
-
/**
|
|
9573
|
-
*
|
|
9574
|
-
* @export
|
|
9575
|
-
* @interface StripeStripePriceRecurring
|
|
9576
|
-
*/
|
|
9577
|
-
export interface StripeStripePriceRecurring {
|
|
9578
|
-
/**
|
|
9579
|
-
*
|
|
9580
|
-
* @type {StripeStripePriceRecurringInterval}
|
|
9581
|
-
* @memberof StripeStripePriceRecurring
|
|
9582
|
-
*/
|
|
9583
|
-
'interval': StripeStripePriceRecurringInterval;
|
|
9584
|
-
/**
|
|
9585
|
-
* The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
|
|
9586
|
-
* @type {number}
|
|
9587
|
-
* @memberof StripeStripePriceRecurring
|
|
9588
|
-
*/
|
|
9589
|
-
'interval_count': number;
|
|
9590
|
-
/**
|
|
9591
|
-
* The meter tracking the usage of a metered price
|
|
9592
|
-
* @type {string}
|
|
9593
|
-
* @memberof StripeStripePriceRecurring
|
|
9594
|
-
*/
|
|
9595
|
-
'meter': string | null;
|
|
9596
|
-
/**
|
|
9597
|
-
* 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).
|
|
9598
|
-
* @type {number}
|
|
9599
|
-
* @memberof StripeStripePriceRecurring
|
|
9600
|
-
*/
|
|
9601
|
-
'trial_period_days': number | null;
|
|
9602
|
-
/**
|
|
9603
|
-
*
|
|
9604
|
-
* @type {StripeStripePriceRecurringUsageType}
|
|
9605
|
-
* @memberof StripeStripePriceRecurring
|
|
9606
|
-
*/
|
|
9607
|
-
'usage_type': StripeStripePriceRecurringUsageType;
|
|
9608
|
-
}
|
|
9609
|
-
|
|
9610
|
-
|
|
9611
|
-
/**
|
|
9612
|
-
*
|
|
9613
|
-
* @export
|
|
9614
|
-
* @enum {string}
|
|
9615
|
-
*/
|
|
9616
|
-
|
|
9617
|
-
export const StripeStripePriceRecurringInterval = {
|
|
9618
|
-
Day: 'day',
|
|
9619
|
-
Month: 'month',
|
|
9620
|
-
Week: 'week',
|
|
9621
|
-
Year: 'year'
|
|
9622
|
-
} as const;
|
|
9623
|
-
|
|
9624
|
-
export type StripeStripePriceRecurringInterval = typeof StripeStripePriceRecurringInterval[keyof typeof StripeStripePriceRecurringInterval];
|
|
9625
|
-
|
|
9626
|
-
|
|
9627
|
-
/**
|
|
9628
|
-
*
|
|
9629
|
-
* @export
|
|
9630
|
-
* @enum {string}
|
|
9631
|
-
*/
|
|
9632
|
-
|
|
9633
|
-
export const StripeStripePriceRecurringUsageType = {
|
|
9634
|
-
Licensed: 'licensed',
|
|
9635
|
-
Metered: 'metered'
|
|
9636
|
-
} as const;
|
|
9637
|
-
|
|
9638
|
-
export type StripeStripePriceRecurringUsageType = typeof StripeStripePriceRecurringUsageType[keyof typeof StripeStripePriceRecurringUsageType];
|
|
9639
|
-
|
|
9640
|
-
|
|
9641
|
-
/**
|
|
9642
|
-
*
|
|
9643
|
-
* @export
|
|
9644
|
-
* @enum {string}
|
|
9645
|
-
*/
|
|
9646
|
-
|
|
9647
|
-
export const StripeStripePriceTaxBehavior = {
|
|
9648
|
-
Exclusive: 'exclusive',
|
|
9649
|
-
Inclusive: 'inclusive',
|
|
9650
|
-
Unspecified: 'unspecified'
|
|
9651
|
-
} as const;
|
|
9652
|
-
|
|
9653
|
-
export type StripeStripePriceTaxBehavior = typeof StripeStripePriceTaxBehavior[keyof typeof StripeStripePriceTaxBehavior];
|
|
9654
|
-
|
|
9655
|
-
|
|
9656
|
-
/**
|
|
9657
|
-
*
|
|
9658
|
-
* @export
|
|
9659
|
-
* @interface StripeStripePriceTier
|
|
9660
|
-
*/
|
|
9661
|
-
export interface StripeStripePriceTier {
|
|
9662
|
-
/**
|
|
9663
|
-
* Price for the entire tier.
|
|
9664
|
-
* @type {number}
|
|
9665
|
-
* @memberof StripeStripePriceTier
|
|
9666
|
-
*/
|
|
9667
|
-
'flat_amount': number | null;
|
|
9668
|
-
/**
|
|
9669
|
-
* Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.
|
|
9670
|
-
* @type {string}
|
|
9671
|
-
* @memberof StripeStripePriceTier
|
|
9672
|
-
*/
|
|
9673
|
-
'flat_amount_decimal': string | null;
|
|
9674
|
-
/**
|
|
9675
|
-
* Per unit price for units relevant to the tier.
|
|
9676
|
-
* @type {number}
|
|
9677
|
-
* @memberof StripeStripePriceTier
|
|
9678
|
-
*/
|
|
9679
|
-
'unit_amount': number | null;
|
|
9680
|
-
/**
|
|
9681
|
-
* Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
|
|
9682
|
-
* @type {string}
|
|
9683
|
-
* @memberof StripeStripePriceTier
|
|
9684
|
-
*/
|
|
9685
|
-
'unit_amount_decimal': string | null;
|
|
9686
|
-
/**
|
|
9687
|
-
* Up to and including to this quantity will be contained in the tier.
|
|
9688
|
-
* @type {number}
|
|
9689
|
-
* @memberof StripeStripePriceTier
|
|
9690
|
-
*/
|
|
9691
|
-
'up_to': number | null;
|
|
9692
|
-
}
|
|
9693
|
-
/**
|
|
9694
|
-
*
|
|
9695
|
-
* @export
|
|
9696
|
-
* @enum {string}
|
|
9697
|
-
*/
|
|
9698
|
-
|
|
9699
|
-
export const StripeStripePriceTiersMode = {
|
|
9700
|
-
Graduated: 'graduated',
|
|
9701
|
-
Volume: 'volume'
|
|
9702
|
-
} as const;
|
|
9703
|
-
|
|
9704
|
-
export type StripeStripePriceTiersMode = typeof StripeStripePriceTiersMode[keyof typeof StripeStripePriceTiersMode];
|
|
9705
|
-
|
|
9706
|
-
|
|
9707
|
-
/**
|
|
9708
|
-
*
|
|
9709
|
-
* @export
|
|
9710
|
-
* @interface StripeStripePriceTransformQuantity
|
|
9711
|
-
*/
|
|
9712
|
-
export interface StripeStripePriceTransformQuantity {
|
|
9713
|
-
/**
|
|
9714
|
-
* Divide usage by this number.
|
|
9715
|
-
* @type {number}
|
|
9716
|
-
* @memberof StripeStripePriceTransformQuantity
|
|
9717
|
-
*/
|
|
9718
|
-
'divide_by': number;
|
|
9719
|
-
/**
|
|
9720
|
-
*
|
|
9721
|
-
* @type {StripeStripePriceTransformQuantityRound}
|
|
9722
|
-
* @memberof StripeStripePriceTransformQuantity
|
|
9723
|
-
*/
|
|
9724
|
-
'round': StripeStripePriceTransformQuantityRound;
|
|
9725
|
-
}
|
|
9726
|
-
|
|
9727
|
-
|
|
9728
|
-
/**
|
|
9729
|
-
*
|
|
9730
|
-
* @export
|
|
9731
|
-
* @enum {string}
|
|
9732
|
-
*/
|
|
9733
|
-
|
|
9734
|
-
export const StripeStripePriceTransformQuantityRound = {
|
|
9735
|
-
Down: 'down',
|
|
9736
|
-
Up: 'up'
|
|
9737
|
-
} as const;
|
|
9738
|
-
|
|
9739
|
-
export type StripeStripePriceTransformQuantityRound = typeof StripeStripePriceTransformQuantityRound[keyof typeof StripeStripePriceTransformQuantityRound];
|
|
9740
|
-
|
|
9741
|
-
|
|
9742
|
-
/**
|
|
9743
|
-
*
|
|
9744
|
-
* @export
|
|
9745
|
-
* @enum {string}
|
|
9746
|
-
*/
|
|
9747
|
-
|
|
9748
|
-
export const StripeStripePriceType = {
|
|
9749
|
-
OneTime: 'one_time',
|
|
9750
|
-
Recurring: 'recurring'
|
|
9751
|
-
} as const;
|
|
9752
|
-
|
|
9753
|
-
export type StripeStripePriceType = typeof StripeStripePriceType[keyof typeof StripeStripePriceType];
|
|
9754
|
-
|
|
9755
|
-
|
|
9756
|
-
/**
|
|
9757
|
-
* 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)
|
|
9758
|
-
* @export
|
|
9759
|
-
* @interface StripeStripeProduct
|
|
9760
|
-
*/
|
|
9761
|
-
export interface StripeStripeProduct {
|
|
9762
|
-
/**
|
|
9763
|
-
* Unique identifier for the object.
|
|
9764
|
-
* @type {string}
|
|
9765
|
-
* @memberof StripeStripeProduct
|
|
9766
|
-
*/
|
|
9767
|
-
'id': string;
|
|
9768
|
-
/**
|
|
9769
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
9770
|
-
* @type {string}
|
|
9771
|
-
* @memberof StripeStripeProduct
|
|
9772
|
-
*/
|
|
9773
|
-
'object': StripeStripeProductObjectEnum;
|
|
9774
|
-
/**
|
|
9775
|
-
* Whether the product is currently available for purchase.
|
|
9776
|
-
* @type {boolean}
|
|
9777
|
-
* @memberof StripeStripeProduct
|
|
9778
|
-
*/
|
|
9779
|
-
'active': boolean;
|
|
9780
|
-
/**
|
|
9781
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
9782
|
-
* @type {number}
|
|
9783
|
-
* @memberof StripeStripeProduct
|
|
9784
|
-
*/
|
|
9785
|
-
'created': number;
|
|
9786
|
-
/**
|
|
9787
|
-
*
|
|
9788
|
-
* @type {StripeStripeProductDefaultPrice}
|
|
9789
|
-
* @memberof StripeStripeProduct
|
|
9790
|
-
*/
|
|
9791
|
-
'default_price'?: StripeStripeProductDefaultPrice | null;
|
|
9792
|
-
/**
|
|
9793
|
-
* Always true for a deleted object
|
|
9794
|
-
* @type {any}
|
|
9795
|
-
* @memberof StripeStripeProduct
|
|
9796
|
-
*/
|
|
9797
|
-
'deleted'?: any;
|
|
9798
|
-
/**
|
|
9799
|
-
* 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.
|
|
9800
|
-
* @type {string}
|
|
9801
|
-
* @memberof StripeStripeProduct
|
|
9802
|
-
*/
|
|
9803
|
-
'description': string | null;
|
|
9804
|
-
/**
|
|
9805
|
-
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
9806
|
-
* @type {Array<string>}
|
|
9807
|
-
* @memberof StripeStripeProduct
|
|
9808
|
-
*/
|
|
9809
|
-
'images': Array<string>;
|
|
9810
|
-
/**
|
|
9811
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
9812
|
-
* @type {boolean}
|
|
9813
|
-
* @memberof StripeStripeProduct
|
|
9814
|
-
*/
|
|
9815
|
-
'livemode': boolean;
|
|
9816
|
-
/**
|
|
9817
|
-
* 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).
|
|
9818
|
-
* @type {Array<StripeStripeProductMarketingFeature>}
|
|
9819
|
-
* @memberof StripeStripeProduct
|
|
9820
|
-
*/
|
|
9821
|
-
'marketing_features': Array<StripeStripeProductMarketingFeature>;
|
|
9822
|
-
/**
|
|
9823
|
-
* 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.
|
|
9824
|
-
* @type {{ [key: string]: string; }}
|
|
9825
|
-
* @memberof StripeStripeProduct
|
|
9826
|
-
*/
|
|
9827
|
-
'metadata': { [key: string]: string; };
|
|
9828
|
-
/**
|
|
9829
|
-
* The product\'s name, meant to be displayable to the customer.
|
|
9830
|
-
* @type {string}
|
|
9831
|
-
* @memberof StripeStripeProduct
|
|
9832
|
-
*/
|
|
9833
|
-
'name': string;
|
|
9834
|
-
/**
|
|
9835
|
-
* The dimensions of this product for shipping purposes.
|
|
9836
|
-
* @type {StripeStripeProductPackageDimensions}
|
|
9837
|
-
* @memberof StripeStripeProduct
|
|
9838
|
-
*/
|
|
9839
|
-
'package_dimensions': StripeStripeProductPackageDimensions | null;
|
|
9840
|
-
/**
|
|
9841
|
-
* Whether this product is shipped (i.e., physical goods).
|
|
9842
|
-
* @type {boolean}
|
|
9843
|
-
* @memberof StripeStripeProduct
|
|
9844
|
-
*/
|
|
9845
|
-
'shippable': boolean | null;
|
|
9846
|
-
/**
|
|
9847
|
-
* 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.
|
|
9848
|
-
* @type {string}
|
|
9849
|
-
* @memberof StripeStripeProduct
|
|
9850
|
-
*/
|
|
9851
|
-
'statement_descriptor'?: string | null;
|
|
9852
|
-
/**
|
|
9853
|
-
*
|
|
9854
|
-
* @type {StripeStripeProductTaxCode}
|
|
9855
|
-
* @memberof StripeStripeProduct
|
|
9856
|
-
*/
|
|
9857
|
-
'tax_code': StripeStripeProductTaxCode | null;
|
|
9858
|
-
/**
|
|
9859
|
-
*
|
|
9860
|
-
* @type {StripeStripeProductType}
|
|
9861
|
-
* @memberof StripeStripeProduct
|
|
9862
|
-
*/
|
|
9863
|
-
'type': StripeStripeProductType;
|
|
9864
|
-
/**
|
|
9865
|
-
* A label that represents units of this product. When set, this will be included in customers\' receipts, invoices, Checkout, and the customer portal.
|
|
9866
|
-
* @type {string}
|
|
9867
|
-
* @memberof StripeStripeProduct
|
|
9868
|
-
*/
|
|
9869
|
-
'unit_label'?: string | null;
|
|
9870
|
-
/**
|
|
9871
|
-
* Time at which the object was last updated. Measured in seconds since the Unix epoch.
|
|
9872
|
-
* @type {number}
|
|
9873
|
-
* @memberof StripeStripeProduct
|
|
9874
|
-
*/
|
|
9875
|
-
'updated': number;
|
|
9876
|
-
/**
|
|
9877
|
-
* A URL of a publicly-accessible webpage for this product.
|
|
9878
|
-
* @type {string}
|
|
9879
|
-
* @memberof StripeStripeProduct
|
|
9880
|
-
*/
|
|
9881
|
-
'url': string | null;
|
|
9882
|
-
}
|
|
9883
|
-
|
|
9884
|
-
export const StripeStripeProductObjectEnum = {
|
|
9885
|
-
Product: 'product'
|
|
9886
|
-
} as const;
|
|
9887
|
-
|
|
9888
|
-
export type StripeStripeProductObjectEnum = typeof StripeStripeProductObjectEnum[keyof typeof StripeStripeProductObjectEnum];
|
|
9889
|
-
|
|
9890
|
-
/**
|
|
9891
|
-
* The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
|
|
9892
|
-
* @export
|
|
9893
|
-
* @interface StripeStripeProductDefaultPrice
|
|
9894
|
-
*/
|
|
9895
|
-
export interface StripeStripeProductDefaultPrice {
|
|
9896
|
-
/**
|
|
9897
|
-
* Unique identifier for the object.
|
|
9898
|
-
* @type {string}
|
|
9899
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9900
|
-
*/
|
|
9901
|
-
'id': string;
|
|
9902
|
-
/**
|
|
9903
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
9904
|
-
* @type {string}
|
|
9905
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9906
|
-
*/
|
|
9907
|
-
'object': StripeStripeProductDefaultPriceObjectEnum;
|
|
9908
|
-
/**
|
|
9909
|
-
* Whether the price can be used for new purchases.
|
|
9910
|
-
* @type {boolean}
|
|
9911
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9912
|
-
*/
|
|
9913
|
-
'active': boolean;
|
|
9914
|
-
/**
|
|
9915
|
-
*
|
|
9916
|
-
* @type {StripeStripePriceBillingScheme}
|
|
9917
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9918
|
-
*/
|
|
9919
|
-
'billing_scheme': StripeStripePriceBillingScheme;
|
|
9920
|
-
/**
|
|
9921
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
9922
|
-
* @type {number}
|
|
9923
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9924
|
-
*/
|
|
9925
|
-
'created': number;
|
|
9926
|
-
/**
|
|
9927
|
-
* 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).
|
|
9928
|
-
* @type {string}
|
|
9929
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9930
|
-
*/
|
|
9931
|
-
'currency': string;
|
|
9932
|
-
/**
|
|
9933
|
-
* 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).
|
|
9934
|
-
* @type {{ [key: string]: StripeStripePriceCurrencyOptions; }}
|
|
9935
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9936
|
-
*/
|
|
9937
|
-
'currency_options'?: { [key: string]: StripeStripePriceCurrencyOptions; };
|
|
9938
|
-
/**
|
|
9939
|
-
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
9940
|
-
* @type {StripeStripePriceCustomUnitAmount}
|
|
9941
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9942
|
-
*/
|
|
9943
|
-
'custom_unit_amount': StripeStripePriceCustomUnitAmount | null;
|
|
9944
|
-
/**
|
|
9945
|
-
* Always true for a deleted object
|
|
9946
|
-
* @type {any}
|
|
9947
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9948
|
-
*/
|
|
9949
|
-
'deleted'?: any;
|
|
9950
|
-
/**
|
|
9951
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
9952
|
-
* @type {boolean}
|
|
9953
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9954
|
-
*/
|
|
9955
|
-
'livemode': boolean;
|
|
9956
|
-
/**
|
|
9957
|
-
* A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
|
9958
|
-
* @type {string}
|
|
9959
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9960
|
-
*/
|
|
9961
|
-
'lookup_key': string | null;
|
|
9962
|
-
/**
|
|
9963
|
-
* 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.
|
|
9964
|
-
* @type {{ [key: string]: string; }}
|
|
9965
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9966
|
-
*/
|
|
9967
|
-
'metadata': { [key: string]: string; };
|
|
9968
|
-
/**
|
|
9969
|
-
* A brief description of the price, hidden from customers.
|
|
9970
|
-
* @type {string}
|
|
9971
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9972
|
-
*/
|
|
9973
|
-
'nickname': string | null;
|
|
9974
|
-
/**
|
|
9975
|
-
*
|
|
9976
|
-
* @type {StripeStripePriceProduct}
|
|
9977
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9978
|
-
*/
|
|
9979
|
-
'product': StripeStripePriceProduct;
|
|
9980
|
-
/**
|
|
9981
|
-
* The recurring components of a price such as `interval` and `usage_type`.
|
|
9982
|
-
* @type {StripeStripePriceRecurring}
|
|
9983
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9984
|
-
*/
|
|
9985
|
-
'recurring': StripeStripePriceRecurring | null;
|
|
9986
|
-
/**
|
|
9987
|
-
* 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.
|
|
9988
|
-
* @type {StripeStripePriceTaxBehavior}
|
|
9989
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9990
|
-
*/
|
|
9991
|
-
'tax_behavior': StripeStripePriceTaxBehavior | null;
|
|
9992
|
-
/**
|
|
9993
|
-
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
9994
|
-
* @type {Array<StripeStripePriceTier>}
|
|
9995
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
9996
|
-
*/
|
|
9997
|
-
'tiers'?: Array<StripeStripePriceTier>;
|
|
9998
|
-
/**
|
|
9999
|
-
* 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.
|
|
10000
|
-
* @type {StripeStripePriceTiersMode}
|
|
10001
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10002
|
-
*/
|
|
10003
|
-
'tiers_mode': StripeStripePriceTiersMode | null;
|
|
10004
|
-
/**
|
|
10005
|
-
* Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
|
|
10006
|
-
* @type {StripeStripePriceTransformQuantity}
|
|
10007
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10008
|
-
*/
|
|
10009
|
-
'transform_quantity': StripeStripePriceTransformQuantity | null;
|
|
10010
|
-
/**
|
|
10011
|
-
*
|
|
10012
|
-
* @type {StripeStripePriceType}
|
|
10013
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10014
|
-
*/
|
|
10015
|
-
'type': StripeStripePriceType;
|
|
10016
|
-
/**
|
|
10017
|
-
* 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`.
|
|
10018
|
-
* @type {number}
|
|
10019
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10020
|
-
*/
|
|
10021
|
-
'unit_amount': number | null;
|
|
10022
|
-
/**
|
|
10023
|
-
* 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`.
|
|
10024
|
-
* @type {string}
|
|
10025
|
-
* @memberof StripeStripeProductDefaultPrice
|
|
10026
|
-
*/
|
|
10027
|
-
'unit_amount_decimal': string | null;
|
|
10028
|
-
}
|
|
10029
|
-
|
|
10030
|
-
export const StripeStripeProductDefaultPriceObjectEnum = {
|
|
10031
|
-
Price: 'price'
|
|
10032
|
-
} as const;
|
|
10033
|
-
|
|
10034
|
-
export type StripeStripeProductDefaultPriceObjectEnum = typeof StripeStripeProductDefaultPriceObjectEnum[keyof typeof StripeStripeProductDefaultPriceObjectEnum];
|
|
10035
|
-
|
|
10036
|
-
/**
|
|
10037
|
-
*
|
|
10038
|
-
* @export
|
|
10039
|
-
* @interface StripeStripeProductMarketingFeature
|
|
10040
|
-
*/
|
|
10041
|
-
export interface StripeStripeProductMarketingFeature {
|
|
10042
|
-
/**
|
|
10043
|
-
* The marketing feature name. Up to 80 characters long.
|
|
10044
|
-
* @type {string}
|
|
10045
|
-
* @memberof StripeStripeProductMarketingFeature
|
|
10046
|
-
*/
|
|
10047
|
-
'name'?: string;
|
|
10048
|
-
}
|
|
10049
|
-
/**
|
|
10050
|
-
*
|
|
10051
|
-
* @export
|
|
10052
|
-
* @interface StripeStripeProductPackageDimensions
|
|
10053
|
-
*/
|
|
10054
|
-
export interface StripeStripeProductPackageDimensions {
|
|
10055
|
-
/**
|
|
10056
|
-
* Height, in inches.
|
|
10057
|
-
* @type {number}
|
|
10058
|
-
* @memberof StripeStripeProductPackageDimensions
|
|
10059
|
-
*/
|
|
10060
|
-
'height': number;
|
|
10061
|
-
/**
|
|
10062
|
-
* Length, in inches.
|
|
10063
|
-
* @type {number}
|
|
10064
|
-
* @memberof StripeStripeProductPackageDimensions
|
|
10065
|
-
*/
|
|
10066
|
-
'length': number;
|
|
10067
|
-
/**
|
|
10068
|
-
* Weight, in ounces.
|
|
10069
|
-
* @type {number}
|
|
10070
|
-
* @memberof StripeStripeProductPackageDimensions
|
|
10071
|
-
*/
|
|
10072
|
-
'weight': number;
|
|
10073
|
-
/**
|
|
10074
|
-
* Width, in inches.
|
|
10075
|
-
* @type {number}
|
|
10076
|
-
* @memberof StripeStripeProductPackageDimensions
|
|
10077
|
-
*/
|
|
10078
|
-
'width': number;
|
|
10079
|
-
}
|
|
10080
|
-
/**
|
|
10081
|
-
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
|
10082
|
-
* @export
|
|
10083
|
-
* @interface StripeStripeProductTaxCode
|
|
10084
|
-
*/
|
|
10085
|
-
export interface StripeStripeProductTaxCode {
|
|
10086
|
-
/**
|
|
10087
|
-
* Unique identifier for the object.
|
|
10088
|
-
* @type {string}
|
|
10089
|
-
* @memberof StripeStripeProductTaxCode
|
|
10090
|
-
*/
|
|
10091
|
-
'id': string;
|
|
10092
|
-
/**
|
|
10093
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
10094
|
-
* @type {string}
|
|
10095
|
-
* @memberof StripeStripeProductTaxCode
|
|
10096
|
-
*/
|
|
10097
|
-
'object': StripeStripeProductTaxCodeObjectEnum;
|
|
10098
|
-
/**
|
|
10099
|
-
* A detailed description of which types of products the tax code represents.
|
|
10100
|
-
* @type {string}
|
|
10101
|
-
* @memberof StripeStripeProductTaxCode
|
|
10102
|
-
*/
|
|
10103
|
-
'description': string;
|
|
10104
|
-
/**
|
|
10105
|
-
* A short name for the tax code.
|
|
10106
|
-
* @type {string}
|
|
10107
|
-
* @memberof StripeStripeProductTaxCode
|
|
10108
|
-
*/
|
|
10109
|
-
'name': string;
|
|
10110
|
-
}
|
|
10111
|
-
|
|
10112
|
-
export const StripeStripeProductTaxCodeObjectEnum = {
|
|
10113
|
-
TaxCode: 'tax_code'
|
|
10114
|
-
} as const;
|
|
10115
|
-
|
|
10116
|
-
export type StripeStripeProductTaxCodeObjectEnum = typeof StripeStripeProductTaxCodeObjectEnum[keyof typeof StripeStripeProductTaxCodeObjectEnum];
|
|
10117
|
-
|
|
10118
|
-
/**
|
|
10119
|
-
*
|
|
10120
|
-
* @export
|
|
10121
|
-
* @enum {string}
|
|
10122
|
-
*/
|
|
10123
|
-
|
|
10124
|
-
export const StripeStripeProductType = {
|
|
10125
|
-
Good: 'good',
|
|
10126
|
-
Service: 'service'
|
|
10127
|
-
} as const;
|
|
10128
|
-
|
|
10129
|
-
export type StripeStripeProductType = typeof StripeStripeProductType[keyof typeof StripeStripeProductType];
|
|
10130
|
-
|
|
10131
|
-
|
|
10132
|
-
/**
|
|
10133
|
-
*
|
|
10134
|
-
* @export
|
|
10135
|
-
* @interface StripeStripeResponseStripeStripePrice
|
|
10136
|
-
*/
|
|
10137
|
-
export interface StripeStripeResponseStripeStripePrice {
|
|
10138
|
-
/**
|
|
10139
|
-
* Unique identifier for the object.
|
|
10140
|
-
* @type {string}
|
|
10141
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10142
|
-
*/
|
|
10143
|
-
'id': string;
|
|
10144
|
-
/**
|
|
10145
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
10146
|
-
* @type {string}
|
|
10147
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10148
|
-
*/
|
|
10149
|
-
'object': StripeStripeResponseStripeStripePriceObjectEnum;
|
|
10150
|
-
/**
|
|
10151
|
-
* Whether the price can be used for new purchases.
|
|
10152
|
-
* @type {boolean}
|
|
10153
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10154
|
-
*/
|
|
10155
|
-
'active': boolean;
|
|
10156
|
-
/**
|
|
10157
|
-
*
|
|
10158
|
-
* @type {StripeStripePriceBillingScheme}
|
|
10159
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10160
|
-
*/
|
|
10161
|
-
'billing_scheme': StripeStripePriceBillingScheme;
|
|
10162
|
-
/**
|
|
10163
|
-
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
10164
|
-
* @type {number}
|
|
10165
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10166
|
-
*/
|
|
10167
|
-
'created': number;
|
|
10168
|
-
/**
|
|
10169
|
-
* 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).
|
|
10170
|
-
* @type {string}
|
|
10171
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10172
|
-
*/
|
|
10173
|
-
'currency': string;
|
|
10174
|
-
/**
|
|
10175
|
-
* 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).
|
|
10176
|
-
* @type {{ [key: string]: StripeStripePriceCurrencyOptions; }}
|
|
10177
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10178
|
-
*/
|
|
10179
|
-
'currency_options'?: { [key: string]: StripeStripePriceCurrencyOptions; };
|
|
10180
|
-
/**
|
|
10181
|
-
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
10182
|
-
* @type {StripeStripePriceCustomUnitAmount}
|
|
10183
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10184
|
-
*/
|
|
10185
|
-
'custom_unit_amount': StripeStripePriceCustomUnitAmount | null;
|
|
10186
|
-
/**
|
|
10187
|
-
* Always true for a deleted object
|
|
10188
|
-
* @type {any}
|
|
10189
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10190
|
-
*/
|
|
10191
|
-
'deleted'?: any;
|
|
10192
|
-
/**
|
|
10193
|
-
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
10194
|
-
* @type {boolean}
|
|
10195
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10196
|
-
*/
|
|
10197
|
-
'livemode': boolean;
|
|
10198
|
-
/**
|
|
10199
|
-
* A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
|
10200
|
-
* @type {string}
|
|
10201
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10202
|
-
*/
|
|
10203
|
-
'lookup_key': string | null;
|
|
10204
|
-
/**
|
|
10205
|
-
* 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.
|
|
10206
|
-
* @type {{ [key: string]: string; }}
|
|
10207
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10208
|
-
*/
|
|
10209
|
-
'metadata': { [key: string]: string; };
|
|
10210
|
-
/**
|
|
10211
|
-
* A brief description of the price, hidden from customers.
|
|
10212
|
-
* @type {string}
|
|
10213
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10214
|
-
*/
|
|
10215
|
-
'nickname': string | null;
|
|
10216
|
-
/**
|
|
10217
|
-
*
|
|
10218
|
-
* @type {StripeStripePriceProduct}
|
|
10219
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10220
|
-
*/
|
|
10221
|
-
'product': StripeStripePriceProduct;
|
|
10222
|
-
/**
|
|
10223
|
-
* The recurring components of a price such as `interval` and `usage_type`.
|
|
10224
|
-
* @type {StripeStripePriceRecurring}
|
|
10225
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10226
|
-
*/
|
|
10227
|
-
'recurring': StripeStripePriceRecurring | null;
|
|
10228
|
-
/**
|
|
10229
|
-
* 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.
|
|
10230
|
-
* @type {StripeStripePriceTaxBehavior}
|
|
10231
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10232
|
-
*/
|
|
10233
|
-
'tax_behavior': StripeStripePriceTaxBehavior | null;
|
|
10234
|
-
/**
|
|
10235
|
-
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
10236
|
-
* @type {Array<StripeStripePriceTier>}
|
|
10237
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10238
|
-
*/
|
|
10239
|
-
'tiers'?: Array<StripeStripePriceTier>;
|
|
10240
|
-
/**
|
|
10241
|
-
* 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.
|
|
10242
|
-
* @type {StripeStripePriceTiersMode}
|
|
10243
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10244
|
-
*/
|
|
10245
|
-
'tiers_mode': StripeStripePriceTiersMode | null;
|
|
10246
|
-
/**
|
|
10247
|
-
* Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
|
|
10248
|
-
* @type {StripeStripePriceTransformQuantity}
|
|
10249
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10250
|
-
*/
|
|
10251
|
-
'transform_quantity': StripeStripePriceTransformQuantity | null;
|
|
10252
|
-
/**
|
|
10253
|
-
*
|
|
10254
|
-
* @type {StripeStripePriceType}
|
|
10255
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10256
|
-
*/
|
|
10257
|
-
'type': StripeStripePriceType;
|
|
10258
|
-
/**
|
|
10259
|
-
* 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`.
|
|
10260
|
-
* @type {number}
|
|
10261
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10262
|
-
*/
|
|
10263
|
-
'unit_amount': number | null;
|
|
10264
|
-
/**
|
|
10265
|
-
* 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`.
|
|
10266
|
-
* @type {string}
|
|
10267
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10268
|
-
*/
|
|
10269
|
-
'unit_amount_decimal': string | null;
|
|
10270
|
-
/**
|
|
10271
|
-
*
|
|
10272
|
-
* @type {StripeStripeResponseStripeStripePriceAllOfLastResponse}
|
|
10273
|
-
* @memberof StripeStripeResponseStripeStripePrice
|
|
10274
|
-
*/
|
|
10275
|
-
'lastResponse': StripeStripeResponseStripeStripePriceAllOfLastResponse;
|
|
10276
|
-
}
|
|
10277
|
-
|
|
10278
|
-
export const StripeStripeResponseStripeStripePriceObjectEnum = {
|
|
10279
|
-
Price: 'price'
|
|
10280
|
-
} as const;
|
|
10281
|
-
|
|
10282
|
-
export type StripeStripeResponseStripeStripePriceObjectEnum = typeof StripeStripeResponseStripeStripePriceObjectEnum[keyof typeof StripeStripeResponseStripeStripePriceObjectEnum];
|
|
10283
|
-
|
|
10284
|
-
/**
|
|
10285
|
-
*
|
|
10286
|
-
* @export
|
|
10287
|
-
* @interface StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10288
|
-
*/
|
|
10289
|
-
export interface StripeStripeResponseStripeStripePriceAllOfLastResponse {
|
|
10290
|
-
/**
|
|
10291
|
-
*
|
|
10292
|
-
* @type {string}
|
|
10293
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10294
|
-
*/
|
|
10295
|
-
'stripeAccount'?: string;
|
|
10296
|
-
/**
|
|
10297
|
-
*
|
|
10298
|
-
* @type {string}
|
|
10299
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10300
|
-
*/
|
|
10301
|
-
'idempotencyKey'?: string;
|
|
10302
|
-
/**
|
|
10303
|
-
*
|
|
10304
|
-
* @type {string}
|
|
10305
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10306
|
-
*/
|
|
10307
|
-
'apiVersion'?: string;
|
|
10308
|
-
/**
|
|
10309
|
-
*
|
|
10310
|
-
* @type {number}
|
|
10311
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10312
|
-
*/
|
|
10313
|
-
'statusCode': number;
|
|
10314
|
-
/**
|
|
10315
|
-
*
|
|
10316
|
-
* @type {string}
|
|
10317
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10318
|
-
*/
|
|
10319
|
-
'requestId': string;
|
|
10320
|
-
/**
|
|
10321
|
-
*
|
|
10322
|
-
* @type {{ [key: string]: string; }}
|
|
10323
|
-
* @memberof StripeStripeResponseStripeStripePriceAllOfLastResponse
|
|
10324
|
-
*/
|
|
10325
|
-
'headers': { [key: string]: string; };
|
|
10326
|
-
}
|
|
10327
|
-
/**
|
|
10328
|
-
* [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
|
|
10329
|
-
* @export
|
|
10330
|
-
* @interface StripeStripeTaxCode
|
|
10331
|
-
*/
|
|
10332
|
-
export interface StripeStripeTaxCode {
|
|
10333
|
-
/**
|
|
10334
|
-
* Unique identifier for the object.
|
|
10335
|
-
* @type {string}
|
|
10336
|
-
* @memberof StripeStripeTaxCode
|
|
10337
|
-
*/
|
|
10338
|
-
'id': string;
|
|
10339
|
-
/**
|
|
10340
|
-
* String representing the object\'s type. Objects of the same type share the same value.
|
|
10341
|
-
* @type {string}
|
|
10342
|
-
* @memberof StripeStripeTaxCode
|
|
10343
|
-
*/
|
|
10344
|
-
'object': StripeStripeTaxCodeObjectEnum;
|
|
10345
|
-
/**
|
|
10346
|
-
* A detailed description of which types of products the tax code represents.
|
|
10347
|
-
* @type {string}
|
|
10348
|
-
* @memberof StripeStripeTaxCode
|
|
10349
|
-
*/
|
|
10350
|
-
'description': string;
|
|
10351
|
-
/**
|
|
10352
|
-
* A short name for the tax code.
|
|
10353
|
-
* @type {string}
|
|
10354
|
-
* @memberof StripeStripeTaxCode
|
|
10355
|
-
*/
|
|
10356
|
-
'name': string;
|
|
10357
|
-
}
|
|
10358
|
-
|
|
10359
|
-
export const StripeStripeTaxCodeObjectEnum = {
|
|
10360
|
-
TaxCode: 'tax_code'
|
|
10361
|
-
} as const;
|
|
10362
|
-
|
|
10363
|
-
export type StripeStripeTaxCodeObjectEnum = typeof StripeStripeTaxCodeObjectEnum[keyof typeof StripeStripeTaxCodeObjectEnum];
|
|
10364
|
-
|
|
10365
|
-
/**
|
|
10366
|
-
*
|
|
10367
|
-
* @export
|
|
10368
|
-
* @interface SubscribeRequestBody
|
|
10369
|
-
*/
|
|
10370
|
-
export interface SubscribeRequestBody {
|
|
10371
|
-
/**
|
|
10372
|
-
*
|
|
10373
|
-
* @type {string}
|
|
10374
|
-
* @memberof SubscribeRequestBody
|
|
10375
|
-
*/
|
|
10376
|
-
'clubId': string;
|
|
10377
|
-
/**
|
|
10378
|
-
*
|
|
10379
|
-
* @type {string}
|
|
10380
|
-
* @memberof SubscribeRequestBody
|
|
10381
|
-
*/
|
|
10382
|
-
'priceId': string;
|
|
10383
|
-
/**
|
|
10384
|
-
*
|
|
10385
|
-
* @type {boolean}
|
|
10386
|
-
* @memberof SubscribeRequestBody
|
|
10387
|
-
*/
|
|
10388
|
-
'useDefaultPaymentMethod'?: boolean;
|
|
10389
|
-
}
|
|
10390
|
-
/**
|
|
10391
|
-
*
|
|
10392
|
-
* @export
|
|
10393
|
-
* @interface SubscriberPrice
|
|
10394
|
-
*/
|
|
10395
|
-
export interface SubscriberPrice {
|
|
10396
|
-
/**
|
|
10397
|
-
*
|
|
10398
|
-
* @type {string}
|
|
10399
|
-
* @memberof SubscriberPrice
|
|
10400
|
-
*/
|
|
10401
|
-
'subscriptionPlanId': string;
|
|
10402
|
-
/**
|
|
10403
|
-
*
|
|
10404
|
-
* @type {number}
|
|
10405
|
-
* @memberof SubscriberPrice
|
|
10406
|
-
*/
|
|
10407
|
-
'amount': number;
|
|
10408
|
-
}
|
|
10409
|
-
/**
|
|
10410
|
-
*
|
|
10411
|
-
* @export
|
|
10412
|
-
* @interface SubscriptionInfo
|
|
10413
|
-
*/
|
|
10414
|
-
export interface SubscriptionInfo {
|
|
10415
|
-
/**
|
|
10416
|
-
*
|
|
10417
|
-
* @type {string}
|
|
10418
|
-
* @memberof SubscriptionInfo
|
|
10419
|
-
*/
|
|
10420
|
-
'subscriptionPlanName'?: string;
|
|
10421
|
-
/**
|
|
10422
|
-
*
|
|
10423
|
-
* @type {string}
|
|
10424
|
-
* @memberof SubscriptionInfo
|
|
10425
|
-
*/
|
|
10426
|
-
'subscriptionDescription'?: string;
|
|
10427
|
-
/**
|
|
10428
|
-
*
|
|
10429
|
-
* @type {number}
|
|
10430
|
-
* @memberof SubscriptionInfo
|
|
10431
|
-
*/
|
|
10432
|
-
'reducedAmountInCents'?: number;
|
|
10433
|
-
}
|
|
10434
|
-
/**
|
|
10435
|
-
*
|
|
10436
|
-
* @export
|
|
10437
|
-
* @interface SubscriptionMutationResponse
|
|
10438
|
-
*/
|
|
10439
|
-
export interface SubscriptionMutationResponse {
|
|
10440
|
-
/**
|
|
10441
|
-
* Construct a type with a set of properties K of type T
|
|
10442
|
-
* @type {{ [key: string]: any; }}
|
|
10443
|
-
* @memberof SubscriptionMutationResponse
|
|
10444
|
-
*/
|
|
10445
|
-
'subscription': { [key: string]: any; };
|
|
10446
|
-
}
|
|
10447
|
-
/**
|
|
10448
|
-
*
|
|
10449
|
-
* @export
|
|
10450
|
-
* @interface SubscriptionPlanDiscountResponse
|
|
10451
|
-
*/
|
|
10452
|
-
export interface SubscriptionPlanDiscountResponse {
|
|
10453
|
-
/**
|
|
10454
|
-
*
|
|
10455
|
-
* @type {DiscountType}
|
|
10456
|
-
* @memberof SubscriptionPlanDiscountResponse
|
|
10457
|
-
*/
|
|
10458
|
-
'type': DiscountType;
|
|
10459
|
-
/**
|
|
10460
|
-
*
|
|
10461
|
-
* @type {number}
|
|
10462
|
-
* @memberof SubscriptionPlanDiscountResponse
|
|
10463
|
-
*/
|
|
10464
|
-
'percentage'?: number;
|
|
10465
|
-
/**
|
|
10466
|
-
*
|
|
10467
|
-
* @type {number}
|
|
10468
|
-
* @memberof SubscriptionPlanDiscountResponse
|
|
10469
|
-
*/
|
|
10470
|
-
'maxDiscountAmountInCents'?: number;
|
|
10471
|
-
/**
|
|
10472
|
-
*
|
|
10473
|
-
* @type {string}
|
|
10474
|
-
* @memberof SubscriptionPlanDiscountResponse
|
|
10475
|
-
*/
|
|
10476
|
-
'validFrom'?: string;
|
|
10477
|
-
/**
|
|
10478
|
-
*
|
|
10479
|
-
* @type {string}
|
|
10480
|
-
* @memberof SubscriptionPlanDiscountResponse
|
|
10481
|
-
*/
|
|
10482
|
-
'validTo'?: string;
|
|
10483
|
-
/**
|
|
10484
|
-
*
|
|
10485
|
-
* @type {Array<string>}
|
|
10486
|
-
* @memberof SubscriptionPlanDiscountResponse
|
|
10487
|
-
*/
|
|
10488
|
-
'offPeakRuleNames'?: Array<string>;
|
|
10489
|
-
/**
|
|
10490
|
-
*
|
|
10491
|
-
* @type {Array<OffPeakRule>}
|
|
10492
|
-
* @memberof SubscriptionPlanDiscountResponse
|
|
10493
|
-
*/
|
|
10494
|
-
'offPeakRules'?: Array<OffPeakRule>;
|
|
10495
|
-
/**
|
|
10496
|
-
*
|
|
10497
|
-
* @type {boolean}
|
|
10498
|
-
* @memberof SubscriptionPlanDiscountResponse
|
|
10499
|
-
*/
|
|
10500
|
-
'bookingFree'?: boolean;
|
|
10501
|
-
}
|
|
10502
|
-
|
|
10503
|
-
|
|
10504
|
-
/**
|
|
10505
|
-
*
|
|
10506
|
-
* @export
|
|
10507
|
-
* @interface SubscriptionPlanResponse
|
|
10508
|
-
*/
|
|
10509
|
-
export interface SubscriptionPlanResponse {
|
|
10510
|
-
/**
|
|
10511
|
-
*
|
|
10512
|
-
* @type {string}
|
|
10513
|
-
* @memberof SubscriptionPlanResponse
|
|
10514
|
-
*/
|
|
10515
|
-
'productId': string;
|
|
10516
|
-
/**
|
|
10517
|
-
*
|
|
10518
|
-
* @type {string}
|
|
10519
|
-
* @memberof SubscriptionPlanResponse
|
|
10520
|
-
*/
|
|
10521
|
-
'productName': string;
|
|
10522
|
-
/**
|
|
10523
|
-
*
|
|
10524
|
-
* @type {boolean}
|
|
10525
|
-
* @memberof SubscriptionPlanResponse
|
|
10526
|
-
*/
|
|
10527
|
-
'productActive': boolean;
|
|
10528
|
-
/**
|
|
10529
|
-
*
|
|
10530
|
-
* @type {string}
|
|
10531
|
-
* @memberof SubscriptionPlanResponse
|
|
10532
|
-
*/
|
|
10533
|
-
'priceId': string;
|
|
10534
|
-
/**
|
|
10535
|
-
*
|
|
10536
|
-
* @type {number}
|
|
10537
|
-
* @memberof SubscriptionPlanResponse
|
|
10538
|
-
*/
|
|
10539
|
-
'amountInCents'?: number;
|
|
10540
|
-
/**
|
|
10541
|
-
*
|
|
10542
|
-
* @type {string}
|
|
10543
|
-
* @memberof SubscriptionPlanResponse
|
|
10544
|
-
*/
|
|
10545
|
-
'currency': string;
|
|
10546
|
-
/**
|
|
10547
|
-
*
|
|
10548
|
-
* @type {Array<PlanPrice>}
|
|
10549
|
-
* @memberof SubscriptionPlanResponse
|
|
10550
|
-
*/
|
|
10551
|
-
'prices': Array<PlanPrice>;
|
|
10552
|
-
/**
|
|
10553
|
-
*
|
|
10554
|
-
* @type {PlanInterval}
|
|
10555
|
-
* @memberof SubscriptionPlanResponse
|
|
10556
|
-
*/
|
|
10557
|
-
'interval'?: PlanInterval;
|
|
10558
|
-
/**
|
|
10559
|
-
*
|
|
10560
|
-
* @type {boolean}
|
|
10561
|
-
* @memberof SubscriptionPlanResponse
|
|
10562
|
-
*/
|
|
10563
|
-
'priceActive': boolean;
|
|
10564
|
-
/**
|
|
10565
|
-
*
|
|
10566
|
-
* @type {string}
|
|
10567
|
-
* @memberof SubscriptionPlanResponse
|
|
10568
|
-
*/
|
|
10569
|
-
'description'?: string;
|
|
10570
|
-
/**
|
|
10571
|
-
*
|
|
10572
|
-
* @type {SubscriptionPlanDiscountResponse}
|
|
10573
|
-
* @memberof SubscriptionPlanResponse
|
|
10574
|
-
*/
|
|
10575
|
-
'discount'?: SubscriptionPlanDiscountResponse;
|
|
10576
|
-
}
|
|
10577
|
-
|
|
10578
|
-
|
|
10579
|
-
/**
|
|
10580
|
-
*
|
|
10581
|
-
* @export
|
|
10582
|
-
* @enum {string}
|
|
10583
|
-
*/
|
|
10584
|
-
|
|
10585
|
-
export const SurfaceType = {
|
|
10586
|
-
Clay: 'clay',
|
|
10587
|
-
Grass: 'grass',
|
|
10588
|
-
Hard: 'hard'
|
|
10589
|
-
} as const;
|
|
10590
|
-
|
|
10591
|
-
export type SurfaceType = typeof SurfaceType[keyof typeof SurfaceType];
|
|
10592
|
-
|
|
10593
|
-
|
|
10594
|
-
/**
|
|
10595
|
-
*
|
|
10596
|
-
* @export
|
|
10597
|
-
* @interface Team
|
|
10598
|
-
*/
|
|
10599
|
-
export interface Team {
|
|
9464
|
+
export interface Team {
|
|
10600
9465
|
/**
|
|
10601
9466
|
*
|
|
10602
9467
|
* @type {string}
|
|
@@ -11216,25 +10081,6 @@ export interface UpdateLevelBySportsRequestBody {
|
|
|
11216
10081
|
*/
|
|
11217
10082
|
'levelBySports': Array<LevelBySportEntry>;
|
|
11218
10083
|
}
|
|
11219
|
-
/**
|
|
11220
|
-
*
|
|
11221
|
-
* @export
|
|
11222
|
-
* @interface UpdatePlanRequest
|
|
11223
|
-
*/
|
|
11224
|
-
export interface UpdatePlanRequest {
|
|
11225
|
-
/**
|
|
11226
|
-
*
|
|
11227
|
-
* @type {number}
|
|
11228
|
-
* @memberof UpdatePlanRequest
|
|
11229
|
-
*/
|
|
11230
|
-
'newAmountInCents': number;
|
|
11231
|
-
/**
|
|
11232
|
-
*
|
|
11233
|
-
* @type {string}
|
|
11234
|
-
* @memberof UpdatePlanRequest
|
|
11235
|
-
*/
|
|
11236
|
-
'oldPriceId': string;
|
|
11237
|
-
}
|
|
11238
10084
|
/**
|
|
11239
10085
|
*
|
|
11240
10086
|
* @export
|
|
@@ -11450,6 +10296,63 @@ export interface UpdateSubscriptionPlanForClub200Response {
|
|
|
11450
10296
|
*/
|
|
11451
10297
|
'price': any;
|
|
11452
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
|
+
|
|
11453
10356
|
/**
|
|
11454
10357
|
*
|
|
11455
10358
|
* @export
|
|
@@ -23899,14 +22802,14 @@ export const SubscriptionsManagerApiAxiosParamCreator = function (configuration?
|
|
|
23899
22802
|
};
|
|
23900
22803
|
},
|
|
23901
22804
|
/**
|
|
23902
|
-
* Met à jour un plan en
|
|
23903
|
-
* @param {
|
|
22805
|
+
* Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
|
|
22806
|
+
* @param {UpdateSubscriptionPlanRequest} updateSubscriptionPlanRequest
|
|
23904
22807
|
* @param {*} [options] Override http request option.
|
|
23905
22808
|
* @throws {RequiredError}
|
|
23906
22809
|
*/
|
|
23907
|
-
updatePlan: async (
|
|
23908
|
-
// verify required parameter '
|
|
23909
|
-
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)
|
|
23910
22813
|
const localVarPath = `/api/subscriptions/plans`;
|
|
23911
22814
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23912
22815
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -23930,7 +22833,7 @@ export const SubscriptionsManagerApiAxiosParamCreator = function (configuration?
|
|
|
23930
22833
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23931
22834
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23932
22835
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
23933
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
22836
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateSubscriptionPlanRequest, localVarRequestOptions, configuration)
|
|
23934
22837
|
|
|
23935
22838
|
return {
|
|
23936
22839
|
url: toPathString(localVarUrlObj),
|
|
@@ -23984,13 +22887,13 @@ export const SubscriptionsManagerApiFp = function(configuration?: Configuration)
|
|
|
23984
22887
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23985
22888
|
},
|
|
23986
22889
|
/**
|
|
23987
|
-
* Met à jour un plan en
|
|
23988
|
-
* @param {
|
|
22890
|
+
* Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
|
|
22891
|
+
* @param {UpdateSubscriptionPlanRequest} updateSubscriptionPlanRequest
|
|
23989
22892
|
* @param {*} [options] Override http request option.
|
|
23990
22893
|
* @throws {RequiredError}
|
|
23991
22894
|
*/
|
|
23992
|
-
async updatePlan(
|
|
23993
|
-
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);
|
|
23994
22897
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
23995
22898
|
const localVarOperationServerBasePath = operationServerMap['SubscriptionsManagerApi.updatePlan']?.[localVarOperationServerIndex]?.url;
|
|
23996
22899
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -24033,13 +22936,13 @@ export const SubscriptionsManagerApiFactory = function (configuration?: Configur
|
|
|
24033
22936
|
return localVarFp.deletePlan(requestParameters.productId, options).then((request) => request(axios, basePath));
|
|
24034
22937
|
},
|
|
24035
22938
|
/**
|
|
24036
|
-
* Met à jour un plan en
|
|
22939
|
+
* Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
|
|
24037
22940
|
* @param {SubscriptionsManagerApiUpdatePlanRequest} requestParameters Request parameters.
|
|
24038
22941
|
* @param {*} [options] Override http request option.
|
|
24039
22942
|
* @throws {RequiredError}
|
|
24040
22943
|
*/
|
|
24041
|
-
updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
24042
|
-
return localVarFp.updatePlan(requestParameters.
|
|
22944
|
+
updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<any> {
|
|
22945
|
+
return localVarFp.updatePlan(requestParameters.updateSubscriptionPlanRequest, options).then((request) => request(axios, basePath));
|
|
24043
22946
|
},
|
|
24044
22947
|
};
|
|
24045
22948
|
};
|
|
@@ -24094,10 +22997,10 @@ export interface SubscriptionsManagerApiDeletePlanRequest {
|
|
|
24094
22997
|
export interface SubscriptionsManagerApiUpdatePlanRequest {
|
|
24095
22998
|
/**
|
|
24096
22999
|
*
|
|
24097
|
-
* @type {
|
|
23000
|
+
* @type {UpdateSubscriptionPlanRequest}
|
|
24098
23001
|
* @memberof SubscriptionsManagerApiUpdatePlan
|
|
24099
23002
|
*/
|
|
24100
|
-
readonly
|
|
23003
|
+
readonly updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest
|
|
24101
23004
|
}
|
|
24102
23005
|
|
|
24103
23006
|
/**
|
|
@@ -24141,14 +23044,14 @@ export class SubscriptionsManagerApi extends BaseAPI {
|
|
|
24141
23044
|
}
|
|
24142
23045
|
|
|
24143
23046
|
/**
|
|
24144
|
-
* Met à jour un plan en
|
|
23047
|
+
* Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
|
|
24145
23048
|
* @param {SubscriptionsManagerApiUpdatePlanRequest} requestParameters Request parameters.
|
|
24146
23049
|
* @param {*} [options] Override http request option.
|
|
24147
23050
|
* @throws {RequiredError}
|
|
24148
23051
|
* @memberof SubscriptionsManagerApi
|
|
24149
23052
|
*/
|
|
24150
23053
|
public updatePlan(requestParameters: SubscriptionsManagerApiUpdatePlanRequest, options?: RawAxiosRequestConfig) {
|
|
24151
|
-
return SubscriptionsManagerApiFp(this.configuration).updatePlan(requestParameters.
|
|
23054
|
+
return SubscriptionsManagerApiFp(this.configuration).updatePlan(requestParameters.updateSubscriptionPlanRequest, options).then((request) => request(this.axios, this.basePath));
|
|
24152
23055
|
}
|
|
24153
23056
|
}
|
|
24154
23057
|
|