Struct StripeClient

pub struct StripeClient {
    pub client: Client,
    /* private fields */
}

Fields

client: Client

Implementations

impl StripeClient

pub fn from_env() -> Self

impl StripeClient

pub fn new(url: &str, authentication: StripeAuthentication) -> Self

pub fn with_authentication(self, authentication: StripeAuthentication) -> Self

pub fn with_middleware<M: Middleware + 'static>(self, middleware: M) -> Self

pub fn get_account(&self) -> FluentRequest<'_, GetAccountRequest>

Retrieves the details of an account.

pub fn post_account_links(&self) -> FluentRequest<'_, PostAccountLinksRequest>

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

pub fn post_account_sessions( &self, ) -> FluentRequest<'_, PostAccountSessionsRequest>

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

pub fn get_accounts(&self) -> FluentRequest<'_, GetAccountsRequest>

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

pub fn post_accounts(&self) -> FluentRequest<'_, PostAccountsRequest>

With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.

If you’ve already collected information for your connected accounts, you can prefill that information when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.

pub fn get_accounts_account( &self, account: &str, ) -> FluentRequest<'_, GetAccountsAccountRequest>

Retrieves the details of an account.

pub fn post_accounts_account( &self, account: &str, ) -> FluentRequest<'_, PostAccountsAccountRequest>

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express below.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

pub fn delete_accounts_account( &self, account: &str, ) -> FluentRequest<'_, DeleteAccountsAccountRequest>

With Connect, you can delete accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

pub fn post_accounts_account_bank_accounts( &self, account: &str, ) -> FluentRequest<'_, PostAccountsAccountBankAccountsRequest>

Create an external account for a given account.

pub fn get_accounts_account_bank_accounts_id( &self, account: &str, id: &str, ) -> FluentRequest<'_, GetAccountsAccountBankAccountsIdRequest>

Retrieve a specified external account for a given account.

pub fn post_accounts_account_bank_accounts_id( &self, account: &str, id: &str, ) -> FluentRequest<'_, PostAccountsAccountBankAccountsIdRequest>

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

pub fn delete_accounts_account_bank_accounts_id( &self, account: &str, id: &str, ) -> FluentRequest<'_, DeleteAccountsAccountBankAccountsIdRequest>

Delete a specified external account for a given account.

pub fn get_accounts_account_capabilities( &self, account: &str, ) -> FluentRequest<'_, GetAccountsAccountCapabilitiesRequest>

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

pub fn get_accounts_account_capabilities_capability( &self, account: &str, capability: &str, ) -> FluentRequest<'_, GetAccountsAccountCapabilitiesCapabilityRequest>

Retrieves information about the specified Account Capability.

pub fn post_accounts_account_capabilities_capability( &self, account: &str, capability: &str, ) -> FluentRequest<'_, PostAccountsAccountCapabilitiesCapabilityRequest>

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

pub fn get_accounts_account_external_accounts( &self, account: &str, ) -> FluentRequest<'_, GetAccountsAccountExternalAccountsRequest>

List external accounts for an account.

pub fn post_accounts_account_external_accounts( &self, account: &str, ) -> FluentRequest<'_, PostAccountsAccountExternalAccountsRequest>

Create an external account for a given account.

pub fn get_accounts_account_external_accounts_id( &self, account: &str, id: &str, ) -> FluentRequest<'_, GetAccountsAccountExternalAccountsIdRequest>

Retrieve a specified external account for a given account.

pub fn post_accounts_account_external_accounts_id( &self, account: &str, id: &str, ) -> FluentRequest<'_, PostAccountsAccountExternalAccountsIdRequest>

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

pub fn delete_accounts_account_external_accounts_id( &self, account: &str, id: &str, ) -> FluentRequest<'_, DeleteAccountsAccountExternalAccountsIdRequest>

Delete a specified external account for a given account.

pub fn post_accounts_account_login_links( &self, account: &str, ) -> FluentRequest<'_, PostAccountsAccountLoginLinksRequest>

Creates a single-use login link for an Express account to access their Stripe dashboard.

You may only create login links for Express accounts connected to your platform.

pub fn get_accounts_account_people( &self, account: &str, ) -> FluentRequest<'_, GetAccountsAccountPeopleRequest>

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

pub fn post_accounts_account_people( &self, account: &str, ) -> FluentRequest<'_, PostAccountsAccountPeopleRequest>

Creates a new person.

pub fn get_accounts_account_people_person( &self, account: &str, person: &str, ) -> FluentRequest<'_, GetAccountsAccountPeoplePersonRequest>

Retrieves an existing person.

pub fn post_accounts_account_people_person( &self, account: &str, person: &str, ) -> FluentRequest<'_, PostAccountsAccountPeoplePersonRequest>

Updates an existing person.

pub fn delete_accounts_account_people_person( &self, account: &str, person: &str, ) -> FluentRequest<'_, DeleteAccountsAccountPeoplePersonRequest>

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

pub fn get_accounts_account_persons( &self, account: &str, ) -> FluentRequest<'_, GetAccountsAccountPersonsRequest>

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

pub fn post_accounts_account_persons( &self, account: &str, ) -> FluentRequest<'_, PostAccountsAccountPersonsRequest>

Creates a new person.

pub fn get_accounts_account_persons_person( &self, account: &str, person: &str, ) -> FluentRequest<'_, GetAccountsAccountPersonsPersonRequest>

Retrieves an existing person.

pub fn post_accounts_account_persons_person( &self, account: &str, person: &str, ) -> FluentRequest<'_, PostAccountsAccountPersonsPersonRequest>

Updates an existing person.

pub fn delete_accounts_account_persons_person( &self, account: &str, person: &str, ) -> FluentRequest<'_, DeleteAccountsAccountPersonsPersonRequest>

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

pub fn post_accounts_account_reject( &self, account: &str, ) -> FluentRequest<'_, PostAccountsAccountRejectRequest>

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

pub fn get_apple_pay_domains( &self, ) -> FluentRequest<'_, GetApplePayDomainsRequest>

List apple pay domains.

pub fn post_apple_pay_domains( &self, ) -> FluentRequest<'_, PostApplePayDomainsRequest>

Create an apple pay domain.

pub fn get_apple_pay_domains_domain( &self, domain: &str, ) -> FluentRequest<'_, GetApplePayDomainsDomainRequest>

Retrieve an apple pay domain.

pub fn delete_apple_pay_domains_domain( &self, domain: &str, ) -> FluentRequest<'_, DeleteApplePayDomainsDomainRequest>

Delete an apple pay domain.

pub fn get_application_fees( &self, ) -> FluentRequest<'_, GetApplicationFeesRequest>

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

pub fn get_application_fees_fee_refunds_id( &self, fee: &str, id: &str, ) -> FluentRequest<'_, GetApplicationFeesFeeRefundsIdRequest>

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

pub fn post_application_fees_fee_refunds_id( &self, fee: &str, id: &str, ) -> FluentRequest<'_, PostApplicationFeesFeeRefundsIdRequest>

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata as an argument.

pub fn get_application_fees_id( &self, id: &str, ) -> FluentRequest<'_, GetApplicationFeesIdRequest>

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

pub fn post_application_fees_id_refund( &self, id: &str, ) -> FluentRequest<'_, PostApplicationFeesIdRefundRequest>

pub fn get_application_fees_id_refunds( &self, id: &str, ) -> FluentRequest<'_, GetApplicationFeesIdRefundsRequest>

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

pub fn post_application_fees_id_refunds( &self, id: &str, ) -> FluentRequest<'_, PostApplicationFeesIdRefundsRequest>

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

pub fn get_apps_secrets( &self, scope: ScopeParam, ) -> FluentRequest<'_, GetAppsSecretsRequest>

List all secrets stored on the given scope.

pub fn post_apps_secrets(&self) -> FluentRequest<'_, PostAppsSecretsRequest>

Create or replace a secret in the secret store.

pub fn post_apps_secrets_delete( &self, ) -> FluentRequest<'_, PostAppsSecretsDeleteRequest>

Deletes a secret from the secret store by name and scope.

pub fn get_apps_secrets_find( &self, name: &str, scope: ScopeParam, ) -> FluentRequest<'_, GetAppsSecretsFindRequest>

Finds a secret in the secret store by name and scope.

pub fn get_balance(&self) -> FluentRequest<'_, GetBalanceRequest>

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

pub fn get_balance_history(&self) -> FluentRequest<'_, GetBalanceHistoryRequest>

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

pub fn get_balance_history_id( &self, id: &str, ) -> FluentRequest<'_, GetBalanceHistoryIdRequest>

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

pub fn get_balance_transactions( &self, ) -> FluentRequest<'_, GetBalanceTransactionsRequest>

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

pub fn get_balance_transactions_id( &self, id: &str, ) -> FluentRequest<'_, GetBalanceTransactionsIdRequest>

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

pub fn get_billing_portal_configurations( &self, ) -> FluentRequest<'_, GetBillingPortalConfigurationsRequest>

Returns a list of configurations that describe the functionality of the customer portal.

pub fn post_billing_portal_configurations( &self, ) -> FluentRequest<'_, PostBillingPortalConfigurationsRequest>

Creates a configuration that describes the functionality and behavior of a PortalSession

pub fn get_billing_portal_configurations_configuration( &self, configuration: &str, ) -> FluentRequest<'_, GetBillingPortalConfigurationsConfigurationRequest>

Retrieves a configuration that describes the functionality of the customer portal.

pub fn post_billing_portal_configurations_configuration( &self, configuration: &str, ) -> FluentRequest<'_, PostBillingPortalConfigurationsConfigurationRequest>

Updates a configuration that describes the functionality of the customer portal.

pub fn post_billing_portal_sessions( &self, ) -> FluentRequest<'_, PostBillingPortalSessionsRequest>

Creates a session of the customer portal.

pub fn get_charges(&self) -> FluentRequest<'_, GetChargesRequest>

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

pub fn post_charges(&self) -> FluentRequest<'_, PostChargesRequest>

Use the Payment Intents API to initiate a new payment instead of using this method. Confirmation of the PaymentIntent creates the Charge object used to request payment, so this method is limited to legacy integrations.

pub fn get_charges_search( &self, query: &str, ) -> FluentRequest<'_, GetChargesSearchRequest>

Search for charges you’ve previously created using Stripe’s 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.

pub fn get_charges_charge( &self, charge: &str, ) -> FluentRequest<'_, GetChargesChargeRequest>

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

pub fn post_charges_charge( &self, charge: &str, ) -> FluentRequest<'_, PostChargesChargeRequest>

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn post_charges_charge_capture( &self, charge: &str, ) -> FluentRequest<'_, PostChargesChargeCaptureRequest>

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

pub fn get_charges_charge_dispute( &self, charge: &str, ) -> FluentRequest<'_, GetChargesChargeDisputeRequest>

Retrieve a dispute for a specified charge.

pub fn post_charges_charge_dispute( &self, charge: &str, ) -> FluentRequest<'_, PostChargesChargeDisputeRequest>

pub fn post_charges_charge_dispute_close( &self, charge: &str, ) -> FluentRequest<'_, PostChargesChargeDisputeCloseRequest>

pub fn post_charges_charge_refund( &self, charge: &str, ) -> FluentRequest<'_, PostChargesChargeRefundRequest>

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

This action refunds a previously created charge that’s not refunded yet. Funds are refunded to the credit or debit card that’s originally charged.

You can optionally refund only part of a charge. You can repeat this until the entire charge is refunded.

After you entirely refund a charge, you can’t refund it again. This method raises an error when it’s called on an already-refunded charge, or when you attempt to refund more money than is left on a charge.

pub fn get_charges_charge_refunds( &self, charge: &str, ) -> FluentRequest<'_, GetChargesChargeRefundsRequest>

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

pub fn post_charges_charge_refunds( &self, charge: &str, ) -> FluentRequest<'_, PostChargesChargeRefundsRequest>

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

pub fn get_charges_charge_refunds_refund( &self, charge: &str, refund: &str, ) -> FluentRequest<'_, GetChargesChargeRefundsRefundRequest>

Retrieves the details of an existing refund.

pub fn post_charges_charge_refunds_refund( &self, charge: &str, refund: &str, ) -> FluentRequest<'_, PostChargesChargeRefundsRefundRequest>

Update a specified refund.

pub fn get_checkout_sessions( &self, ) -> FluentRequest<'_, GetCheckoutSessionsRequest>

Returns a list of Checkout Sessions.

pub fn post_checkout_sessions( &self, ) -> FluentRequest<'_, PostCheckoutSessionsRequest>

Creates a Session object.

pub fn get_checkout_sessions_session( &self, session: &str, ) -> FluentRequest<'_, GetCheckoutSessionsSessionRequest>

Retrieves a Session object.

pub fn post_checkout_sessions_session_expire( &self, session: &str, ) -> FluentRequest<'_, PostCheckoutSessionsSessionExpireRequest>

A Session can be expired when it is in one of these statuses: open

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

pub fn get_checkout_sessions_session_line_items( &self, session: &str, ) -> FluentRequest<'_, GetCheckoutSessionsSessionLineItemsRequest>

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

pub fn get_climate_orders(&self) -> FluentRequest<'_, GetClimateOrdersRequest>

Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.

pub fn post_climate_orders(&self) -> FluentRequest<'_, PostClimateOrdersRequest>

Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.

pub fn get_climate_orders_order( &self, order: &str, ) -> FluentRequest<'_, GetClimateOrdersOrderRequest>

Retrieves the details of a Climate order object with the given ID.

pub fn post_climate_orders_order( &self, order: &str, ) -> FluentRequest<'_, PostClimateOrdersOrderRequest>

Updates the specified order by setting the values of the parameters passed.

pub fn post_climate_orders_order_cancel( &self, order: &str, ) -> FluentRequest<'_, PostClimateOrdersOrderCancelRequest>

Cancels a Climate order. You can cancel an order within 30 days of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.

pub fn get_climate_products( &self, ) -> FluentRequest<'_, GetClimateProductsRequest>

Lists all available Climate product objects.

pub fn get_climate_products_product( &self, product: &str, ) -> FluentRequest<'_, GetClimateProductsProductRequest>

Retrieves the details of a Climate product with the given ID.

pub fn get_climate_reservations( &self, ) -> FluentRequest<'_, GetClimateReservationsRequest>

Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.

pub fn post_climate_reservations( &self, ) -> FluentRequest<'_, PostClimateReservationsRequest>

Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.

pub fn get_climate_reservations_order( &self, order: &str, ) -> FluentRequest<'_, GetClimateReservationsOrderRequest>

Retrieves the details of a Climate order object with the given ID.

pub fn post_climate_reservations_order( &self, order: &str, ) -> FluentRequest<'_, PostClimateReservationsOrderRequest>

Updates the specified order by setting the values of the parameters passed.

pub fn post_climate_reservations_order_cancel( &self, order: &str, ) -> FluentRequest<'_, PostClimateReservationsOrderCancelRequest>

Cancels a Climate order. You can cancel an order within 30 days of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.

pub fn post_climate_reservations_order_confirm( &self, order: &str, ) -> FluentRequest<'_, PostClimateReservationsOrderConfirmRequest>

Confirms a Climate order. When you confirm your order, we immediately deduct the funds from your Stripe balance.

pub fn get_climate_suppliers( &self, ) -> FluentRequest<'_, GetClimateSuppliersRequest>

Lists all available Climate supplier objects.

pub fn get_climate_suppliers_supplier( &self, supplier: &str, ) -> FluentRequest<'_, GetClimateSuppliersSupplierRequest>

Retrieves a Climate supplier object.

pub fn get_country_specs(&self) -> FluentRequest<'_, GetCountrySpecsRequest>

Lists all Country Spec objects available in the API.

pub fn get_country_specs_country( &self, country: &str, ) -> FluentRequest<'_, GetCountrySpecsCountryRequest>

Returns a Country Spec for a given Country code.

pub fn get_coupons(&self) -> FluentRequest<'_, GetCouponsRequest>

Returns a list of your coupons.

pub fn post_coupons(&self) -> FluentRequest<'_, PostCouponsRequest>

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

pub fn get_coupons_coupon( &self, coupon: &str, ) -> FluentRequest<'_, GetCouponsCouponRequest>

Retrieves the coupon with the given ID.

pub fn post_coupons_coupon( &self, coupon: &str, ) -> FluentRequest<'_, PostCouponsCouponRequest>

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

pub fn delete_coupons_coupon( &self, coupon: &str, ) -> FluentRequest<'_, DeleteCouponsCouponRequest>

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

pub fn get_credit_notes(&self) -> FluentRequest<'_, GetCreditNotesRequest>

Returns a list of credit notes.

pub fn post_credit_notes(&self) -> FluentRequest<'_, PostCreditNotesRequest>

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result in any combination of the following:

• Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
• Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
• Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

pub fn get_credit_notes_preview( &self, invoice: &str, ) -> FluentRequest<'_, GetCreditNotesPreviewRequest>

Get a preview of a credit note without creating it.

pub fn get_credit_notes_preview_lines( &self, invoice: &str, ) -> FluentRequest<'_, GetCreditNotesPreviewLinesRequest>

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

pub fn get_credit_notes_credit_note_lines( &self, credit_note: &str, ) -> FluentRequest<'_, GetCreditNotesCreditNoteLinesRequest>

When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

pub fn get_credit_notes_id( &self, id: &str, ) -> FluentRequest<'_, GetCreditNotesIdRequest>

Retrieves the credit note object with the given identifier.

pub fn post_credit_notes_id( &self, id: &str, ) -> FluentRequest<'_, PostCreditNotesIdRequest>

Updates an existing credit note.

pub fn post_credit_notes_id_void( &self, id: &str, ) -> FluentRequest<'_, PostCreditNotesIdVoidRequest>

Marks a credit note as void. Learn more about voiding credit notes.

pub fn get_customers(&self) -> FluentRequest<'_, GetCustomersRequest>

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

pub fn post_customers(&self) -> FluentRequest<'_, PostCustomersRequest>

Creates a new customer object.

pub fn get_customers_search( &self, query: &str, ) -> FluentRequest<'_, GetCustomersSearchRequest>

Search for customers you’ve previously created using Stripe’s 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.

pub fn get_customers_customer( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerRequest>

Retrieves a Customer object.

pub fn post_customers_customer( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerRequest>

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

This request accepts mostly the same arguments as the customer creation call.

pub fn delete_customers_customer( &self, customer: &str, ) -> FluentRequest<'_, DeleteCustomersCustomerRequest>

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

pub fn get_customers_customer_balance_transactions( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerBalanceTransactionsRequest>

Returns a list of transactions that updated the customer’s balances.

pub fn post_customers_customer_balance_transactions( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerBalanceTransactionsRequest>

Creates an immutable transaction that updates the customer’s credit balance.

pub fn get_customers_customer_balance_transactions_transaction( &self, customer: &str, transaction: &str, ) -> FluentRequest<'_, GetCustomersCustomerBalanceTransactionsTransactionRequest>

Retrieves a specific customer balance transaction that updated the customer’s balances.

pub fn post_customers_customer_balance_transactions_transaction( &self, customer: &str, transaction: &str, ) -> FluentRequest<'_, PostCustomersCustomerBalanceTransactionsTransactionRequest>

Most credit balance transaction fields are immutable, but you may update its description and metadata.

pub fn get_customers_customer_bank_accounts( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerBankAccountsRequest>

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

pub fn post_customers_customer_bank_accounts( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerBankAccountsRequest>

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

pub fn get_customers_customer_bank_accounts_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, GetCustomersCustomerBankAccountsIdRequest>

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

pub fn post_customers_customer_bank_accounts_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, PostCustomersCustomerBankAccountsIdRequest>

Update a specified source for a given customer.

pub fn delete_customers_customer_bank_accounts_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, DeleteCustomersCustomerBankAccountsIdRequest>

Delete a specified source for a given customer.

pub fn post_customers_customer_bank_accounts_id_verify( &self, customer: &str, id: &str, ) -> FluentRequest<'_, PostCustomersCustomerBankAccountsIdVerifyRequest>

Verify a specified bank account for a given customer.

pub fn get_customers_customer_cards( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerCardsRequest>

You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the Customer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

pub fn post_customers_customer_cards( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerCardsRequest>

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

pub fn get_customers_customer_cards_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, GetCustomersCustomerCardsIdRequest>

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

pub fn post_customers_customer_cards_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, PostCustomersCustomerCardsIdRequest>

Update a specified source for a given customer.

pub fn delete_customers_customer_cards_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, DeleteCustomersCustomerCardsIdRequest>

Delete a specified source for a given customer.

pub fn get_customers_customer_cash_balance( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerCashBalanceRequest>

Retrieves a customer’s cash balance.

pub fn post_customers_customer_cash_balance( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerCashBalanceRequest>

Changes the settings on a customer’s cash balance.

pub fn get_customers_customer_cash_balance_transactions( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerCashBalanceTransactionsRequest>

Returns a list of transactions that modified the customer’s cash balance.

pub fn get_customers_customer_cash_balance_transactions_transaction( &self, customer: &str, transaction: &str, ) -> FluentRequest<'_, GetCustomersCustomerCashBalanceTransactionsTransactionRequest>

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

pub fn get_customers_customer_discount( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerDiscountRequest>

pub fn delete_customers_customer_discount( &self, customer: &str, ) -> FluentRequest<'_, DeleteCustomersCustomerDiscountRequest>

Removes the currently applied discount on a customer.

pub fn post_customers_customer_funding_instructions( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerFundingInstructionsRequest>

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be created. If funding instructions have already been created for a given customer, the same funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

pub fn get_customers_customer_payment_methods( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerPaymentMethodsRequest>

Returns a list of PaymentMethods for a given Customer

pub fn get_customers_customer_payment_methods_payment_method( &self, customer: &str, payment_method: &str, ) -> FluentRequest<'_, GetCustomersCustomerPaymentMethodsPaymentMethodRequest>

Retrieves a PaymentMethod object for a given Customer.

pub fn get_customers_customer_sources( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerSourcesRequest>

List sources for a specified customer.

pub fn post_customers_customer_sources( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerSourcesRequest>

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

pub fn get_customers_customer_sources_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, GetCustomersCustomerSourcesIdRequest>

Retrieve a specified source for a given customer.

pub fn post_customers_customer_sources_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, PostCustomersCustomerSourcesIdRequest>

Update a specified source for a given customer.

pub fn delete_customers_customer_sources_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, DeleteCustomersCustomerSourcesIdRequest>

Delete a specified source for a given customer.

pub fn post_customers_customer_sources_id_verify( &self, customer: &str, id: &str, ) -> FluentRequest<'_, PostCustomersCustomerSourcesIdVerifyRequest>

Verify a specified bank account for a given customer.

pub fn get_customers_customer_subscriptions( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerSubscriptionsRequest>

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

pub fn post_customers_customer_subscriptions( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerSubscriptionsRequest>

Creates a new subscription on an existing customer.

pub fn get_customers_customer_subscriptions_subscription_exposed_id( &self, customer: &str, subscription_exposed_id: &str, ) -> FluentRequest<'_, GetCustomersCustomerSubscriptionsSubscriptionExposedIdRequest>

Retrieves the subscription with the given ID.

pub fn post_customers_customer_subscriptions_subscription_exposed_id( &self, customer: &str, subscription_exposed_id: &str, ) -> FluentRequest<'_, PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequest>

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

pub fn delete_customers_customer_subscriptions_subscription_exposed_id( &self, customer: &str, subscription_exposed_id: &str, ) -> FluentRequest<'_, DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequest>

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

pub fn get_customers_customer_subscriptions_subscription_exposed_id_discount( &self, customer: &str, subscription_exposed_id: &str, ) -> FluentRequest<'_, GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest>

pub fn delete_customers_customer_subscriptions_subscription_exposed_id_discount( &self, customer: &str, subscription_exposed_id: &str, ) -> FluentRequest<'_, DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest>

Removes the currently applied discount on a customer.

pub fn get_customers_customer_tax_ids( &self, customer: &str, ) -> FluentRequest<'_, GetCustomersCustomerTaxIdsRequest>

Returns a list of tax IDs for a customer.

pub fn post_customers_customer_tax_ids( &self, customer: &str, ) -> FluentRequest<'_, PostCustomersCustomerTaxIdsRequest>

Creates a new tax_id object for a customer.

pub fn get_customers_customer_tax_ids_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, GetCustomersCustomerTaxIdsIdRequest>

Retrieves the tax_id object with the given identifier.

pub fn delete_customers_customer_tax_ids_id( &self, customer: &str, id: &str, ) -> FluentRequest<'_, DeleteCustomersCustomerTaxIdsIdRequest>

Deletes an existing tax_id object.

pub fn get_disputes(&self) -> FluentRequest<'_, GetDisputesRequest>

Returns a list of your disputes.

pub fn get_disputes_dispute( &self, dispute: &str, ) -> FluentRequest<'_, GetDisputesDisputeRequest>

Retrieves the dispute with the given ID.

pub fn post_disputes_dispute( &self, dispute: &str, ) -> FluentRequest<'_, PostDisputesDisputeRequest>

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

pub fn post_disputes_dispute_close( &self, dispute: &str, ) -> FluentRequest<'_, PostDisputesDisputeCloseRequest>

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

pub fn post_ephemeral_keys(&self) -> FluentRequest<'_, PostEphemeralKeysRequest>

Creates a short-lived API key for a given resource.

pub fn delete_ephemeral_keys_key( &self, key: &str, ) -> FluentRequest<'_, DeleteEphemeralKeysKeyRequest>

Invalidates a short-lived API key for a given resource.

pub fn get_events(&self) -> FluentRequest<'_, GetEventsRequest>

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

pub fn get_events_id(&self, id: &str) -> FluentRequest<'_, GetEventsIdRequest>

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

pub fn get_exchange_rates(&self) -> FluentRequest<'_, GetExchangeRatesRequest>

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

pub fn get_exchange_rates_rate_id( &self, rate_id: &str, ) -> FluentRequest<'_, GetExchangeRatesRateIdRequest>

Retrieves the exchange rates from the given currency to every supported currency.

pub fn get_file_links(&self) -> FluentRequest<'_, GetFileLinksRequest>

Returns a list of file links.

pub fn post_file_links(&self) -> FluentRequest<'_, PostFileLinksRequest>

Creates a new file link object.

pub fn get_file_links_link( &self, link: &str, ) -> FluentRequest<'_, GetFileLinksLinkRequest>

Retrieves the file link with the given ID.

pub fn post_file_links_link( &self, link: &str, ) -> FluentRequest<'_, PostFileLinksLinkRequest>

Updates an existing file link object. Expired links can no longer be updated.

pub fn get_files(&self) -> FluentRequest<'_, GetFilesRequest>

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

pub fn post_files(&self) -> FluentRequest<'_, PostFilesRequest>

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

pub fn get_files_file( &self, file: &str, ) -> FluentRequest<'_, GetFilesFileRequest>

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

pub fn get_financial_connections_accounts( &self, ) -> FluentRequest<'_, GetFinancialConnectionsAccountsRequest>

Returns a list of Financial Connections Account objects.

pub fn get_financial_connections_accounts_account( &self, account: &str, ) -> FluentRequest<'_, GetFinancialConnectionsAccountsAccountRequest>

Retrieves the details of an Financial Connections Account.

pub fn post_financial_connections_accounts_account_disconnect( &self, account: &str, ) -> FluentRequest<'_, PostFinancialConnectionsAccountsAccountDisconnectRequest>

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

pub fn get_financial_connections_accounts_account_owners( &self, account: &str, ownership: &str, ) -> FluentRequest<'_, GetFinancialConnectionsAccountsAccountOwnersRequest>

Lists all owners for a given Account

pub fn post_financial_connections_accounts_account_refresh( &self, account: &str, ) -> FluentRequest<'_, PostFinancialConnectionsAccountsAccountRefreshRequest>

Refreshes the data associated with a Financial Connections Account.

pub fn post_financial_connections_accounts_account_subscribe( &self, account: &str, ) -> FluentRequest<'_, PostFinancialConnectionsAccountsAccountSubscribeRequest>

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

pub fn post_financial_connections_accounts_account_unsubscribe( &self, account: &str, ) -> FluentRequest<'_, PostFinancialConnectionsAccountsAccountUnsubscribeRequest>

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

pub fn post_financial_connections_sessions( &self, ) -> FluentRequest<'_, PostFinancialConnectionsSessionsRequest>

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

pub fn get_financial_connections_sessions_session( &self, session: &str, ) -> FluentRequest<'_, GetFinancialConnectionsSessionsSessionRequest>

Retrieves the details of a Financial Connections Session

pub fn get_financial_connections_transactions( &self, account: &str, ) -> FluentRequest<'_, GetFinancialConnectionsTransactionsRequest>

Returns a list of Financial Connections Transaction objects.

pub fn get_financial_connections_transactions_transaction( &self, transaction: &str, ) -> FluentRequest<'_, GetFinancialConnectionsTransactionsTransactionRequest>

Retrieves the details of a Financial Connections Transaction

pub fn get_identity_verification_reports( &self, ) -> FluentRequest<'_, GetIdentityVerificationReportsRequest>

List all verification reports.

pub fn get_identity_verification_reports_report( &self, report: &str, ) -> FluentRequest<'_, GetIdentityVerificationReportsReportRequest>

Retrieves an existing VerificationReport

pub fn get_identity_verification_sessions( &self, ) -> FluentRequest<'_, GetIdentityVerificationSessionsRequest>

Returns a list of VerificationSessions

pub fn post_identity_verification_sessions( &self, ) -> FluentRequest<'_, PostIdentityVerificationSessionsRequest>

Creates a VerificationSession object.

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

Related guide: Verify your users’ identity documents

pub fn get_identity_verification_sessions_session( &self, session: &str, ) -> FluentRequest<'_, GetIdentityVerificationSessionsSessionRequest>

Retrieves the details of a VerificationSession that was previously created.

When the session status is requires_input, you can use this method to retrieve a valid client_secret or url to allow re-submission.

pub fn post_identity_verification_sessions_session( &self, session: &str, ) -> FluentRequest<'_, PostIdentityVerificationSessionsSessionRequest>

Updates a VerificationSession object.

When the session status is requires_input, you can use this method to update the verification check and options.

pub fn post_identity_verification_sessions_session_cancel( &self, session: &str, ) -> FluentRequest<'_, PostIdentityVerificationSessionsSessionCancelRequest>

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

pub fn post_identity_verification_sessions_session_redact( &self, session: &str, ) -> FluentRequest<'_, PostIdentityVerificationSessionsSessionRedactRequest>

Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.

A VerificationSession object can be redacted when it is in requires_input or verified status. Redacting a VerificationSession in requires_action state will automatically cancel it.

The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s redaction.status field will be set to processing; when the process is finished, it will change to redacted and an identity.verification_session.redacted event will be emitted.

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string [redacted] or a similar placeholder. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

pub fn get_invoiceitems(&self) -> FluentRequest<'_, GetInvoiceitemsRequest>

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

pub fn post_invoiceitems(&self) -> FluentRequest<'_, PostInvoiceitemsRequest>

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

pub fn get_invoiceitems_invoiceitem( &self, invoiceitem: &str, ) -> FluentRequest<'_, GetInvoiceitemsInvoiceitemRequest>

Retrieves the invoice item with the given ID.

pub fn post_invoiceitems_invoiceitem( &self, invoiceitem: &str, ) -> FluentRequest<'_, PostInvoiceitemsInvoiceitemRequest>

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

pub fn delete_invoiceitems_invoiceitem( &self, invoiceitem: &str, ) -> FluentRequest<'_, DeleteInvoiceitemsInvoiceitemRequest>

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

pub fn get_invoices(&self) -> FluentRequest<'_, GetInvoicesRequest>

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

pub fn post_invoices(&self) -> FluentRequest<'_, PostInvoicesRequest>

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

pub fn get_invoices_search( &self, query: &str, ) -> FluentRequest<'_, GetInvoicesSearchRequest>

Search for invoices you’ve previously created using Stripe’s 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.

pub fn get_invoices_upcoming( &self, ) -> FluentRequest<'_, GetInvoicesUpcomingRequest>

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

pub fn get_invoices_upcoming_lines( &self, ) -> FluentRequest<'_, GetInvoicesUpcomingLinesRequest>

When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

pub fn get_invoices_invoice( &self, invoice: &str, ) -> FluentRequest<'_, GetInvoicesInvoiceRequest>

Retrieves the invoice with the given ID.

pub fn post_invoices_invoice( &self, invoice: &str, ) -> FluentRequest<'_, PostInvoicesInvoiceRequest>

Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

pub fn delete_invoices_invoice( &self, invoice: &str, ) -> FluentRequest<'_, DeleteInvoicesInvoiceRequest>

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

pub fn post_invoices_invoice_finalize( &self, invoice: &str, ) -> FluentRequest<'_, PostInvoicesInvoiceFinalizeRequest>

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

pub fn get_invoices_invoice_lines( &self, invoice: &str, ) -> FluentRequest<'_, GetInvoicesInvoiceLinesRequest>

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

pub fn post_invoices_invoice_lines_line_item_id( &self, invoice: &str, line_item_id: &str, ) -> FluentRequest<'_, PostInvoicesInvoiceLinesLineItemIdRequest>

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item, so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. Updating an invoice’s line item is only possible before the invoice is finalized.

pub fn post_invoices_invoice_mark_uncollectible( &self, invoice: &str, ) -> FluentRequest<'_, PostInvoicesInvoiceMarkUncollectibleRequest>

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

pub fn post_invoices_invoice_pay( &self, invoice: &str, ) -> FluentRequest<'_, PostInvoicesInvoicePayRequest>

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

pub fn post_invoices_invoice_send( &self, invoice: &str, ) -> FluentRequest<'_, PostInvoicesInvoiceSendRequest>

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

pub fn post_invoices_invoice_void( &self, invoice: &str, ) -> FluentRequest<'_, PostInvoicesInvoiceVoidRequest>

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

pub fn get_issuing_authorizations( &self, ) -> FluentRequest<'_, GetIssuingAuthorizationsRequest>

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn get_issuing_authorizations_authorization( &self, authorization: &str, ) -> FluentRequest<'_, GetIssuingAuthorizationsAuthorizationRequest>

Retrieves an Issuing Authorization object.

pub fn post_issuing_authorizations_authorization( &self, authorization: &str, ) -> FluentRequest<'_, PostIssuingAuthorizationsAuthorizationRequest>

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn post_issuing_authorizations_authorization_approve( &self, authorization: &str, ) -> FluentRequest<'_, PostIssuingAuthorizationsAuthorizationApproveRequest>

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

pub fn post_issuing_authorizations_authorization_decline( &self, authorization: &str, ) -> FluentRequest<'_, PostIssuingAuthorizationsAuthorizationDeclineRequest>

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

pub fn get_issuing_cardholders( &self, ) -> FluentRequest<'_, GetIssuingCardholdersRequest>

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn post_issuing_cardholders( &self, ) -> FluentRequest<'_, PostIssuingCardholdersRequest>

Creates a new Issuing Cardholder object that can be issued cards.

pub fn get_issuing_cardholders_cardholder( &self, cardholder: &str, ) -> FluentRequest<'_, GetIssuingCardholdersCardholderRequest>

Retrieves an Issuing Cardholder object.

pub fn post_issuing_cardholders_cardholder( &self, cardholder: &str, ) -> FluentRequest<'_, PostIssuingCardholdersCardholderRequest>

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn get_issuing_cards(&self) -> FluentRequest<'_, GetIssuingCardsRequest>

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn post_issuing_cards(&self) -> FluentRequest<'_, PostIssuingCardsRequest>

Creates an Issuing Card object.

pub fn get_issuing_cards_card( &self, card: &str, ) -> FluentRequest<'_, GetIssuingCardsCardRequest>

Retrieves an Issuing Card object.

pub fn post_issuing_cards_card( &self, card: &str, ) -> FluentRequest<'_, PostIssuingCardsCardRequest>

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn get_issuing_disputes( &self, ) -> FluentRequest<'_, GetIssuingDisputesRequest>

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn post_issuing_disputes( &self, ) -> FluentRequest<'_, PostIssuingDisputesRequest>

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

pub fn get_issuing_disputes_dispute( &self, dispute: &str, ) -> FluentRequest<'_, GetIssuingDisputesDisputeRequest>

Retrieves an Issuing Dispute object.

pub fn post_issuing_disputes_dispute( &self, dispute: &str, ) -> FluentRequest<'_, PostIssuingDisputesDisputeRequest>

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

pub fn post_issuing_disputes_dispute_submit( &self, dispute: &str, ) -> FluentRequest<'_, PostIssuingDisputesDisputeSubmitRequest>

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

pub fn get_issuing_settlements( &self, ) -> FluentRequest<'_, GetIssuingSettlementsRequest>

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn get_issuing_settlements_settlement( &self, settlement: &str, ) -> FluentRequest<'_, GetIssuingSettlementsSettlementRequest>

Retrieves an Issuing Settlement object.

pub fn post_issuing_settlements_settlement( &self, settlement: &str, ) -> FluentRequest<'_, PostIssuingSettlementsSettlementRequest>

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn get_issuing_tokens( &self, card: &str, ) -> FluentRequest<'_, GetIssuingTokensRequest>

Lists all Issuing Token objects for a given card.

pub fn get_issuing_tokens_token( &self, token: &str, ) -> FluentRequest<'_, GetIssuingTokensTokenRequest>

Retrieves an Issuing Token object.

pub fn post_issuing_tokens_token( &self, token: &str, ) -> FluentRequest<'_, PostIssuingTokensTokenRequest>

Attempts to update the specified Issuing Token object to the status specified.

pub fn get_issuing_transactions( &self, ) -> FluentRequest<'_, GetIssuingTransactionsRequest>

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn get_issuing_transactions_transaction( &self, transaction: &str, ) -> FluentRequest<'_, GetIssuingTransactionsTransactionRequest>

Retrieves an Issuing Transaction object.

pub fn post_issuing_transactions_transaction( &self, transaction: &str, ) -> FluentRequest<'_, PostIssuingTransactionsTransactionRequest>

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn post_link_account_sessions( &self, ) -> FluentRequest<'_, PostLinkAccountSessionsRequest>

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

pub fn get_link_account_sessions_session( &self, session: &str, ) -> FluentRequest<'_, GetLinkAccountSessionsSessionRequest>

Retrieves the details of a Financial Connections Session

pub fn get_linked_accounts(&self) -> FluentRequest<'_, GetLinkedAccountsRequest>

Returns a list of Financial Connections Account objects.

pub fn get_linked_accounts_account( &self, account: &str, ) -> FluentRequest<'_, GetLinkedAccountsAccountRequest>

Retrieves the details of an Financial Connections Account.

pub fn post_linked_accounts_account_disconnect( &self, account: &str, ) -> FluentRequest<'_, PostLinkedAccountsAccountDisconnectRequest>

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

pub fn get_linked_accounts_account_owners( &self, account: &str, ownership: &str, ) -> FluentRequest<'_, GetLinkedAccountsAccountOwnersRequest>

Lists all owners for a given Account

pub fn post_linked_accounts_account_refresh( &self, account: &str, ) -> FluentRequest<'_, PostLinkedAccountsAccountRefreshRequest>

Refreshes the data associated with a Financial Connections Account.

pub fn get_mandates_mandate( &self, mandate: &str, ) -> FluentRequest<'_, GetMandatesMandateRequest>

Retrieves a Mandate object.

pub fn get_payment_intents(&self) -> FluentRequest<'_, GetPaymentIntentsRequest>

Returns a list of PaymentIntents.

pub fn post_payment_intents( &self, ) -> FluentRequest<'_, PostPaymentIntentsRequest>

Creates a PaymentIntent object.

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents API.

When you use confirm=true during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when you supply confirm=true.

pub fn get_payment_intents_search( &self, query: &str, ) -> FluentRequest<'_, GetPaymentIntentsSearchRequest>

Search for PaymentIntents you’ve previously created using Stripe’s 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.

pub fn get_payment_intents_intent( &self, intent: &str, ) -> FluentRequest<'_, GetPaymentIntentsIntentRequest>

Retrieves the details of a PaymentIntent that has previously been created.

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

pub fn post_payment_intents_intent( &self, intent: &str, ) -> FluentRequest<'_, PostPaymentIntentsIntentRequest>

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

pub fn post_payment_intents_intent_apply_customer_balance( &self, intent: &str, ) -> FluentRequest<'_, PostPaymentIntentsIntentApplyCustomerBalanceRequest>

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

pub fn post_payment_intents_intent_cancel( &self, intent: &str, ) -> FluentRequest<'_, PostPaymentIntentsIntentCancelRequest>

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

pub fn post_payment_intents_intent_capture( &self, intent: &str, ) -> FluentRequest<'_, PostPaymentIntentsIntentCaptureRequest>

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

pub fn post_payment_intents_intent_confirm( &self, intent: &str, ) -> FluentRequest<'_, PostPaymentIntentsIntentConfirmRequest>

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. Read the expanded documentation to learn more about manual confirmation.

pub fn post_payment_intents_intent_increment_authorization( &self, intent: &str, ) -> FluentRequest<'_, PostPaymentIntentsIntentIncrementAuthorizationRequest>

Perform an incremental authorization on an eligible PaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about incremental authorizations.

pub fn post_payment_intents_intent_verify_microdeposits( &self, intent: &str, ) -> FluentRequest<'_, PostPaymentIntentsIntentVerifyMicrodepositsRequest>

Verifies microdeposits on a PaymentIntent object.

pub fn get_payment_links(&self) -> FluentRequest<'_, GetPaymentLinksRequest>

Returns a list of your payment links.

pub fn post_payment_links(&self) -> FluentRequest<'_, PostPaymentLinksRequest>

Creates a payment link.

pub fn get_payment_links_payment_link( &self, payment_link: &str, ) -> FluentRequest<'_, GetPaymentLinksPaymentLinkRequest>

Retrieve a payment link.

pub fn post_payment_links_payment_link( &self, payment_link: &str, ) -> FluentRequest<'_, PostPaymentLinksPaymentLinkRequest>

Updates a payment link.

pub fn get_payment_links_payment_link_line_items( &self, payment_link: &str, ) -> FluentRequest<'_, GetPaymentLinksPaymentLinkLineItemsRequest>

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

pub fn get_payment_method_configurations( &self, ) -> FluentRequest<'_, GetPaymentMethodConfigurationsRequest>

List payment method configurations

pub fn post_payment_method_configurations( &self, ) -> FluentRequest<'_, PostPaymentMethodConfigurationsRequest>

Creates a payment method configuration

pub fn get_payment_method_configurations_configuration( &self, configuration: &str, ) -> FluentRequest<'_, GetPaymentMethodConfigurationsConfigurationRequest>

Retrieve payment method configuration

pub fn post_payment_method_configurations_configuration( &self, configuration: &str, ) -> FluentRequest<'_, PostPaymentMethodConfigurationsConfigurationRequest>

Update payment method configuration

pub fn get_payment_method_domains( &self, ) -> FluentRequest<'_, GetPaymentMethodDomainsRequest>

Lists the details of existing payment method domains.

pub fn post_payment_method_domains( &self, ) -> FluentRequest<'_, PostPaymentMethodDomainsRequest>

Creates a payment method domain.

pub fn get_payment_method_domains_payment_method_domain( &self, payment_method_domain: &str, ) -> FluentRequest<'_, GetPaymentMethodDomainsPaymentMethodDomainRequest>

Retrieves the details of an existing payment method domain.

pub fn post_payment_method_domains_payment_method_domain( &self, payment_method_domain: &str, ) -> FluentRequest<'_, PostPaymentMethodDomainsPaymentMethodDomainRequest>

Updates an existing payment method domain.

pub fn post_payment_method_domains_payment_method_domain_validate( &self, payment_method_domain: &str, ) -> FluentRequest<'_, PostPaymentMethodDomainsPaymentMethodDomainValidateRequest>

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

pub fn get_payment_methods(&self) -> FluentRequest<'_, GetPaymentMethodsRequest>

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

pub fn post_payment_methods( &self, ) -> FluentRequest<'_, PostPaymentMethodsRequest>

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

pub fn get_payment_methods_payment_method( &self, payment_method: &str, ) -> FluentRequest<'_, GetPaymentMethodsPaymentMethodRequest>

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

pub fn post_payment_methods_payment_method( &self, payment_method: &str, ) -> FluentRequest<'_, PostPaymentMethodsPaymentMethodRequest>

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

pub fn post_payment_methods_payment_method_attach( &self, payment_method: &str, ) -> FluentRequest<'_, PostPaymentMethodsPaymentMethodAttachRequest>

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

pub fn post_payment_methods_payment_method_detach( &self, payment_method: &str, ) -> FluentRequest<'_, PostPaymentMethodsPaymentMethodDetachRequest>

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

pub fn get_payouts(&self) -> FluentRequest<'_, GetPayoutsRequest>

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

pub fn post_payouts(&self) -> FluentRequest<'_, PostPayoutsRequest>

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

pub fn get_payouts_payout( &self, payout: &str, ) -> FluentRequest<'_, GetPayoutsPayoutRequest>

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

pub fn post_payouts_payout( &self, payout: &str, ) -> FluentRequest<'_, PostPayoutsPayoutRequest>

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

pub fn post_payouts_payout_cancel( &self, payout: &str, ) -> FluentRequest<'_, PostPayoutsPayoutCancelRequest>

You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

pub fn post_payouts_payout_reverse( &self, payout: &str, ) -> FluentRequest<'_, PostPayoutsPayoutReverseRequest>

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

pub fn get_plans(&self) -> FluentRequest<'_, GetPlansRequest>

Returns a list of your plans.

pub fn post_plans(&self) -> FluentRequest<'_, PostPlansRequest>

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

pub fn get_plans_plan( &self, plan: &str, ) -> FluentRequest<'_, GetPlansPlanRequest>

Retrieves the plan with the given ID.

pub fn post_plans_plan( &self, plan: &str, ) -> FluentRequest<'_, PostPlansPlanRequest>

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

pub fn delete_plans_plan( &self, plan: &str, ) -> FluentRequest<'_, DeletePlansPlanRequest>

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

pub fn get_prices(&self) -> FluentRequest<'_, GetPricesRequest>

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

pub fn post_prices(&self) -> FluentRequest<'_, PostPricesRequest>

Creates a new price for an existing product. The price can be recurring or one-time.

pub fn get_prices_search( &self, query: &str, ) -> FluentRequest<'_, GetPricesSearchRequest>

Search for prices you’ve previously created using Stripe’s 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.

pub fn get_prices_price( &self, price: &str, ) -> FluentRequest<'_, GetPricesPriceRequest>

Retrieves the price with the given ID.

pub fn post_prices_price( &self, price: &str, ) -> FluentRequest<'_, PostPricesPriceRequest>

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

pub fn get_products(&self) -> FluentRequest<'_, GetProductsRequest>

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

pub fn post_products(&self) -> FluentRequest<'_, PostProductsRequest>

Creates a new product object.

pub fn get_products_search( &self, query: &str, ) -> FluentRequest<'_, GetProductsSearchRequest>

Search for products you’ve previously created using Stripe’s 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.

pub fn get_products_id( &self, id: &str, ) -> FluentRequest<'_, GetProductsIdRequest>

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

pub fn post_products_id( &self, id: &str, ) -> FluentRequest<'_, PostProductsIdRequest>

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn delete_products_id( &self, id: &str, ) -> FluentRequest<'_, DeleteProductsIdRequest>

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

pub fn get_promotion_codes(&self) -> FluentRequest<'_, GetPromotionCodesRequest>

Returns a list of your promotion codes.

pub fn post_promotion_codes( &self, ) -> FluentRequest<'_, PostPromotionCodesRequest>

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

pub fn get_promotion_codes_promotion_code( &self, promotion_code: &str, ) -> FluentRequest<'_, GetPromotionCodesPromotionCodeRequest>

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

pub fn post_promotion_codes_promotion_code( &self, promotion_code: &str, ) -> FluentRequest<'_, PostPromotionCodesPromotionCodeRequest>

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

pub fn get_quotes(&self) -> FluentRequest<'_, GetQuotesRequest>

Returns a list of your quotes.

pub fn post_quotes(&self) -> FluentRequest<'_, PostQuotesRequest>

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

pub fn get_quotes_quote( &self, quote: &str, ) -> FluentRequest<'_, GetQuotesQuoteRequest>

Retrieves the quote with the given ID.

pub fn post_quotes_quote( &self, quote: &str, ) -> FluentRequest<'_, PostQuotesQuoteRequest>

A quote models prices and services for a customer.

pub fn post_quotes_quote_accept( &self, quote: &str, ) -> FluentRequest<'_, PostQuotesQuoteAcceptRequest>

Accepts the specified quote.

pub fn post_quotes_quote_cancel( &self, quote: &str, ) -> FluentRequest<'_, PostQuotesQuoteCancelRequest>

Cancels the quote.

pub fn get_quotes_quote_computed_upfront_line_items( &self, quote: &str, ) -> FluentRequest<'_, GetQuotesQuoteComputedUpfrontLineItemsRequest>

When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

pub fn post_quotes_quote_finalize( &self, quote: &str, ) -> FluentRequest<'_, PostQuotesQuoteFinalizeRequest>

Finalizes the quote.

pub fn get_quotes_quote_line_items( &self, quote: &str, ) -> FluentRequest<'_, GetQuotesQuoteLineItemsRequest>

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

pub fn get_quotes_quote_pdf( &self, quote: &str, ) -> FluentRequest<'_, GetQuotesQuotePdfRequest>

Download the PDF for a finalized quote

pub fn get_radar_early_fraud_warnings( &self, ) -> FluentRequest<'_, GetRadarEarlyFraudWarningsRequest>

Returns a list of early fraud warnings.

pub fn get_radar_early_fraud_warnings_early_fraud_warning( &self, early_fraud_warning: &str, ) -> FluentRequest<'_, GetRadarEarlyFraudWarningsEarlyFraudWarningRequest>

Retrieves the details of an early fraud warning that has previously been created.

Please refer to the early fraud warning object reference for more details.

pub fn get_radar_value_list_items( &self, value_list: &str, ) -> FluentRequest<'_, GetRadarValueListItemsRequest>

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn post_radar_value_list_items( &self, ) -> FluentRequest<'_, PostRadarValueListItemsRequest>

Creates a new ValueListItem object, which is added to the specified parent value list.

pub fn get_radar_value_list_items_item( &self, item: &str, ) -> FluentRequest<'_, GetRadarValueListItemsItemRequest>

Retrieves a ValueListItem object.

pub fn delete_radar_value_list_items_item( &self, item: &str, ) -> FluentRequest<'_, DeleteRadarValueListItemsItemRequest>

Deletes a ValueListItem object, removing it from its parent value list.

pub fn get_radar_value_lists( &self, ) -> FluentRequest<'_, GetRadarValueListsRequest>

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn post_radar_value_lists( &self, ) -> FluentRequest<'_, PostRadarValueListsRequest>

Creates a new ValueList object, which can then be referenced in rules.

pub fn get_radar_value_lists_value_list( &self, value_list: &str, ) -> FluentRequest<'_, GetRadarValueListsValueListRequest>

Retrieves a ValueList object.

pub fn post_radar_value_lists_value_list( &self, value_list: &str, ) -> FluentRequest<'_, PostRadarValueListsValueListRequest>

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

pub fn delete_radar_value_lists_value_list( &self, value_list: &str, ) -> FluentRequest<'_, DeleteRadarValueListsValueListRequest>

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

pub fn get_refunds(&self) -> FluentRequest<'_, GetRefundsRequest>

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.

pub fn post_refunds(&self) -> FluentRequest<'_, PostRefundsRequest>

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

pub fn get_refunds_refund( &self, refund: &str, ) -> FluentRequest<'_, GetRefundsRefundRequest>

Retrieves the details of an existing refund.

pub fn post_refunds_refund( &self, refund: &str, ) -> FluentRequest<'_, PostRefundsRefundRequest>

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

This request only accepts metadata as an argument.

pub fn post_refunds_refund_cancel( &self, refund: &str, ) -> FluentRequest<'_, PostRefundsRefundCancelRequest>

Cancels a refund with a status of requires_action.

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

pub fn get_reporting_report_runs( &self, ) -> FluentRequest<'_, GetReportingReportRunsRequest>

Returns a list of Report Runs, with the most recent appearing first.

pub fn post_reporting_report_runs( &self, ) -> FluentRequest<'_, PostReportingReportRunsRequest>

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

pub fn get_reporting_report_runs_report_run( &self, report_run: &str, ) -> FluentRequest<'_, GetReportingReportRunsReportRunRequest>

Retrieves the details of an existing Report Run.

pub fn get_reporting_report_types( &self, ) -> FluentRequest<'_, GetReportingReportTypesRequest>

Returns a full list of Report Types.

pub fn get_reporting_report_types_report_type( &self, report_type: &str, ) -> FluentRequest<'_, GetReportingReportTypesReportTypeRequest>

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

pub fn get_reviews(&self) -> FluentRequest<'_, GetReviewsRequest>

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

pub fn get_reviews_review( &self, review: &str, ) -> FluentRequest<'_, GetReviewsReviewRequest>

Retrieves a Review object.

pub fn post_reviews_review_approve( &self, review: &str, ) -> FluentRequest<'_, PostReviewsReviewApproveRequest>

Approves a Review object, closing it and removing it from the list of reviews.

pub fn get_setup_attempts( &self, setup_intent: &str, ) -> FluentRequest<'_, GetSetupAttemptsRequest>

Returns a list of SetupAttempts that associate with a provided SetupIntent.

pub fn get_setup_intents(&self) -> FluentRequest<'_, GetSetupIntentsRequest>

Returns a list of SetupIntents.

pub fn post_setup_intents(&self) -> FluentRequest<'_, PostSetupIntentsRequest>

Creates a SetupIntent object.

After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.

pub fn get_setup_intents_intent( &self, intent: &str, ) -> FluentRequest<'_, GetSetupIntentsIntentRequest>

Retrieves the details of a SetupIntent that has previously been created.

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

pub fn post_setup_intents_intent( &self, intent: &str, ) -> FluentRequest<'_, PostSetupIntentsIntentRequest>

Updates a SetupIntent object.

pub fn post_setup_intents_intent_cancel( &self, intent: &str, ) -> FluentRequest<'_, PostSetupIntentsIntentCancelRequest>

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error.

pub fn post_setup_intents_intent_confirm( &self, intent: &str, ) -> FluentRequest<'_, PostSetupIntentsIntentConfirmRequest>

Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.

pub fn post_setup_intents_intent_verify_microdeposits( &self, intent: &str, ) -> FluentRequest<'_, PostSetupIntentsIntentVerifyMicrodepositsRequest>

Verifies microdeposits on a SetupIntent object.

pub fn get_shipping_rates(&self) -> FluentRequest<'_, GetShippingRatesRequest>

Returns a list of your shipping rates.

pub fn post_shipping_rates(&self) -> FluentRequest<'_, PostShippingRatesRequest>

Creates a new shipping rate object.

pub fn get_shipping_rates_shipping_rate_token( &self, shipping_rate_token: &str, ) -> FluentRequest<'_, GetShippingRatesShippingRateTokenRequest>

Returns the shipping rate object with the given ID.

pub fn post_shipping_rates_shipping_rate_token( &self, shipping_rate_token: &str, ) -> FluentRequest<'_, PostShippingRatesShippingRateTokenRequest>

Updates an existing shipping rate object.

pub fn get_sigma_scheduled_query_runs( &self, ) -> FluentRequest<'_, GetSigmaScheduledQueryRunsRequest>

Returns a list of scheduled query runs.

pub fn get_sigma_scheduled_query_runs_scheduled_query_run( &self, scheduled_query_run: &str, ) -> FluentRequest<'_, GetSigmaScheduledQueryRunsScheduledQueryRunRequest>

Retrieves the details of an scheduled query run.

pub fn post_sources(&self) -> FluentRequest<'_, PostSourcesRequest>

Creates a new source object.

pub fn get_sources_source( &self, source: &str, ) -> FluentRequest<'_, GetSourcesSourceRequest>

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

pub fn post_sources_source( &self, source: &str, ) -> FluentRequest<'_, PostSourcesSourceRequest>

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

pub fn get_sources_source_mandate_notifications_mandate_notification( &self, mandate_notification: &str, source: &str, ) -> FluentRequest<'_, GetSourcesSourceMandateNotificationsMandateNotificationRequest>

Retrieves a new Source MandateNotification.

pub fn get_sources_source_source_transactions( &self, source: &str, ) -> FluentRequest<'_, GetSourcesSourceSourceTransactionsRequest>

List source transactions for a given source.

pub fn get_sources_source_source_transactions_source_transaction( &self, source: &str, source_transaction: &str, ) -> FluentRequest<'_, GetSourcesSourceSourceTransactionsSourceTransactionRequest>

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

pub fn post_sources_source_verify( &self, source: &str, ) -> FluentRequest<'_, PostSourcesSourceVerifyRequest>

Verify a given source.

pub fn get_subscription_items( &self, subscription: &str, ) -> FluentRequest<'_, GetSubscriptionItemsRequest>

Returns a list of your subscription items for a given subscription.

pub fn post_subscription_items( &self, ) -> FluentRequest<'_, PostSubscriptionItemsRequest>

Adds a new item to an existing subscription. No existing items will be changed or replaced.

pub fn get_subscription_items_item( &self, item: &str, ) -> FluentRequest<'_, GetSubscriptionItemsItemRequest>

Retrieves the subscription item with the given ID.

pub fn post_subscription_items_item( &self, item: &str, ) -> FluentRequest<'_, PostSubscriptionItemsItemRequest>

Updates the plan or quantity of an item on a current subscription.

pub fn delete_subscription_items_item( &self, item: &str, ) -> FluentRequest<'_, DeleteSubscriptionItemsItemRequest>

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

pub fn get_subscription_items_subscription_item_usage_record_summaries( &self, subscription_item: &str, ) -> FluentRequest<'_, GetSubscriptionItemsSubscriptionItemUsageRecordSummariesRequest>

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.

pub fn post_subscription_items_subscription_item_usage_records( &self, subscription_item: &str, ) -> FluentRequest<'_, PostSubscriptionItemsSubscriptionItemUsageRecordsRequest>

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 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. 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 tiered pricing model.

pub fn get_subscription_schedules( &self, ) -> FluentRequest<'_, GetSubscriptionSchedulesRequest>

Retrieves the list of your subscription schedules.

pub fn post_subscription_schedules( &self, ) -> FluentRequest<'_, PostSubscriptionSchedulesRequest>

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

pub fn get_subscription_schedules_schedule( &self, schedule: &str, ) -> FluentRequest<'_, GetSubscriptionSchedulesScheduleRequest>

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

pub fn post_subscription_schedules_schedule( &self, schedule: &str, ) -> FluentRequest<'_, PostSubscriptionSchedulesScheduleRequest>

Updates an existing subscription schedule.

pub fn post_subscription_schedules_schedule_cancel( &self, schedule: &str, ) -> FluentRequest<'_, PostSubscriptionSchedulesScheduleCancelRequest>

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

pub fn post_subscription_schedules_schedule_release( &self, schedule: &str, ) -> FluentRequest<'_, PostSubscriptionSchedulesScheduleReleaseRequest>

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

pub fn get_subscriptions(&self) -> FluentRequest<'_, GetSubscriptionsRequest>

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

pub fn post_subscriptions(&self) -> FluentRequest<'_, PostSubscriptionsRequest>

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. The payment_behavior parameter determines the exact behavior of the initial payment.

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead. Schedules provide the flexibility to model more complex billing configurations that change over time.

pub fn get_subscriptions_search( &self, query: &str, ) -> FluentRequest<'_, GetSubscriptionsSearchRequest>

Search for subscriptions you’ve previously created using Stripe’s 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.

pub fn get_subscriptions_subscription_exposed_id( &self, subscription_exposed_id: &str, ) -> FluentRequest<'_, GetSubscriptionsSubscriptionExposedIdRequest>

Retrieves the subscription with the given ID.

pub fn post_subscriptions_subscription_exposed_id( &self, subscription_exposed_id: &str, ) -> FluentRequest<'_, PostSubscriptionsSubscriptionExposedIdRequest>

Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the upcoming invoice endpoint.

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

Switching prices does not normally change the billing date or generate an immediate charge unless:

• The billing interval is changed (for example, from monthly to yearly).
• The subscription moves from free to paid, or paid to free.
• A trial starts or ends.

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

pub fn delete_subscriptions_subscription_exposed_id( &self, subscription_exposed_id: &str, ) -> FluentRequest<'_, DeleteSubscriptionsSubscriptionExposedIdRequest>

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

pub fn delete_subscriptions_subscription_exposed_id_discount( &self, subscription_exposed_id: &str, ) -> FluentRequest<'_, DeleteSubscriptionsSubscriptionExposedIdDiscountRequest>

Removes the currently applied discount on a subscription.

pub fn post_subscriptions_subscription_resume( &self, subscription: &str, ) -> FluentRequest<'_, PostSubscriptionsSubscriptionResumeRequest>

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.

pub fn post_tax_calculations( &self, ) -> FluentRequest<'_, PostTaxCalculationsRequest>

Calculates tax based on input and returns a Tax Calculation object.

pub fn get_tax_calculations_calculation_line_items( &self, calculation: &str, ) -> FluentRequest<'_, GetTaxCalculationsCalculationLineItemsRequest>

Retrieves the line items of a persisted tax calculation as a collection.

pub fn get_tax_registrations( &self, ) -> FluentRequest<'_, GetTaxRegistrationsRequest>

Returns a list of Tax Registration objects.

pub fn post_tax_registrations( &self, ) -> FluentRequest<'_, PostTaxRegistrationsRequest>

Creates a new Tax Registration object.

pub fn post_tax_registrations_id( &self, id: &str, ) -> FluentRequest<'_, PostTaxRegistrationsIdRequest>

Updates an existing Tax Registration object.

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

pub fn get_tax_settings(&self) -> FluentRequest<'_, GetTaxSettingsRequest>

Retrieves Tax Settings for a merchant.

pub fn post_tax_settings(&self) -> FluentRequest<'_, PostTaxSettingsRequest>

Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

pub fn post_tax_transactions_create_from_calculation( &self, ) -> FluentRequest<'_, PostTaxTransactionsCreateFromCalculationRequest>

Creates a Tax Transaction from a calculation.

pub fn post_tax_transactions_create_reversal( &self, ) -> FluentRequest<'_, PostTaxTransactionsCreateReversalRequest>

Partially or fully reverses a previously created Transaction.

pub fn get_tax_transactions_transaction( &self, transaction: &str, ) -> FluentRequest<'_, GetTaxTransactionsTransactionRequest>

Retrieves a Tax Transaction object.

pub fn get_tax_transactions_transaction_line_items( &self, transaction: &str, ) -> FluentRequest<'_, GetTaxTransactionsTransactionLineItemsRequest>

Retrieves the line items of a committed standalone transaction as a collection.

pub fn get_tax_codes(&self) -> FluentRequest<'_, GetTaxCodesRequest>

A list of all tax codes available to add to Products in order to allow specific tax calculations.

pub fn get_tax_codes_id( &self, id: &str, ) -> FluentRequest<'_, GetTaxCodesIdRequest>

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

pub fn get_tax_rates(&self) -> FluentRequest<'_, GetTaxRatesRequest>

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

pub fn post_tax_rates(&self) -> FluentRequest<'_, PostTaxRatesRequest>

Creates a new tax rate.

pub fn get_tax_rates_tax_rate( &self, tax_rate: &str, ) -> FluentRequest<'_, GetTaxRatesTaxRateRequest>

Retrieves a tax rate with the given ID

pub fn post_tax_rates_tax_rate( &self, tax_rate: &str, ) -> FluentRequest<'_, PostTaxRatesTaxRateRequest>

Updates an existing tax rate.

pub fn get_terminal_configurations( &self, ) -> FluentRequest<'_, GetTerminalConfigurationsRequest>

Returns a list of Configuration objects.

pub fn post_terminal_configurations( &self, ) -> FluentRequest<'_, PostTerminalConfigurationsRequest>

Creates a new Configuration object.

pub fn get_terminal_configurations_configuration( &self, configuration: &str, ) -> FluentRequest<'_, GetTerminalConfigurationsConfigurationRequest>

Retrieves a Configuration object.

pub fn post_terminal_configurations_configuration( &self, configuration: &str, ) -> FluentRequest<'_, PostTerminalConfigurationsConfigurationRequest>

Updates a new Configuration object.

pub fn delete_terminal_configurations_configuration( &self, configuration: &str, ) -> FluentRequest<'_, DeleteTerminalConfigurationsConfigurationRequest>

Deletes a Configuration object.

pub fn post_terminal_connection_tokens( &self, ) -> FluentRequest<'_, PostTerminalConnectionTokensRequest>

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

pub fn get_terminal_locations( &self, ) -> FluentRequest<'_, GetTerminalLocationsRequest>

Returns a list of Location objects.

pub fn post_terminal_locations( &self, ) -> FluentRequest<'_, PostTerminalLocationsRequest>

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

pub fn get_terminal_locations_location( &self, location: &str, ) -> FluentRequest<'_, GetTerminalLocationsLocationRequest>

Retrieves a Location object.

pub fn post_terminal_locations_location( &self, location: &str, ) -> FluentRequest<'_, PostTerminalLocationsLocationRequest>

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn delete_terminal_locations_location( &self, location: &str, ) -> FluentRequest<'_, DeleteTerminalLocationsLocationRequest>

Deletes a Location object.

pub fn get_terminal_readers( &self, ) -> FluentRequest<'_, GetTerminalReadersRequest>

Returns a list of Reader objects.

pub fn post_terminal_readers( &self, ) -> FluentRequest<'_, PostTerminalReadersRequest>

Creates a new Reader object.

pub fn get_terminal_readers_reader( &self, reader: &str, ) -> FluentRequest<'_, GetTerminalReadersReaderRequest>

Retrieves a Reader object.

pub fn post_terminal_readers_reader( &self, reader: &str, ) -> FluentRequest<'_, PostTerminalReadersReaderRequest>

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

pub fn delete_terminal_readers_reader( &self, reader: &str, ) -> FluentRequest<'_, DeleteTerminalReadersReaderRequest>

Deletes a Reader object.

pub fn post_terminal_readers_reader_cancel_action( &self, reader: &str, ) -> FluentRequest<'_, PostTerminalReadersReaderCancelActionRequest>

Cancels the current reader action.

pub fn post_terminal_readers_reader_process_payment_intent( &self, reader: &str, ) -> FluentRequest<'_, PostTerminalReadersReaderProcessPaymentIntentRequest>

Initiates a payment flow on a Reader.

pub fn post_terminal_readers_reader_process_setup_intent( &self, reader: &str, ) -> FluentRequest<'_, PostTerminalReadersReaderProcessSetupIntentRequest>

Initiates a setup intent flow on a Reader.

pub fn post_terminal_readers_reader_refund_payment( &self, reader: &str, ) -> FluentRequest<'_, PostTerminalReadersReaderRefundPaymentRequest>

Initiates a refund on a Reader

pub fn post_terminal_readers_reader_set_reader_display( &self, reader: &str, ) -> FluentRequest<'_, PostTerminalReadersReaderSetReaderDisplayRequest>

Sets reader display to show cart details.

pub fn post_test_helpers_customers_customer_fund_cash_balance( &self, customer: &str, ) -> FluentRequest<'_, PostTestHelpersCustomersCustomerFundCashBalanceRequest>

Create an incoming testmode bank transfer

pub fn post_test_helpers_issuing_authorizations( &self, ) -> FluentRequest<'_, PostTestHelpersIssuingAuthorizationsRequest>

Create a test-mode authorization.

pub fn post_test_helpers_issuing_authorizations_authorization_capture( &self, authorization: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingAuthorizationsAuthorizationCaptureRequest>

Capture a test-mode authorization.

pub fn post_test_helpers_issuing_authorizations_authorization_expire( &self, authorization: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingAuthorizationsAuthorizationExpireRequest>

Expire a test-mode Authorization.

pub fn post_test_helpers_issuing_authorizations_authorization_increment( &self, authorization: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingAuthorizationsAuthorizationIncrementRequest>

Increment a test-mode Authorization.

pub fn post_test_helpers_issuing_authorizations_authorization_reverse( &self, authorization: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingAuthorizationsAuthorizationReverseRequest>

Reverse a test-mode Authorization.

pub fn post_test_helpers_issuing_cards_card_shipping_deliver( &self, card: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingCardsCardShippingDeliverRequest>

Updates the shipping status of the specified Issuing Card object to delivered.

pub fn post_test_helpers_issuing_cards_card_shipping_fail( &self, card: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingCardsCardShippingFailRequest>

Updates the shipping status of the specified Issuing Card object to failure.

pub fn post_test_helpers_issuing_cards_card_shipping_return( &self, card: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingCardsCardShippingReturnRequest>

Updates the shipping status of the specified Issuing Card object to returned.

pub fn post_test_helpers_issuing_cards_card_shipping_ship( &self, card: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingCardsCardShippingShipRequest>

Updates the shipping status of the specified Issuing Card object to shipped.

pub fn post_test_helpers_issuing_transactions_create_force_capture( &self, ) -> FluentRequest<'_, PostTestHelpersIssuingTransactionsCreateForceCaptureRequest>

Allows the user to capture an arbitrary amount, also known as a forced capture.

pub fn post_test_helpers_issuing_transactions_create_unlinked_refund( &self, ) -> FluentRequest<'_, PostTestHelpersIssuingTransactionsCreateUnlinkedRefundRequest>

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

pub fn post_test_helpers_issuing_transactions_transaction_refund( &self, transaction: &str, ) -> FluentRequest<'_, PostTestHelpersIssuingTransactionsTransactionRefundRequest>

Refund a test-mode Transaction.

pub fn post_test_helpers_refunds_refund_expire( &self, refund: &str, ) -> FluentRequest<'_, PostTestHelpersRefundsRefundExpireRequest>

Expire a refund with a status of requires_action.

pub fn post_test_helpers_terminal_readers_reader_present_payment_method( &self, reader: &str, ) -> FluentRequest<'_, PostTestHelpersTerminalReadersReaderPresentPaymentMethodRequest>

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

pub fn get_test_helpers_test_clocks( &self, ) -> FluentRequest<'_, GetTestHelpersTestClocksRequest>

Returns a list of your test clocks.

pub fn post_test_helpers_test_clocks( &self, ) -> FluentRequest<'_, PostTestHelpersTestClocksRequest>

Creates a new test clock that can be attached to new customers and quotes.

pub fn get_test_helpers_test_clocks_test_clock( &self, test_clock: &str, ) -> FluentRequest<'_, GetTestHelpersTestClocksTestClockRequest>

Retrieves a test clock.

pub fn delete_test_helpers_test_clocks_test_clock( &self, test_clock: &str, ) -> FluentRequest<'_, DeleteTestHelpersTestClocksTestClockRequest>

Deletes a test clock.

pub fn post_test_helpers_test_clocks_test_clock_advance( &self, test_clock: &str, ) -> FluentRequest<'_, PostTestHelpersTestClocksTestClockAdvanceRequest>

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

pub fn post_test_helpers_treasury_inbound_transfers_id_fail( &self, id: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryInboundTransfersIdFailRequest>

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

pub fn post_test_helpers_treasury_inbound_transfers_id_return( &self, id: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryInboundTransfersIdReturnRequest>

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

pub fn post_test_helpers_treasury_inbound_transfers_id_succeed( &self, id: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryInboundTransfersIdSucceedRequest>

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

pub fn post_test_helpers_treasury_outbound_payments_id_fail( &self, id: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryOutboundPaymentsIdFailRequest>

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

pub fn post_test_helpers_treasury_outbound_payments_id_post( &self, id: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryOutboundPaymentsIdPostRequest>

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

pub fn post_test_helpers_treasury_outbound_payments_id_return( &self, id: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryOutboundPaymentsIdReturnRequest>

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

pub fn post_test_helpers_treasury_outbound_transfers_outbound_transfer_fail( &self, outbound_transfer: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryOutboundTransfersOutboundTransferFailRequest>

Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

pub fn post_test_helpers_treasury_outbound_transfers_outbound_transfer_post( &self, outbound_transfer: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryOutboundTransfersOutboundTransferPostRequest>

Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

pub fn post_test_helpers_treasury_outbound_transfers_outbound_transfer_return( &self, outbound_transfer: &str, ) -> FluentRequest<'_, PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturnRequest>

Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

pub fn post_test_helpers_treasury_received_credits( &self, ) -> FluentRequest<'_, PostTestHelpersTreasuryReceivedCreditsRequest>

Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

pub fn post_test_helpers_treasury_received_debits( &self, ) -> FluentRequest<'_, PostTestHelpersTreasuryReceivedDebitsRequest>

Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

pub fn post_tokens(&self) -> FluentRequest<'_, PostTokensRequest>

Creates a single-use token that represents a bank account’s details. You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.

pub fn get_tokens_token( &self, token: &str, ) -> FluentRequest<'_, GetTokensTokenRequest>

Retrieves the token with the given ID.

pub fn get_topups(&self) -> FluentRequest<'_, GetTopupsRequest>

Returns a list of top-ups.

pub fn post_topups(&self) -> FluentRequest<'_, PostTopupsRequest>

Top up the balance of an account

pub fn get_topups_topup( &self, topup: &str, ) -> FluentRequest<'_, GetTopupsTopupRequest>

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

pub fn post_topups_topup( &self, topup: &str, ) -> FluentRequest<'_, PostTopupsTopupRequest>

Updates the metadata of a top-up. Other top-up details are not editable by design.

pub fn post_topups_topup_cancel( &self, topup: &str, ) -> FluentRequest<'_, PostTopupsTopupCancelRequest>

Cancels a top-up. Only pending top-ups can be canceled.

pub fn get_transfers(&self) -> FluentRequest<'_, GetTransfersRequest>

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

pub fn post_transfers(&self) -> FluentRequest<'_, PostTransfersRequest>

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

pub fn get_transfers_id_reversals( &self, id: &str, ) -> FluentRequest<'_, GetTransfersIdReversalsRequest>

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

pub fn post_transfers_id_reversals( &self, id: &str, ) -> FluentRequest<'_, PostTransfersIdReversalsRequest>

When you create a new reversal, you must specify a transfer to create it on.

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

pub fn get_transfers_transfer( &self, transfer: &str, ) -> FluentRequest<'_, GetTransfersTransferRequest>

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

pub fn post_transfers_transfer( &self, transfer: &str, ) -> FluentRequest<'_, PostTransfersTransferRequest>

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts only metadata as an argument.

pub fn get_transfers_transfer_reversals_id( &self, id: &str, transfer: &str, ) -> FluentRequest<'_, GetTransfersTransferReversalsIdRequest>

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

pub fn post_transfers_transfer_reversals_id( &self, id: &str, transfer: &str, ) -> FluentRequest<'_, PostTransfersTransferReversalsIdRequest>

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata and description as arguments.

pub fn get_treasury_credit_reversals( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryCreditReversalsRequest>

Returns a list of CreditReversals.

pub fn post_treasury_credit_reversals( &self, ) -> FluentRequest<'_, PostTreasuryCreditReversalsRequest>

Reverses a ReceivedCredit and creates a CreditReversal object.

pub fn get_treasury_credit_reversals_credit_reversal( &self, credit_reversal: &str, ) -> FluentRequest<'_, GetTreasuryCreditReversalsCreditReversalRequest>

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

pub fn get_treasury_debit_reversals( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryDebitReversalsRequest>

Returns a list of DebitReversals.

pub fn post_treasury_debit_reversals( &self, ) -> FluentRequest<'_, PostTreasuryDebitReversalsRequest>

Reverses a ReceivedDebit and creates a DebitReversal object.

pub fn get_treasury_debit_reversals_debit_reversal( &self, debit_reversal: &str, ) -> FluentRequest<'_, GetTreasuryDebitReversalsDebitReversalRequest>

Retrieves a DebitReversal object.

pub fn get_treasury_financial_accounts( &self, ) -> FluentRequest<'_, GetTreasuryFinancialAccountsRequest>

Returns a list of FinancialAccounts.

pub fn post_treasury_financial_accounts( &self, ) -> FluentRequest<'_, PostTreasuryFinancialAccountsRequest>

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

pub fn get_treasury_financial_accounts_financial_account( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryFinancialAccountsFinancialAccountRequest>

Retrieves the details of a FinancialAccount.

pub fn post_treasury_financial_accounts_financial_account( &self, financial_account: &str, ) -> FluentRequest<'_, PostTreasuryFinancialAccountsFinancialAccountRequest>

Updates the details of a FinancialAccount.

pub fn get_treasury_financial_accounts_financial_account_features( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryFinancialAccountsFinancialAccountFeaturesRequest>

Retrieves Features information associated with the FinancialAccount.

pub fn post_treasury_financial_accounts_financial_account_features( &self, financial_account: &str, ) -> FluentRequest<'_, PostTreasuryFinancialAccountsFinancialAccountFeaturesRequest>

Updates the Features associated with a FinancialAccount.

pub fn get_treasury_inbound_transfers( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryInboundTransfersRequest>

Returns a list of InboundTransfers sent from the specified FinancialAccount.

pub fn post_treasury_inbound_transfers( &self, ) -> FluentRequest<'_, PostTreasuryInboundTransfersRequest>

Creates an InboundTransfer.

pub fn get_treasury_inbound_transfers_id( &self, id: &str, ) -> FluentRequest<'_, GetTreasuryInboundTransfersIdRequest>

Retrieves the details of an existing InboundTransfer.

pub fn post_treasury_inbound_transfers_inbound_transfer_cancel( &self, inbound_transfer: &str, ) -> FluentRequest<'_, PostTreasuryInboundTransfersInboundTransferCancelRequest>

Cancels an InboundTransfer.

pub fn get_treasury_outbound_payments( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryOutboundPaymentsRequest>

Returns a list of OutboundPayments sent from the specified FinancialAccount.

pub fn post_treasury_outbound_payments( &self, ) -> FluentRequest<'_, PostTreasuryOutboundPaymentsRequest>

Creates an OutboundPayment.

pub fn get_treasury_outbound_payments_id( &self, id: &str, ) -> FluentRequest<'_, GetTreasuryOutboundPaymentsIdRequest>

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

pub fn post_treasury_outbound_payments_id_cancel( &self, id: &str, ) -> FluentRequest<'_, PostTreasuryOutboundPaymentsIdCancelRequest>

Cancel an OutboundPayment.

pub fn get_treasury_outbound_transfers( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryOutboundTransfersRequest>

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

pub fn post_treasury_outbound_transfers( &self, ) -> FluentRequest<'_, PostTreasuryOutboundTransfersRequest>

Creates an OutboundTransfer.

pub fn get_treasury_outbound_transfers_outbound_transfer( &self, outbound_transfer: &str, ) -> FluentRequest<'_, GetTreasuryOutboundTransfersOutboundTransferRequest>

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

pub fn post_treasury_outbound_transfers_outbound_transfer_cancel( &self, outbound_transfer: &str, ) -> FluentRequest<'_, PostTreasuryOutboundTransfersOutboundTransferCancelRequest>

An OutboundTransfer can be canceled if the funds have not yet been paid out.

pub fn get_treasury_received_credits( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryReceivedCreditsRequest>

Returns a list of ReceivedCredits.

pub fn get_treasury_received_credits_id( &self, id: &str, ) -> FluentRequest<'_, GetTreasuryReceivedCreditsIdRequest>

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

pub fn get_treasury_received_debits( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryReceivedDebitsRequest>

Returns a list of ReceivedDebits.

pub fn get_treasury_received_debits_id( &self, id: &str, ) -> FluentRequest<'_, GetTreasuryReceivedDebitsIdRequest>

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

pub fn get_treasury_transaction_entries( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryTransactionEntriesRequest>

Retrieves a list of TransactionEntry objects.

pub fn get_treasury_transaction_entries_id( &self, id: &str, ) -> FluentRequest<'_, GetTreasuryTransactionEntriesIdRequest>

Retrieves a TransactionEntry object.

pub fn get_treasury_transactions( &self, financial_account: &str, ) -> FluentRequest<'_, GetTreasuryTransactionsRequest>

Retrieves a list of Transaction objects.

pub fn get_treasury_transactions_id( &self, id: &str, ) -> FluentRequest<'_, GetTreasuryTransactionsIdRequest>

Retrieves the details of an existing Transaction.

pub fn get_webhook_endpoints( &self, ) -> FluentRequest<'_, GetWebhookEndpointsRequest>

Returns a list of your webhook endpoints.

pub fn post_webhook_endpoints( &self, ) -> FluentRequest<'_, PostWebhookEndpointsRequest>

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

pub fn get_webhook_endpoints_webhook_endpoint( &self, webhook_endpoint: &str, ) -> FluentRequest<'_, GetWebhookEndpointsWebhookEndpointRequest>

Retrieves the webhook endpoint with the given ID.

pub fn post_webhook_endpoints_webhook_endpoint( &self, webhook_endpoint: &str, ) -> FluentRequest<'_, PostWebhookEndpointsWebhookEndpointRequest>

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

pub fn delete_webhook_endpoints_webhook_endpoint( &self, webhook_endpoint: &str, ) -> FluentRequest<'_, DeleteWebhookEndpointsWebhookEndpointRequest>

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.