/
home
/
techb158
/
balavpn.abdallabala.com
/
node_modules
/
stripe
/
types
/
/home/techb158/balavpn.abdallabala.com/node_modules/stripe/types
mkdir
upload
Name
Size
Mode
Actions
Apps/
-
0777
rm
Billing/
-
0777
rm
BillingPortal/
-
0777
rm
Checkout/
-
0777
rm
Climate/
-
0777
rm
crypto/
-
0777
rm
Entitlements/
-
0777
rm
FinancialConnections/
-
0777
rm
Forwarding/
-
0777
rm
Identity/
-
0777
rm
Issuing/
-
0777
rm
net/
-
0777
rm
Radar/
-
0777
rm
Reporting/
-
0777
rm
Sigma/
-
0777
rm
Tax/
-
0777
rm
Terminal/
-
0777
rm
test/
-
0777
rm
TestHelpers/
-
0777
rm
Treasury/
-
0777
rm
V2/
-
0777
rm
.eslintrc.js
620
0666
edit
dl
rm
AccountLinks.d.ts
893
0666
edit
dl
rm
AccountLinksResource.d.ts
2898
0666
edit
dl
rm
Accounts.d.ts
63448
0666
edit
dl
rm
AccountSessions.d.ts
17282
0666
edit
dl
rm
AccountSessionsResource.d.ts
19316
0666
edit
dl
rm
AccountsResource.d.ts
181754
0666
edit
dl
rm
ApplePayDomains.d.ts
1241
0666
edit
dl
rm
ApplePayDomainsResource.d.ts
1962
0666
edit
dl
rm
ApplicationFees.d.ts
3040
0666
edit
dl
rm
ApplicationFeesResource.d.ts
6115
0666
edit
dl
rm
Applications.d.ts
1064
0666
edit
dl
rm
Balance.d.ts
8675
0666
edit
dl
rm
BalanceResource.d.ts
817
0666
edit
dl
rm
BalanceTransactions.d.ts
6553
0666
edit
dl
rm
BalanceTransactionSources.d.ts
499
0666
edit
dl
rm
BalanceTransactionsResource.d.ts
3247
0666
edit
dl
rm
BankAccounts.d.ts
18753
0666
edit
dl
rm
Capabilities.d.ts
17891
0666
edit
dl
rm
Cards.d.ts
8674
0666
edit
dl
rm
CashBalances.d.ts
1711
0666
edit
dl
rm
Charges.d.ts
81258
0666
edit
dl
rm
ChargesResource.d.ts
19232
0666
edit
dl
rm
ConfirmationTokens.d.ts
54015
0666
edit
dl
rm
ConfirmationTokensResource.d.ts
698
0666
edit
dl
rm
ConnectCollectionTransfers.d.ts
1063
0666
edit
dl
rm
CountrySpecs.d.ts
2759
0666
edit
dl
rm
CountrySpecsResource.d.ts
1145
0666
edit
dl
rm
Coupons.d.ts
4525
0666
edit
dl
rm
CouponsResource.d.ts
7997
0666
edit
dl
rm
CreditNoteLineItems.d.ts
5515
0666
edit
dl
rm
CreditNotes.d.ts
10417
0666
edit
dl
rm
CreditNotesResource.d.ts
21683
0666
edit
dl
rm
CustomerBalanceTransactions.d.ts
3534
0666
edit
dl
rm
CustomerCashBalanceTransactions.d.ts
7655
0666
edit
dl
rm
Customers.d.ts
10312
0666
edit
dl
rm
CustomerSessions.d.ts
6659
0666
edit
dl
rm
CustomerSessionsResource.d.ts
5543
0666
edit
dl
rm
CustomerSources.d.ts
227
0666
edit
dl
rm
CustomersResource.d.ts
49272
0666
edit
dl
rm
Deprecations.d.ts
6759
0666
edit
dl
rm
Discounts.d.ts
5697
0666
edit
dl
rm
Disputes.d.ts
18934
0666
edit
dl
rm
DisputesResource.d.ts
15462
0666
edit
dl
rm
EphemeralKeys.d.ts
975
0666
edit
dl
rm
EphemeralKeysResource.d.ts
1793
0666
edit
dl
rm
Errors.d.ts
9706
0666
edit
dl
rm
Events.d.ts
14107
0666
edit
dl
rm
EventsResource.d.ts
2309
0666
edit
dl
rm
EventTypes.d.ts
120304
0666
edit
dl
rm
ExchangeRates.d.ts
2348
0666
edit
dl
rm
ExchangeRatesResource.d.ts
1294
0666
edit
dl
rm
ExternalAccounts.d.ts
210
0666
edit
dl
rm
FeeRefunds.d.ts
1730
0666
edit
dl
rm
FileLinks.d.ts
1529
0666
edit
dl
rm
FileLinksResource.d.ts
3788
0666
edit
dl
rm
Files.d.ts
2560
0666
edit
dl
rm
FilesResource.d.ts
4886
0666
edit
dl
rm
FundingInstructions.d.ts
7588
0666
edit
dl
rm
index.d.ts
26330
0666
edit
dl
rm
InvoiceItems.d.ts
5720
0666
edit
dl
rm
InvoiceItemsResource.d.ts
16679
0666
edit
dl
rm
InvoiceLineItems.d.ts
8170
0666
edit
dl
rm
InvoiceRenderingTemplates.d.ts
1735
0666
edit
dl
rm
InvoiceRenderingTemplatesResource.d.ts
3109
0666
edit
dl
rm
Invoices.d.ts
59291
0666
edit
dl
rm
InvoicesResource.d.ts
272335
0666
edit
dl
rm
lib.d.ts
9208
0666
edit
dl
rm
LineItems.d.ts
3747
0666
edit
dl
rm
LoginLinks.d.ts
805
0666
edit
dl
rm
Mandates.d.ts
6963
0666
edit
dl
rm
MandatesResource.d.ts
629
0666
edit
dl
rm
OAuth.d.ts
13056
0666
edit
dl
rm
PaymentIntents.d.ts
126400
0666
edit
dl
rm
PaymentIntentsResource.d.ts
425657
0666
edit
dl
rm
PaymentLinks.d.ts
26988
0666
edit
dl
rm
PaymentLinksResource.d.ts
61599
0666
edit
dl
rm
PaymentMethodConfigurations.d.ts
46290
0666
edit
dl
rm
PaymentMethodConfigurationsResource.d.ts
82027
0666
edit
dl
rm
PaymentMethodDomains.d.ts
5253
0666
edit
dl
rm
PaymentMethodDomainsResource.d.ts
4080
0666
edit
dl
rm
PaymentMethods.d.ts
48133
0666
edit
dl
rm
PaymentMethodsResource.d.ts
31934
0666
edit
dl
rm
Payouts.d.ts
6830
0666
edit
dl
rm
PayoutsResource.d.ts
8033
0666
edit
dl
rm
Persons.d.ts
28323
0666
edit
dl
rm
Plans.d.ts
7540
0666
edit
dl
rm
PlansResource.d.ts
11964
0666
edit
dl
rm
Prices.d.ts
12348
0666
edit
dl
rm
PricesResource.d.ts
23771
0666
edit
dl
rm
ProductFeatures.d.ts
1595
0666
edit
dl
rm
Products.d.ts
5225
0666
edit
dl
rm
ProductsResource.d.ts
22445
0666
edit
dl
rm
PromotionCodes.d.ts
4009
0666
edit
dl
rm
PromotionCodesResource.d.ts
7472
0666
edit
dl
rm
Quotes.d.ts
22541
0666
edit
dl
rm
QuotesResource.d.ts
32380
0666
edit
dl
rm
Refunds.d.ts
12150
0666
edit
dl
rm
RefundsResource.d.ts
6972
0666
edit
dl
rm
ReserveTransactions.d.ts
812
0666
edit
dl
rm
Reviews.d.ts
3939
0666
edit
dl
rm
ReviewsResource.d.ts
1895
0666
edit
dl
rm
SetupAttempts.d.ts
30914
0666
edit
dl
rm
SetupAttemptsResource.d.ts
972
0666
edit
dl
rm
SetupIntents.d.ts
35147
0666
edit
dl
rm
SetupIntentsResource.d.ts
130075
0666
edit
dl
rm
shared.d.ts
4263
0666
edit
dl
rm
ShippingRates.d.ts
4744
0666
edit
dl
rm
ShippingRatesResource.d.ts
8383
0666
edit
dl
rm
SourceMandateNotifications.d.ts
3491
0666
edit
dl
rm
Sources.d.ts
20443
0666
edit
dl
rm
SourcesResource.d.ts
19833
0666
edit
dl
rm
SourceTransactions.d.ts
5248
0666
edit
dl
rm
SubscriptionItems.d.ts
4653
0666
edit
dl
rm
SubscriptionItemsResource.d.ts
23230
0666
edit
dl
rm
Subscriptions.d.ts
30567
0666
edit
dl
rm
SubscriptionSchedules.d.ts
23402
0666
edit
dl
rm
SubscriptionSchedulesResource.d.ts
61127
0666
edit
dl
rm
SubscriptionsResource.d.ts
88064
0666
edit
dl
rm
TaxCodes.d.ts
685
0666
edit
dl
rm
TaxCodesResource.d.ts
1291
0666
edit
dl
rm
TaxDeductedAtSources.d.ts
886
0666
edit
dl
rm
TaxIds.d.ts
6322
0666
edit
dl
rm
TaxIdsResource.d.ts
6265
0666
edit
dl
rm
TaxRates.d.ts
5056
0666
edit
dl
rm
TaxRatesResource.d.ts
6537
0666
edit
dl
rm
ThinEvent.d.ts
847
0666
edit
dl
rm
Tokens.d.ts
3363
0666
edit
dl
rm
TokensResource.d.ts
34353
0666
edit
dl
rm
Topups.d.ts
3284
0666
edit
dl
rm
TopupsResource.d.ts
5249
0666
edit
dl
rm
TransferReversals.d.ts
2543
0666
edit
dl
rm
Transfers.d.ts
3676
0666
edit
dl
rm
TransfersResource.d.ts
10601
0666
edit
dl
rm
UpcomingInvoices.d.ts
108
0666
edit
dl
rm
UsageRecords.d.ts
1261
0666
edit
dl
rm
UsageRecordSummaries.d.ts
1474
0666
edit
dl
rm
WebhookEndpoints.d.ts
2865
0666
edit
dl
rm
WebhookEndpointsResource.d.ts
26655
0666
edit
dl
rm
Webhooks.d.ts
4627
0666
edit
dl
rm
Edit:
/home/techb158/balavpn.abdallabala.com/node_modules/stripe/types/SubscriptionItemsResource.d.ts
(23230B)
// File generated from our OpenAPI spec declare module 'stripe' { namespace Stripe { interface SubscriptionItemCreateParams { /** * The identifier of the subscription to modify. */ subscription: string; /** * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Stripe.Emptyable< SubscriptionItemCreateParams.BillingThresholds >; /** * The coupons to redeem into discounts for the subscription item. */ discounts?: Stripe.Emptyable< Array<SubscriptionItemCreateParams.Discount> >; /** * Specifies which fields in the response should be expanded. */ expand?: Array<string>; /** * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: Stripe.MetadataParam; /** * Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. * * Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). * * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. */ payment_behavior?: SubscriptionItemCreateParams.PaymentBehavior; /** * The identifier of the plan to add to the subscription. */ plan?: string; /** * The ID of the price object. */ price?: string; /** * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: SubscriptionItemCreateParams.PriceData; /** * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. */ proration_behavior?: SubscriptionItemCreateParams.ProrationBehavior; /** * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ proration_date?: number; /** * The quantity you'd like to apply to the subscription item you're creating. */ quantity?: number; /** * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ tax_rates?: Stripe.Emptyable<Array<string>>; } namespace SubscriptionItemCreateParams { interface BillingThresholds { /** * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) */ usage_gte: number; } interface Discount { /** * ID of the coupon to create a new discount for. */ coupon?: string; /** * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; /** * ID of the promotion code to create a new discount for. */ promotion_code?: string; } type PaymentBehavior = | 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete'; interface PriceData { /** * 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). */ currency: string; /** * The ID of the product that this price will belong to. */ product: string; /** * The recurring components of a price such as `interval` and `interval_count`. */ recurring: PriceData.Recurring; /** * 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. */ tax_behavior?: PriceData.TaxBehavior; /** * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. */ unit_amount?: number; /** * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ unit_amount_decimal?: string; } namespace PriceData { interface Recurring { /** * Specifies billing frequency. Either `day`, `week`, `month` or `year`. */ interval: Recurring.Interval; /** * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). */ interval_count?: number; } namespace Recurring { type Interval = 'day' | 'month' | 'week' | 'year'; } type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified'; } type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none'; } interface SubscriptionItemRetrieveParams { /** * Specifies which fields in the response should be expanded. */ expand?: Array<string>; } interface SubscriptionItemUpdateParams { /** * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Stripe.Emptyable< SubscriptionItemUpdateParams.BillingThresholds >; /** * The coupons to redeem into discounts for the subscription item. */ discounts?: Stripe.Emptyable< Array<SubscriptionItemUpdateParams.Discount> >; /** * Specifies which fields in the response should be expanded. */ expand?: Array<string>; /** * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: Stripe.Emptyable<Stripe.MetadataParam>; /** * Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ off_session?: boolean; /** * Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. * * Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). * * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. */ payment_behavior?: SubscriptionItemUpdateParams.PaymentBehavior; /** * The identifier of the new plan for this subscription item. */ plan?: string; /** * The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. */ price?: string; /** * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: SubscriptionItemUpdateParams.PriceData; /** * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. */ proration_behavior?: SubscriptionItemUpdateParams.ProrationBehavior; /** * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ proration_date?: number; /** * The quantity you'd like to apply to the subscription item you're creating. */ quantity?: number; /** * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ tax_rates?: Stripe.Emptyable<Array<string>>; } namespace SubscriptionItemUpdateParams { interface BillingThresholds { /** * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) */ usage_gte: number; } interface Discount { /** * ID of the coupon to create a new discount for. */ coupon?: string; /** * ID of an existing discount on the object (or one of its ancestors) to reuse. */ discount?: string; /** * ID of the promotion code to create a new discount for. */ promotion_code?: string; } type PaymentBehavior = | 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete'; interface PriceData { /** * 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). */ currency: string; /** * The ID of the product that this price will belong to. */ product: string; /** * The recurring components of a price such as `interval` and `interval_count`. */ recurring: PriceData.Recurring; /** * 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. */ tax_behavior?: PriceData.TaxBehavior; /** * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. */ unit_amount?: number; /** * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ unit_amount_decimal?: string; } namespace PriceData { interface Recurring { /** * Specifies billing frequency. Either `day`, `week`, `month` or `year`. */ interval: Recurring.Interval; /** * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). */ interval_count?: number; } namespace Recurring { type Interval = 'day' | 'month' | 'week' | 'year'; } type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified'; } type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none'; } interface SubscriptionItemListParams extends PaginationParams { /** * The ID of the subscription whose items will be retrieved. */ subscription: string; /** * Specifies which fields in the response should be expanded. */ expand?: Array<string>; } interface SubscriptionItemDeleteParams { /** * Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ clear_usage?: boolean; /** * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. */ proration_behavior?: SubscriptionItemDeleteParams.ProrationBehavior; /** * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ proration_date?: number; } namespace SubscriptionItemDeleteParams { type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none'; } interface SubscriptionItemCreateUsageRecordParams { /** * The usage quantity for the specified timestamp. */ quantity: number; /** * Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. */ action?: SubscriptionItemCreateUsageRecordParams.Action; /** * Specifies which fields in the response should be expanded. */ expand?: Array<string>; /** * The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided. */ timestamp?: 'now' | number; } namespace SubscriptionItemCreateUsageRecordParams { type Action = 'increment' | 'set'; } interface SubscriptionItemListUsageRecordSummariesParams extends PaginationParams { /** * Specifies which fields in the response should be expanded. */ expand?: Array<string>; } class SubscriptionItemsResource { /** * Adds a new item to an existing subscription. No existing items will be changed or replaced. */ create( params: SubscriptionItemCreateParams, options?: RequestOptions ): Promise<Stripe.Response<Stripe.SubscriptionItem>>; /** * Retrieves the subscription item with the given ID. */ retrieve( id: string, params?: SubscriptionItemRetrieveParams, options?: RequestOptions ): Promise<Stripe.Response<Stripe.SubscriptionItem>>; retrieve( id: string, options?: RequestOptions ): Promise<Stripe.Response<Stripe.SubscriptionItem>>; /** * Updates the plan or quantity of an item on a current subscription. */ update( id: string, params?: SubscriptionItemUpdateParams, options?: RequestOptions ): Promise<Stripe.Response<Stripe.SubscriptionItem>>; /** * Returns a list of your subscription items for a given subscription. */ list( params: SubscriptionItemListParams, options?: RequestOptions ): ApiListPromise<Stripe.SubscriptionItem>; /** * Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription. */ del( id: string, params?: SubscriptionItemDeleteParams, options?: RequestOptions ): Promise<Stripe.Response<Stripe.DeletedSubscriptionItem>>; del( id: string, options?: RequestOptions ): Promise<Stripe.Response<Stripe.DeletedSubscriptionItem>>; /** * Creates a usage record for a specified subscription item and date, and fills it with a quantity. * * Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the [metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) plan, Stripe helps you send accurate invoices to your customers. * * The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan's aggregate_usage [parameter](https://stripe.com/docs/api/plans/create#create_plan-aggregate_usage). When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter. * * The default pricing model for metered billing is [per-unit pricing. For finer granularity, you can configure metered billing to have a <a href="https://stripe.com/docs/billing/subscriptions/tiers">tiered pricing](https://stripe.com/docs/api/plans/object#plan_object-billing_scheme) model. */ createUsageRecord( id: string, params: SubscriptionItemCreateUsageRecordParams, options?: RequestOptions ): Promise<Stripe.Response<Stripe.UsageRecord>>; /** * For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that's been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September). * * The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn't ended yet. Since new usage records can still be added, the returned summary information for the subscription item's ID should be seen as unstable until the subscription billing period ends. */ listUsageRecordSummaries( id: string, params?: SubscriptionItemListUsageRecordSummariesParams, options?: RequestOptions ): ApiListPromise<Stripe.UsageRecordSummary>; listUsageRecordSummaries( id: string, options?: RequestOptions ): ApiListPromise<Stripe.UsageRecordSummary>; } } }
Save
cmd:
run