Expand description
This crate provides Rust bindings to the Stripe HTTP API, specifically
for requests mentioned in the Products
section of the Stripe API docs
Modules§
Structs§
- Coupon
- A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices,. checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.
- Coupon
Applies To - Coupon
Currency Option - Coupon
Id - Currency
Option - Custom
Unit Amount - Deleted
Coupon - Deleted
Discount - Deleted
Product - Deleted
Product Feature - Deleted
Product Feature Builder - Discount
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
- Discount
Id - Line
Items Discount Amount - Line
Items TaxAmount - Package
Dimensions - Price
- Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
- PriceId
- Price
Tier - Product
- 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 to configure pricing in Payment Links, Checkout, and Subscriptions.
- Product
Feature - A product_feature represents an attachment between a feature and a product. When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.
- Product
Feature Id - Product
Id - Product
Marketing Feature - Promotion
Code - A Promotion Code represents a customer-redeemable code for a coupon. It can be used to. create multiple codes for a single coupon.
- Promotion
Code Currency Option - Promotion
Code Id - Promotion
Codes Resource Restrictions - Recurring
- Shipping
Rate - Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.
- Shipping
Rate Id - TaxCode
- Tax codes classify goods and services for tax purposes.
- TaxCode
Id - TaxRate
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- TaxRate
Flat Amount - The amount of the tax rate when the
rate_type`` is
flat_amount. Tax rates with
rate_typecan vary based on the transaction, resulting in this field being
null`. This field exposes the amount and currency of the flat tax rate. - TaxRate
Id - Transform
Quantity
Enums§
- Coupon
Duration - Currency
Option TaxBehavior - Only required if a default tax behavior 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
, orunspecified
. Once specified as eitherinclusive
orexclusive
, it cannot be changed. - Line
Items TaxAmount Taxability Reason - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- Price
Billing Scheme - Price
TaxBehavior - Price
Tiers Mode - Price
Type - Product
Type - Recurring
Interval - The frequency at which a subscription is billed. One of
day
,week
,month
oryear
. - Recurring
Usage Type - Configures how the quantity per period should be determined.
Can be either
metered
orlicensed
.licensed
automatically bills thequantity
set when adding it to a subscription.metered
aggregates the total usage based on usage records. Defaults tolicensed
. - Shipping
Rate TaxBehavior - Shipping
Rate Type - TaxRate
Jurisdiction Level - The level of the jurisdiction that imposes this tax rate.
Will be
null
for manually defined tax rates. - TaxRate
Rate Type - Indicates the type of tax rate applied to the taxable amount.
This value can be
null
when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - TaxRate
TaxType - Transform
Quantity Round - After division, either round the result
up
ordown
.