Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Configuration for a Stripe client.

This builder allows customizing request behavior, headers sent to Stripe, and endpoint targeted. Some defaults can be overridden on a per-request basis.

Implementations

impl ClientBuilder

pub fn new(secret: impl Into<String>) -> Self

Create a new ClientBuilder with the given secret key.

pub fn client_id(self, client_id: ApplicationId) -> Self

Set the Stripe client id for the client. This will be sent to stripe with the “client-id” header.

pub fn account_id(self, account_id: AccountId) -> Self

Set the default Stripe account id used for the client. This will be sent to stripe with the “stripe-account” header, unless it is overridden when customizing a request.

pub fn request_strategy(self, strategy: RequestStrategy) -> Self

Set the default RequestStrategy used when making requests.

pub fn url(self, url: impl Into<String>) -> Self

Create a new client pointed at a specific URL. This is useful for testing.

pub fn app_info( self, name: impl Into<String>, version: Option<String>, url: Option<String>, ) -> Self

Set the application info for the client.

It is recommended that applications set this so that Stripe is able to understand usage patterns from your user agent.

pub fn build(self) -> Result<Client, StripeError>

Builds a Stripe client.

Errors

This method errors if any of the specified configuration is invalid.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.