import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * With this resource, you can create a shipping rate - [Stripe API shipping rate documentation](https://stripe.com/docs/api/shipping_rates). * * Shipping rates let you display various shipping options—like standard, express, and overnight—with more accurate delivery estimates. * Charge your customer for shipping using different Stripe products, some of which require coding. * * > Removal of the shipping rate isn't supported through the Stripe SDK. The best practice, which this provider follows, * is to archive the shipping rate by marking it as inactive on destroy, which indicates that the shipping rate is no longer * available. * * ## Example Usage * * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as stripe from "pulumi-stripe"; * * // shipping rate with delivery estimate * const shippingRate = new stripe.ShippingRate("shippingRate", { * deliveryEstimates: [{ * maximum: { * unit: "day", * value: 4, * }, * minimum: { * unit: "hour", * value: 24, * }, * }], * displayName: "shipping rate", * fixedAmount: { * amount: 1000, * currency: "aud", * }, * }); * // shipping rate with currency options * // !!! Currency options have to be sorted alphabetically * // !!! by the currency field * const shipping = new stripe.ShippingRate("shipping", { * displayName: "shipping rate", * fixedAmount: { * amount: 1000, * currency: "aud", * currencyOptions: [ * { * amount: 350, * currency: "eur", * }, * { * amount: 500, * currency: "usd", * }, * ], * }, * }); * ``` * */ export declare class ShippingRate extends pulumi.CustomResource { /** * Get an existing ShippingRate resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ShippingRateState, opts?: pulumi.CustomResourceOptions): ShippingRate; /** * Returns true if the given object is an instance of ShippingRate. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is ShippingRate; /** * Bool. Whether the shipping rate is active (can't be used when creating). Defaults to `true`. */ readonly active: pulumi.Output; /** * List(Resource). The estimated range for how long shipping will take, * meant to be displayable to the customer. This will appear on CheckoutSessions. * For details please see Delivery Estimate. */ readonly deliveryEstimates: pulumi.Output; /** * String. The name of the shipping rate, meant to be displayable to the customer. * This will appear on CheckoutSessions. */ readonly displayName: pulumi.Output; /** * List(Resource). Describes a fixed amount to charge for shipping. * Must be present if type is `fixedAmount`. For details of individual arguments see Fixed Amount. */ readonly fixedAmount: pulumi.Output; /** * Bool. Has the value true if the object exists in live mode or the value false if the object exists in test mode. */ readonly livemode: pulumi.Output; /** * Map(String). 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. */ readonly metadata: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or * unspecified. */ readonly taxBehavior: pulumi.Output; /** * String. A tax code ID. The Shipping tax code is `txcd92010001`. */ readonly taxCode: pulumi.Output; /** * String. The type of calculation to use on the shipping rate. Can only be `fixedAmount` for now. */ readonly type: pulumi.Output; /** * Create a ShippingRate resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ShippingRateArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ShippingRate resources. */ export interface ShippingRateState { /** * Bool. Whether the shipping rate is active (can't be used when creating). Defaults to `true`. */ active?: pulumi.Input; /** * List(Resource). The estimated range for how long shipping will take, * meant to be displayable to the customer. This will appear on CheckoutSessions. * For details please see Delivery Estimate. */ deliveryEstimates?: pulumi.Input[]>; /** * String. The name of the shipping rate, meant to be displayable to the customer. * This will appear on CheckoutSessions. */ displayName?: pulumi.Input; /** * List(Resource). Describes a fixed amount to charge for shipping. * Must be present if type is `fixedAmount`. For details of individual arguments see Fixed Amount. */ fixedAmount?: pulumi.Input; /** * Bool. Has the value true if the object exists in live mode or the value false if the object exists in test mode. */ livemode?: pulumi.Input; /** * Map(String). 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. */ metadata?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or * unspecified. */ taxBehavior?: pulumi.Input; /** * String. A tax code ID. The Shipping tax code is `txcd92010001`. */ taxCode?: pulumi.Input; /** * String. The type of calculation to use on the shipping rate. Can only be `fixedAmount` for now. */ type?: pulumi.Input; } /** * The set of arguments for constructing a ShippingRate resource. */ export interface ShippingRateArgs { /** * Bool. Whether the shipping rate is active (can't be used when creating). Defaults to `true`. */ active?: pulumi.Input; /** * List(Resource). The estimated range for how long shipping will take, * meant to be displayable to the customer. This will appear on CheckoutSessions. * For details please see Delivery Estimate. */ deliveryEstimates?: pulumi.Input[]>; /** * String. The name of the shipping rate, meant to be displayable to the customer. * This will appear on CheckoutSessions. */ displayName: pulumi.Input; /** * List(Resource). Describes a fixed amount to charge for shipping. * Must be present if type is `fixedAmount`. For details of individual arguments see Fixed Amount. */ fixedAmount: pulumi.Input; /** * Map(String). 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. */ metadata?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or * unspecified. */ taxBehavior?: pulumi.Input; /** * String. A tax code ID. The Shipping tax code is `txcd92010001`. */ taxCode?: pulumi.Input; /** * String. The type of calculation to use on the shipping rate. Can only be `fixedAmount` for now. */ type?: pulumi.Input; }