Stripe.net
The official Stripe .NET library, supporting .NET Standard 1.2+, .NET Core 1.0+, and .NET Framework 4.5+.
Installation
Using the .NET Core command-line interface (CLI) tools:
dotnet add package Stripe.net
Using the NuGet Command Line Interface (CLI):
nuget install Stripe.net
Using the Package Manager Console:
Install-Package Stripe.net
From within Visual Studio:
- Open the Solution Explorer.
- Right-click on a project within your solution.
- Click on Manage NuGet Packages...
- Click on the Browse tab and search for "Stripe.net".
- Click on the Stripe.net package, select the appropriate version in the
right-tab and click Install.
Documentation
For a comprehensive list of examples, check out the API
documentation.
Usage
Per-request configuration
All of the service methods accept an optional RequestOptions object. This is
used if you want to set an idempotency key, if you are
using Stripe Connect, or if you want to pass the secret API
key on each method.
var requestOptions = new RequestOptions();
requestOptions.ApiKey = "SECRET API KEY";
requestOptions.IdempotencyKey = "SOME STRING";
requestOptions.StripeAccount = "CONNECTED ACCOUNT ID";
Using a custom HttpClient
You can configure the library with your own custom HttpClient:
StripeConfiguration.StripeClient = new StripeClient(
apiKey,
httpClient: new SystemNetHttpClient(httpClient));
Please refer to the Advanced client usage wiki page
to see more examples of using custom clients, e.g. for using a proxy server, a
custom message handler, etc.
Configuring automatic retries
The library can be configured to automatically retry requests that fail due to
an intermittent network problem or other knowingly non-deterministic errors:
StripeConfiguration.MaxNetworkRetries = 2;
Idempotency keys are added to requests to guarantee that
retries are safe.
Writing a plugin
If you're writing a plugin that uses the library, we'd appreciate it if you
identified using StripeConfiguration.AppInfo:
StripeConfiguration.AppInfo = new AppInfo
{
Name = "MyAwesomePlugin",
Url = "https://myawesomeplugin.info",
Version = "1.2.34",
};
This information is passed along when the library makes calls to the Stripe
API. Note that while Name is always required, Url and Version are
optional.
Development
The test suite depends on stripe-mock, so make sure to fetch
and run it from a background terminal
(stripe-mock's README also contains instructions for
installing via Homebrew and other methods):
go get -u github.com/stripe/stripe-mock
stripe-mock
Run all tests from the src/StripeTests directory:
dotnet test
Run some tests, filtering by name:
dotnet test --filter FullyQualifiedName~InvoiceServiceTest
Run tests for a single target framework:
dotnet test --framework netcoreapp2.1
For any requests, bug or comments, please open an issue or submit a
pull request.