Expand description
This crate provides Rust bindings to the Stripe HTTP API, specifically
for requests mentioned in the Tax, Identity, Reporting, Sigma, Financial Connections
and Webhooks sections of the Stripe API docs
Modules§
- apple_
pay_ domain - climate_
order - climate_
product - climate_
supplier - entitlements_
active_ entitlement - entitlements_
feature - ephemeral_
key - exchange_
rate - financial_
connections_ account - financial_
connections_ session - financial_
connections_ transaction - forwarding_
request - identity_
verification_ report - identity_
verification_ session - reporting_
report_ run - reporting_
report_ type - scheduled_
query_ run - tax_
calculation - tax_
registration - tax_
settings - tax_
transaction - webhook_
endpoint
Structs§
- Apple
PayDomain - Apple
PayDomain Id - Bank
Connections Resource Accountholder - Bank
Connections Resource Accountholder Builder - Bank
Connections Resource Balance - Bank
Connections Resource Balance ApiResource Cash Balance - Bank
Connections Resource Balance ApiResource Cash Balance Builder - Bank
Connections Resource Balance ApiResource Credit Balance - Bank
Connections Resource Balance ApiResource Credit Balance Builder - Bank
Connections Resource Balance Builder - Bank
Connections Resource Balance Refresh - Bank
Connections Resource Balance Refresh Builder - Bank
Connections Resource Link Account Session Filters - Bank
Connections Resource Link Account Session Filters Builder - Bank
Connections Resource Ownership Refresh - Bank
Connections Resource Ownership Refresh Builder - Bank
Connections Resource Transaction Refresh - Bank
Connections Resource Transaction Refresh Builder - Bank
Connections Resource Transaction Refresh Id - Bank
Connections Resource Transaction Resource Status Transitions - Bank
Connections Resource Transaction Resource Status Transitions Builder - Climate
Order - Orders represent your intent to purchase a particular Climate product. When you create an order, the. payment is deducted from your merchant balance.
- Climate
Order Id - Climate
Product - A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.
- Climate
Product Id - Climate
Removals Beneficiary - Climate
Removals Beneficiary Builder - Climate
Removals Location - Climate
Removals Location Builder - Climate
Removals Order Deliveries - The delivery of a specified quantity of carbon for an order.
- Climate
Removals Order Deliveries Builder - Climate
Removals Products Price - Climate
Removals Products Price Builder - Climate
Supplier - A supplier of carbon removal.
- Climate
Supplier Id - Deleted
Apple PayDomain - Deleted
Apple PayDomain Builder - Deleted
Webhook Endpoint - Deleted
Webhook Endpoint Builder - Entitlements
Active Entitlement - An active entitlement describes access to a feature for a customer.
- Entitlements
Active Entitlement Id - Entitlements
Active Entitlement Summary - A summary of a customer’s active entitlements.
- Entitlements
Active Entitlement Summary Builder - Entitlements
Feature - A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
- Entitlements
Feature Id - Ephemeral
Key - Ephemeral
KeyId - Exchange
Rate ExchangeRateobjects allow you to determine the rates that Stripe is currently using to convert from one currency to another. Since this number is variable throughout the day, there are various reasons why you might want to know the current rate (for example, to dynamically price an item for a user with a default payment in a foreign currency).- Exchange
Rate Id - Financial
Connections Account - A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
- Financial
Connections Account Id - Financial
Connections Account Owner - Describes an owner of an account.
- Financial
Connections Account Owner Builder - Financial
Connections Account Owner Id - Financial
Connections Account Ownership - Describes a snapshot of the owners of an account at a particular point in time.
- Financial
Connections Account Ownership Builder - Financial
Connections Account Ownership Id - Financial
Connections Session - A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
- Financial
Connections Session Id - Financial
Connections Transaction - A Transaction represents a real transaction that affects a Financial Connections Account balance.
- Financial
Connections Transaction Id - Financial
Reporting Finance Report RunRun Parameters - Financial
Reporting Finance Report RunRun Parameters Builder - Forwarded
Request Context - Metadata about the forwarded request.
- Forwarded
Request Context Builder - Forwarded
Request Details - Details about the request forwarded to the destination endpoint.
- Forwarded
Request Details Builder - Forwarded
Request Header - Header data.
- Forwarded
Request Header Builder - Forwarded
Response Details - Details about the response from the destination endpoint.
- Forwarded
Response Details Builder - Forwarding
Request - Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request.
- Forwarding
Request Id - Gelato
Data Document Report Date OfBirth - Point in Time
- Gelato
Data Document Report Date OfBirth Builder - Gelato
Data Document Report Expiration Date - Point in Time
- Gelato
Data Document Report Expiration Date Builder - Gelato
Data Document Report Issued Date - Point in Time
- Gelato
Data Document Report Issued Date Builder - Gelato
Data IdNumber Report Date - Point in Time
- Gelato
Data IdNumber Report Date Builder - Gelato
Data Verified Outputs Date - Point in Time
- Gelato
Data Verified Outputs Date Builder - Gelato
Document Report - Result from a document check
- Gelato
Document Report Builder - Gelato
Document Report Error - Gelato
Document Report Error Builder - Gelato
Email Report - Result from a email check
- Gelato
Email Report Builder - Gelato
Email Report Error - Gelato
Email Report Error Builder - Gelato
IdNumber Report - Result from an id_number check
- Gelato
IdNumber Report Builder - Gelato
IdNumber Report Error - Gelato
IdNumber Report Error Builder - Gelato
Phone Report - Result from a phone check
- Gelato
Phone Report Builder - Gelato
Phone Report Error - Gelato
Phone Report Error Builder - Gelato
Provided Details - Gelato
Provided Details Builder - Gelato
Report Document Options - Gelato
Report Document Options Builder - Gelato
Report IdNumber Options - Gelato
Report IdNumber Options Builder - Gelato
Selfie Report - Result from a selfie check
- Gelato
Selfie Report Builder - Gelato
Selfie Report Error - Gelato
Selfie Report Error Builder - Gelato
Session Document Options - Gelato
Session Document Options Builder - Gelato
Session Email Options - Gelato
Session Email Options Builder - Gelato
Session IdNumber Options - Gelato
Session IdNumber Options Builder - Gelato
Session Last Error - Shows last VerificationSession error
- Gelato
Session Last Error Builder - Gelato
Session Phone Options - Gelato
Session Phone Options Builder - Gelato
Verification Report Options - Gelato
Verification Report Options Builder - Gelato
Verification Session Options - Gelato
Verification Session Options Builder - Gelato
Verified Outputs - Gelato
Verified Outputs Builder - Identity
Verification Report - A VerificationReport is the result of an attempt to collect and verify data from a user.
The collection of verification checks performed is determined from the
typeandoptionsparameters used. You can find the result of each verification check performed in the appropriate sub-resource:document,id_number,selfie. - Identity
Verification Report Id - Identity
Verification Session - A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.
- Identity
Verification Session Id - Reporting
Report Run - The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.
- Reporting
Report RunId - Reporting
Report Type - The Report Type resource corresponds to a particular type of report, such as the “Activity summary” or “Itemized payouts” reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.
- Reporting
Report Type Id - Scheduled
Query Run - If you have scheduled a Sigma query, you’ll
receive a
sigma.scheduled_query_run.createdwebhook each time the query runs. The webhook contains aScheduledQueryRunobject, which you can use to retrieve the query results. - Scheduled
Query RunId - Sigma
Scheduled Query RunError - Sigma
Scheduled Query RunError Builder - TaxCalculation
- A Tax Calculation allows you to calculate the tax to collect from your customer.
- TaxCalculation
Id - TaxCalculation
Line Item - TaxCalculation
Line Item Builder - TaxCalculation
Line Item Id - TaxProduct
Registrations Resource Country Options - TaxProduct
Registrations Resource Country Options Builder - TaxProduct
Registrations Resource Country Options CaProvince Standard - TaxProduct
Registrations Resource Country Options CaProvince Standard Builder - TaxProduct
Registrations Resource Country Options Canada - TaxProduct
Registrations Resource Country Options Canada Builder - TaxProduct
Registrations Resource Country Options Default - TaxProduct
Registrations Resource Country Options Default Builder - TaxProduct
Registrations Resource Country Options Default Inbound Goods - TaxProduct
Registrations Resource Country Options Default Inbound Goods Builder - TaxProduct
Registrations Resource Country Options EuStandard - TaxProduct
Registrations Resource Country Options EuStandard Builder - TaxProduct
Registrations Resource Country Options Europe - TaxProduct
Registrations Resource Country Options Europe Builder - TaxProduct
Registrations Resource Country Options Simplified - TaxProduct
Registrations Resource Country Options Simplified Builder - TaxProduct
Registrations Resource Country Options United States - TaxProduct
Registrations Resource Country Options United States Builder - TaxProduct
Registrations Resource Country Options UsLocal Amusement Tax - TaxProduct
Registrations Resource Country Options UsLocal Amusement TaxBuilder - TaxProduct
Registrations Resource Country Options UsLocal Lease Tax - TaxProduct
Registrations Resource Country Options UsLocal Lease TaxBuilder - TaxProduct
Registrations Resource Country Options UsState Sales Tax - TaxProduct
Registrations Resource Country Options UsState Sales TaxBuilder - TaxProduct
Registrations Resource Country Options UsState Sales TaxElection - TaxProduct
Registrations Resource Country Options UsState Sales TaxElection Builder - TaxProduct
Resource Customer Details - TaxProduct
Resource Customer Details Builder - TaxProduct
Resource Customer Details Resource TaxId - TaxProduct
Resource Customer Details Resource TaxId Builder - TaxProduct
Resource Jurisdiction - TaxProduct
Resource Jurisdiction Builder - TaxProduct
Resource Line Item TaxBreakdown - TaxProduct
Resource Line Item TaxBreakdown Builder - TaxProduct
Resource Line Item TaxRate Details - TaxProduct
Resource Line Item TaxRate Details Builder - TaxProduct
Resource Postal Address - TaxProduct
Resource Postal Address Builder - TaxProduct
Resource Ship From Details - TaxProduct
Resource Ship From Details Builder - TaxProduct
Resource TaxBreakdown - TaxProduct
Resource TaxBreakdown Builder - TaxProduct
Resource TaxCalculation Shipping Cost - TaxProduct
Resource TaxCalculation Shipping Cost Builder - TaxProduct
Resource TaxRate Details - TaxProduct
Resource TaxRate Details Builder - TaxProduct
Resource TaxSettings Defaults - TaxProduct
Resource TaxSettings Defaults Builder - TaxProduct
Resource TaxSettings Head Office - TaxProduct
Resource TaxSettings Head Office Builder - TaxProduct
Resource TaxSettings Status Details - TaxProduct
Resource TaxSettings Status Details Builder - TaxProduct
Resource TaxSettings Status Details Resource Active - TaxProduct
Resource TaxSettings Status Details Resource Active Builder - TaxProduct
Resource TaxSettings Status Details Resource Pending - TaxProduct
Resource TaxSettings Status Details Resource Pending Builder - TaxProduct
Resource TaxTransaction Line Item Resource Reversal - TaxProduct
Resource TaxTransaction Line Item Resource Reversal Builder - TaxProduct
Resource TaxTransaction Resource Reversal - TaxProduct
Resource TaxTransaction Resource Reversal Builder - TaxProduct
Resource TaxTransaction Shipping Cost - TaxProduct
Resource TaxTransaction Shipping Cost Builder - TaxRegistration
- A Tax
Registrationlets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax. - TaxRegistration
Id - TaxSettings
- You can use Tax
Settingsto manage configurations used by Stripe Tax calculations. - TaxTransaction
- A Tax Transaction records the tax collected from or refunded to your customer.
- TaxTransaction
Id - TaxTransaction
Line Item - TaxTransaction
Line Item Builder - TaxTransaction
Line Item Id - Verification
Session Redaction - Verification
Session Redaction Builder - Webhook
Endpoint - You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.
- Webhook
Endpoint Id
Enums§
- Bank
Connections Resource Accountholder Type - Type of account holder that this account belongs to.
- Bank
Connections Resource Balance Refresh Status - The status of the last refresh attempt.
- Bank
Connections Resource Balance Type - The
typeof the balance. An additional hash is included on the balance with a name matching this value. - Bank
Connections Resource Link Account Session Filters Account Subcategories - Restricts the Session to subcategories of accounts that can be linked.
Valid subcategories are:
checking,savings,mortgage,line_of_credit,credit_card. - Bank
Connections Resource Ownership Refresh Status - The status of the last refresh attempt.
- Bank
Connections Resource Transaction Refresh Status - The status of the last refresh attempt.
- Climate
Order Cancellation Reason - Reason for the cancellation of this order.
- Climate
Order Status - The current status of this order.
- Climate
Supplier Removal Pathway - The scientific pathway used for carbon removal.
- Financial
Connections Account Category - The type of the account. Account category is further divided in
subcategory. - Financial
Connections Account Permissions - The list of permissions granted by this account.
- Financial
Connections Account Status - The status of the link to the account.
- Financial
Connections Account Subcategory - If
categoryiscash, one of: - Financial
Connections Account Subscriptions - The list of data refresh subscriptions requested on this account.
- Financial
Connections Account Supported Payment Method Types - The PaymentMethod type(s) that can be created from this account.
- Financial
Connections Session Permissions - Financial
Connections Session Prefetch - Financial
Connections Transaction Status - The status of the transaction.
- Forwarded
Request Details Http Method - The HTTP method used to call the destination endpoint.
- Forwarding
Request Replacements - Gelato
Document Report Error Code - A short machine-readable string giving the reason for the verification failure.
- Gelato
Document Report Status - Status of this
documentcheck. - Gelato
Document Report Type - Type of the document.
- Gelato
Email Report Error Code - A short machine-readable string giving the reason for the verification failure.
- Gelato
Email Report Status - Status of this
emailcheck. - Gelato
IdNumber Report Error Code - A short machine-readable string giving the reason for the verification failure.
- Gelato
IdNumber Report IdNumber Type - Type of ID number.
- Gelato
IdNumber Report Status - Status of this
id_numbercheck. - Gelato
Phone Report Error Code - A short machine-readable string giving the reason for the verification failure.
- Gelato
Phone Report Status - Status of this
phonecheck. - Gelato
Report Document Options Allowed Types - Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
- Gelato
Selfie Report Error Code - A short machine-readable string giving the reason for the verification failure.
- Gelato
Selfie Report Status - Status of this
selfiecheck. - Gelato
Session Document Options Allowed Types - Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
- Gelato
Session Last Error Code - A short machine-readable string giving the reason for the verification or user-session failure.
- Gelato
Verified Outputs IdNumber Type - The user’s verified id number type.
- Identity
Verification Report Type - Type of report.
- Identity
Verification Session Status - Identity
Verification Session Type - The type of verification check to be performed.
- TaxCalculation
Line Item TaxBehavior - Specifies whether the
amountincludes taxes. Iftax_behavior=inclusive, then the amount includes taxes. - TaxProduct
Registrations Resource Country Options Canada Type - Type of registration in Canada.
- TaxProduct
Registrations Resource Country Options Default Inbound Goods Type - Type of registration in
country. - TaxProduct
Registrations Resource Country Options Default Type - Type of registration in
country. - TaxProduct
Registrations Resource Country Options EuStandard Place OfSupply Scheme - Place of supply scheme used in an EU standard registration.
- TaxProduct
Registrations Resource Country Options Europe Type - Type of registration in an EU country.
- TaxProduct
Registrations Resource Country Options Simplified Type - Type of registration in
country. - TaxProduct
Registrations Resource Country Options United States Type - Type of registration in the US.
- TaxProduct
Registrations Resource Country Options UsState Sales TaxElection Type - The type of the election for the state sales tax registration.
- TaxProduct
Resource Customer Details Address Source - The type of customer address provided.
- TaxProduct
Resource Customer Details Resource TaxId Type - The type of the tax ID, one of
ad_nrt,ar_cuit,eu_vat,bo_tin,br_cnpj,br_cpf,cn_tin,co_nit,cr_tin,do_rcn,ec_ruc,eu_oss_vat,hr_oib,pe_ruc,ro_tin,rs_pib,sv_nit,uy_ruc,ve_rif,vn_tin,gb_vat,nz_gst,au_abn,au_arn,in_gst,no_vat,no_voec,za_vat,ch_vat,mx_rfc,sg_uen,ru_inn,ru_kpp,ca_bn,hk_br,es_cif,tw_vat,th_vat,jp_cn,jp_rn,jp_trn,li_uid,li_vat,my_itn,us_ein,kr_brn,ca_qst,ca_gst_hst,ca_pst_bc,ca_pst_mb,ca_pst_sk,my_sst,sg_gst,ae_trn,cl_tin,sa_vat,id_npwp,my_frp,il_vat,ge_vat,ua_vat,is_vat,bg_uic,hu_tin,si_tin,ke_pin,tr_tin,eg_tin,ph_tin,al_tin,bh_vat,kz_bin,ng_tin,om_vat,de_stn,ch_uid,tz_vat,uz_vat,uz_tin,md_vat,ma_vat,by_tin,ao_tin,bs_tin,bb_tin,cd_nif,mr_nif,me_pib,zw_tin,ba_tin,gn_nif,mk_vat,sr_fin,sn_ninea,am_tin,np_pan,tj_tin,ug_tin,zm_tin,kh_tin,aw_tin,az_tin,bd_bin,bj_ifu,et_tin,kg_tin,la_tin,cm_niu,cv_nif,bf_ifu, orunknown. - TaxProduct
Resource Customer Details Taxability Override - The taxability override used for taxation.
- TaxProduct
Resource Jurisdiction Level - Indicates the level of the jurisdiction imposing the tax.
- TaxProduct
Resource Line Item TaxBreakdown Sourcing - Indicates whether the jurisdiction was determined by the origin (merchant’s address) or destination (customer’s address).
- TaxProduct
Resource Line Item TaxBreakdown 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.
- TaxProduct
Resource Line Item TaxRate Details TaxType - The tax type, such as
vatorsales_tax. - TaxProduct
Resource TaxBreakdown Taxability Reason - The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.
- TaxProduct
Resource TaxCalculation Shipping Cost TaxBehavior - Specifies whether the
amountincludes taxes. Iftax_behavior=inclusive, then the amount includes taxes. - TaxProduct
Resource TaxRate Details Rate Type - Indicates the type of tax rate applied to the taxable amount.
This value can be
nullwhen no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - TaxProduct
Resource TaxRate Details TaxType - The tax type, such as
vatorsales_tax. - TaxProduct
Resource TaxSettings Defaults TaxBehavior - Default tax behavior used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item’s price has a tax behavior set, it will take precedence over the default tax behavior.
- TaxProduct
Resource TaxTransaction Shipping Cost TaxBehavior - Specifies whether the
amountincludes taxes. Iftax_behavior=inclusive, then the amount includes taxes. - TaxRegistration
Status - The status of the registration.
This field is present for convenience and can be deduced from
active_fromandexpires_at. - TaxSettings
Status - The status of the Tax
Settings. - TaxTransaction
Line Item TaxBehavior - Specifies whether the
amountincludes taxes. Iftax_behavior=inclusive, then the amount includes taxes. - TaxTransaction
Line Item Type - If
reversal, this line item reverses an earlier transaction. - TaxTransaction
Type - If
reversal, this transaction reverses an earlier transaction. - Verification
Session Redaction Status - Indicates whether this object and its related objects have been redacted or not.