stripe
Version:
Stripe API wrapper
608 lines (496 loc) • 23.6 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
interface PriceCreateParams {
/**
* 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;
/**
* Whether the price can be used for new purchases. Defaults to `true`.
*/
active?: boolean;
/**
* Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
*/
billing_scheme?: PriceCreateParams.BillingScheme;
/**
* 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).
*/
currency_options?: {
[]: PriceCreateParams.CurrencyOptions;
};
/**
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
*/
custom_unit_amount?: PriceCreateParams.CustomUnitAmount;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
*/
lookup_key?: 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;
/**
* A brief description of the price, hidden from customers.
*/
nickname?: string;
/**
* The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
*/
product?: string;
/**
* These fields can be used to create a new product that this price will belong to.
*/
product_data?: PriceCreateParams.ProductData;
/**
* The recurring components of a price such as `interval` and `usage_type`.
*/
recurring?: PriceCreateParams.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?: PriceCreateParams.TaxBehavior;
/**
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
*/
tiers?: Array<PriceCreateParams.Tier>;
/**
* 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 successively change as the quantity grows.
*/
tiers_mode?: PriceCreateParams.TiersMode;
/**
* If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
*/
transfer_lookup_key?: boolean;
/**
* Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
*/
transform_quantity?: PriceCreateParams.TransformQuantity;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.
*/
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 PriceCreateParams {
type BillingScheme = 'per_unit' | 'tiered';
interface CurrencyOptions {
/**
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
*/
custom_unit_amount?: CurrencyOptions.CustomUnitAmount;
/**
* 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?: CurrencyOptions.TaxBehavior;
/**
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
*/
tiers?: Array<CurrencyOptions.Tier>;
/**
* 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 CurrencyOptions {
interface CustomUnitAmount {
/**
* Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
*/
enabled: boolean;
/**
* The maximum unit amount the customer can specify for this item.
*/
maximum?: number;
/**
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
*/
minimum?: number;
/**
* The starting unit amount which can be updated by the customer.
*/
preset?: number;
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
interface Tier {
/**
* The flat billing amount for an entire tier, regardless of the number of units in the tier.
*/
flat_amount?: number;
/**
* Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
*/
flat_amount_decimal?: string;
/**
* The per unit billing amount for each individual unit for which this tier applies.
*/
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;
/**
* Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
*/
up_to: 'inf' | number;
}
}
interface CustomUnitAmount {
/**
* Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
*/
enabled: boolean;
/**
* The maximum unit amount the customer can specify for this item.
*/
maximum?: number;
/**
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
*/
minimum?: number;
/**
* The starting unit amount which can be updated by the customer.
*/
preset?: number;
}
interface ProductData {
/**
* Whether the product is currently available for purchase. Defaults to `true`.
*/
active?: boolean;
/**
* The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
*/
id?: 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;
/**
* The product's name, meant to be displayable to the customer.
*/
name: string;
/**
* An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
*
* This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
*/
statement_descriptor?: string;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;
/**
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
*/
unit_label?: string;
}
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;
/**
* The meter tracking the usage of a metered price
*/
meter?: string;
/**
* 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).
*/
trial_period_days?: number;
/**
* Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
*/
usage_type?: Recurring.UsageType;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
type UsageType = 'licensed' | 'metered';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
interface Tier {
/**
* The flat billing amount for an entire tier, regardless of the number of units in the tier.
*/
flat_amount?: number;
/**
* Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
*/
flat_amount_decimal?: string;
/**
* The per unit billing amount for each individual unit for which this tier applies.
*/
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;
/**
* Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
*/
up_to: 'inf' | number;
}
type TiersMode = 'graduated' | 'volume';
interface TransformQuantity {
/**
* Divide usage by this number.
*/
divide_by: number;
/**
* After division, either round the result `up` or `down`.
*/
round: TransformQuantity.Round;
}
namespace TransformQuantity {
type Round = 'down' | 'up';
}
}
interface PriceRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface PriceUpdateParams {
/**
* Whether the price can be used for new purchases. Defaults to `true`.
*/
active?: boolean;
/**
* 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).
*/
currency_options?: Stripe.Emptyable<{
[]: PriceUpdateParams.CurrencyOptions;
}>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
*/
lookup_key?: 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>;
/**
* A brief description of the price, hidden from customers.
*/
nickname?: string;
/**
* 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?: PriceUpdateParams.TaxBehavior;
/**
* If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
*/
transfer_lookup_key?: boolean;
}
namespace PriceUpdateParams {
interface CurrencyOptions {
/**
* When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
*/
custom_unit_amount?: CurrencyOptions.CustomUnitAmount;
/**
* 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?: CurrencyOptions.TaxBehavior;
/**
* Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
*/
tiers?: Array<CurrencyOptions.Tier>;
/**
* 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 CurrencyOptions {
interface CustomUnitAmount {
/**
* Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
*/
enabled: boolean;
/**
* The maximum unit amount the customer can specify for this item.
*/
maximum?: number;
/**
* The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
*/
minimum?: number;
/**
* The starting unit amount which can be updated by the customer.
*/
preset?: number;
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
interface Tier {
/**
* The flat billing amount for an entire tier, regardless of the number of units in the tier.
*/
flat_amount?: number;
/**
* Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
*/
flat_amount_decimal?: string;
/**
* The per unit billing amount for each individual unit for which this tier applies.
*/
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;
/**
* Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
*/
up_to: 'inf' | number;
}
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
interface PriceListParams extends PaginationParams {
/**
* Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
*/
active?: boolean;
/**
* A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
*/
created?: Stripe.RangeQueryParam | number;
/**
* Only return prices for the given currency.
*/
currency?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
*/
lookup_keys?: Array<string>;
/**
* Only return prices for the given product.
*/
product?: string;
/**
* Only return prices with these recurring fields.
*/
recurring?: PriceListParams.Recurring;
/**
* Only return prices of type `recurring` or `one_time`.
*/
type?: PriceListParams.Type;
}
namespace PriceListParams {
interface Recurring {
/**
* Filter by billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval?: Recurring.Interval;
/**
* Filter by the price's meter.
*/
meter?: string;
/**
* Filter by the usage type for this price. Can be either `metered` or `licensed`.
*/
usage_type?: Recurring.UsageType;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
type UsageType = 'licensed' | 'metered';
}
type Type = 'one_time' | 'recurring';
}
interface PriceSearchParams {
/**
* The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).
*/
query: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
*/
limit?: number;
/**
* A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
*/
page?: string;
}
class PricesResource {
/**
* Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
*/
create(
params: PriceCreateParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Price>>;
/**
* Retrieves the price with the given ID.
*/
retrieve(
id: string,
params?: PriceRetrieveParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Price>>;
retrieve(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Price>>;
/**
* Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
*/
update(
id: string,
params?: PriceUpdateParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Price>>;
/**
* Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
*/
list(
params?: PriceListParams,
options?: RequestOptions
): ApiListPromise<Stripe.Price>;
list(options?: RequestOptions): ApiListPromise<Stripe.Price>;
/**
* Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
* Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
* conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
* to an hour behind during outages. Search functionality is not available to merchants in India.
*/
search(
params: PriceSearchParams,
options?: RequestOptions
): ApiSearchResultPromise<Stripe.Price>;
}
}
}