Stripe.net

https://github.com/stripe/stripe-dotnet
Admin
The official Stripe .NET library provides a comprehensive way to integrate Stripe payments and...
Tokens:90,215
Snippets:531
Trust Score:9.7
License:Apache-2.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Setup Attempts

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Endpoint for retrieving setup attempts.

```APIDOC
## GET /v1/setup_attempts

### Description
Retrieves a list of setup attempts.

### Method
GET

### Endpoint
/v1/setup_attempts
```

--------------------------------

### Search customers usage example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Example of searching for customers using a query string, iterating over the results.

```csharp
var result = client.V1.Customers.Search(new CustomerSearchOptions { Query = "email:'foo@bar.com'" });
foreach (Customer customer in result) { /* ... */ }
```

--------------------------------

### Install Stripe.net with NuGet CLI

Source: https://github.com/stripe/stripe-dotnet/blob/master/README.md

Installs the Stripe.net package using the NuGet command-line interface.

```sh
nuget install Stripe.net
```

--------------------------------

### Get customer example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Retrieves a customer by ID using the synchronous Get method.

```csharp
var customer = client.V1.Customers.Get("cus_1234");
```

--------------------------------

### Setup Intents

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Endpoints for managing setup intents, including creating, retrieving, updating, canceling, confirming, and verifying microdeposits.

```APIDOC
## GET /v1/setup_intents

### Description
Retrieve a list of setup intents.

### Method
GET

### Endpoint
/v1/setup_intents

## GET /v1/setup_intents/{id}

### Description
Retrieve a specific setup intent by ID.

### Method
GET

### Endpoint
/v1/setup_intents/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the setup intent.

## POST /v1/setup_intents

### Description
Create a new setup intent.

### Method
POST

### Endpoint
/v1/setup_intents

## POST /v1/setup_intents/{id}

### Description
Update a setup intent.

### Method
POST

### Endpoint
/v1/setup_intents/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the setup intent.

## POST /v1/setup_intents/{id}/cancel

### Description
Cancel a setup intent.

### Method
POST

### Endpoint
/v1/setup_intents/{id}/cancel

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the setup intent.

## POST /v1/setup_intents/{id}/confirm

### Description
Confirm a setup intent.

### Method
POST

### Endpoint
/v1/setup_intents/{id}/confirm

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the setup intent.

## POST /v1/setup_intents/{id}/verify_microdeposits

### Description
Verify microdeposits for a setup intent.

### Method
POST

### Endpoint
/v1/setup_intents/{id}/verify_microdeposits

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the setup intent.
```

--------------------------------

### Install Stripe.net with Package Manager Console

Source: https://github.com/stripe/stripe-dotnet/blob/master/README.md

Installs the Stripe.net package from the Package Manager Console in Visual Studio.

```powershell
Install-Package Stripe.net
```

--------------------------------

### ListAutoPagingAsync usage example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Example of asynchronously iterating over all pages of customers using ListAutoPagingAsync.

```csharp
// All pages, async
await foreach (Customer customer in client.V1.Customers.ListAutoPagingAsync())
{
    Console.WriteLine(customer.Email);
}
```

--------------------------------

### Create StripeClient with API key and get customer

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-client.md

Creates a StripeClient with a secret API key and retrieves a customer using the V1 service. This is the simplest usage example.

```csharp
var client = new StripeClient("sk_test_...");
Customer customer = client.V1.Customers.Get("cus_1234");
```

--------------------------------

### Create customer example (sync)

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Creates a customer with email and name, then prints the new customer's ID. Uses the synchronous Create method.

```csharp
var options = new CustomerCreateOptions
{
    Email = "customer@example.com",
    Name = "Jenny Rosen",
};
var customer = client.V1.Customers.Create(options);
Console.WriteLine(customer.Id);
```

--------------------------------

### List customers with manual pagination

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Example of listing customers and manually paginating using the StartingAfter option to fetch the next page.

```csharp
var customers = client.V1.Customers.List();

string lastId = null;
foreach (Customer customer in customers)
{
    lastId = customer.Id;
}

customers = client.V1.Customers.List(new CustomerListOptions { StartingAfter = lastId }); // next page
```

--------------------------------

### Get and GetAsync method signatures

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Shows the synchronous and asynchronous Get method signatures for retrieving a customer by ID. The synchronous method GETs /v1/customers/{id}; the async variant accepts a cancellation token.

```csharp
public virtual Customer Get(string id, CustomerGetOptions options = null, RequestOptions requestOptions = null)
// GET /v1/customers/{id}

public virtual Task<Customer> GetAsync(string id, CustomerGetOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)
```

--------------------------------

### Delete customer usage example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Example of deleting a customer using the V1.Customers.Delete method with a customer ID and options.

```csharp
var deleted = client.V1.Customers.Delete("cus_123", new CustomerDeleteOptions());
```

--------------------------------

### Create a resource with CustomerCreateOptions

Source: https://github.com/stripe/stripe-dotnet/blob/master/README.md

Uses the Create method of the service class to create a new resource. The example sets the Email option to "customer@example.com" and instantiates a StripeClient with a test secret key.

```C#
var options = new CustomerCreateOptions
{
    Email = "customer@example.com"
};

var client = new StripeClient("sk_test_...");
Customer customer = client.V1.Customers.Create(options);
```

--------------------------------

### RawRequestAsync usage example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-client.md

Shows how to use RawRequestAsync with custom options including a base URL and additional headers.

```csharp
var options = new RawRequestOptions
{
    BaseUrl = "https://proxy.example.com",
    AdditionalHeaders = { { "X-Custom", "v1" } },
};
StripeResponse response = await client.RawRequestAsync(
    HttpMethod.Post, "/v1/whatever", "{...}", options);
```

--------------------------------

### Get / GetAsync

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Retrieves a customer by ID. Sends a GET request to /v1/customers/{id}. Returns the requested Customer.

```APIDOC
## GET /v1/customers/{id}

### Description
Retrieves a customer by ID.

### Method
GET

### Endpoint
/v1/customers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Customer ID; URL-encoded into the path.

#### Query Parameters
- **options** (CustomerGetOptions) - Optional - Retrieve parameters (supports `Expand`).
- **requestOptions** (RequestOptions) - Optional - Request modifiers.

### Request Example
```csharp
var customer = client.V1.Customers.Get("cus_1234");
```

### Response
#### Success Response (200)
- **Customer** - The requested Customer entity.

#### Response Example
```csharp
var customer = client.V1.Customers.Get("cus_1234");
```
```

--------------------------------

### Install Stripe.net with dotnet CLI

Source: https://github.com/stripe/stripe-dotnet/blob/master/README.md

Adds the Stripe.net package to a project using the .NET Core command-line interface.

```sh
dotnet add package Stripe.net
```

--------------------------------

### Using RequestOptions with a service method

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/request-options.md

Shows how to create a RequestOptions instance, set its properties, and pass it as the trailing argument to a service method (here, client.V1.Customers.Get). The example sets ApiKey, IdempotencyKey, and StripeAccount before making the call.

```csharp
var requestOptions = new RequestOptions();
requestOptions.ApiKey = "sk_test_...";
requestOptions.IdempotencyKey = "order-123-retry";
requestOptions.StripeAccount = "acct_123";

var customer = client.V1.Customers.Get("cus_123", null, requestOptions);
```

--------------------------------

### Deserialize<T> usage example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-client.md

Shows how to use Deserialize<T> with a raw response from RawRequestAsync to get a typed Account object.

```csharp
StripeResponse resp = await client.RawRequestAsync(HttpMethod.Get, "/v1/accounts/acc_123");
Account account = client.Deserialize<Account>(resp.Content);
```

--------------------------------

### Setting AppInfo for plugin identification

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Example of setting AppInfo with Name, Url, and Version for plugin identification.

```csharp
StripeConfiguration.AppInfo = new AppInfo
{
    Name = "MyAwesomePlugin",
    Url = "https://myawesomeplugin.info",
    Version = "1.2.34",
};
```

--------------------------------

### Search example with StripeSearchResult<T>

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/lists-and-search.md

Searches charges with a query and iterates the results, printing each charge amount. Demonstrates using the Search endpoint and iterating the result set.

```csharp
var result = client.V1.Charges.Search(new ChargeSearchOptions { Query = "amount>100" });
foreach (Charge charge in result) { Console.WriteLine(charge.Amount); }
```

--------------------------------

### Update customer example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Updates a customer's email using the synchronous Update method.

```csharp
var options = new CustomerUpdateOptions { Email = "updated-email@example.com" };
Customer customer = client.V1.Customers.Update("cus_123", options);
```

--------------------------------

### Create meter event session and stream example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/v2-api.md

Shows how to create a meter event session, use its AuthenticationToken as the API key for a new client, and then create a meter event stream with a single event. The session token is required for authentication when sending stream requests.

```csharp
var session = await new StripeClient(apiKey)
    .V2.Billing.MeterEventSession.CreateAsync(new MeterEventSessionCreateOptions());
// session.AuthenticationToken is the bearer credential; use a client built with it:
var client = new StripeClient(session.AuthenticationToken);
var options = new MeterEventStreamCreateOptions
{
    Events =
    [
        new MeterEventStreamCreateEventOptions
        {
            EventName = "alpaca_ai_tokens",
            Payload = { { "stripe_customer_id", customerId }, { "value", "25" } },
        },
    ],
};
client.V2.Billing.MeterEventStream.Create(options);
```

--------------------------------

### Using client.V2 to get an event

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-layer.md

Shows how to create a StripeClient and use the V2 Core Events service to retrieve an event asynchronously.

```csharp
var client = new StripeClient("sk_test_...");
var event = await client.V2.Core.Events.GetAsync("evt_123");
```

--------------------------------

### RequestOptions Class

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/request-options.md

RequestOptions class with properties and usage example.

```APIDOC
## RequestOptions Class

### Description
Per-request transport modifiers, accepted as the trailing `RequestOptions` argument of every service method.

### Properties
- **ApiKey** (string) - null - Overrides the client's API key for this request.
- **IdempotencyKey** (string) - null - User-supplied idempotency key. When absent, POST (and V2 DELETE) requests get a random `Guid`-based `Idempotency-Key` header.
- **StripeAccount** (string) - null - Connected account ID → `Stripe-Account` header (Connect authentication).
- **StripeContext** (string) - null - `Stripe-Context` header value (event filtering in V2 webhooks).
- **StripeRequestTrigger** (string) - null - `Stripe-Request-Trigger` header.

### Example
```csharp
var requestOptions = new RequestOptions();
requestOptions.ApiKey = "sk_test_...";
requestOptions.IdempotencyKey = "order-123-retry";
requestOptions.StripeAccount = "acct_123";

var customer = client.V1.Customers.Get("cus_123", null, requestOptions);
```
```

--------------------------------

### Get /v2/commerce/product_catalog/imports

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Lists product catalog imports.

```APIDOC
## GET /v2/commerce/product_catalog/imports

### Description
Lists product catalog imports.

### Method
GET

### Endpoint
/v2/commerce/product_catalog/imports
```

--------------------------------

### Get /v2/core/accounts

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Lists accounts.

```APIDOC
## GET /v2/core/accounts

### Description
Lists accounts.

### Method
GET

### Endpoint
/v2/core/accounts
```

--------------------------------

### StripeConfiguration.StripeNetVersion

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets the version of the library, initialized to Stripe.Version.Current (53.0.0).

```APIDOC
## GET StripeConfiguration.StripeNetVersion

### Description
Gets the version of the library, initialized to `Stripe.Version.Current` (`53.0.0`).

### Method
GET

### Endpoint
StripeConfiguration.StripeNetVersion (static property)

### Parameters
None

### Response
#### Success Response (200)
- **value** (string) - The library version.

#### Response Example
```
"53.0.0"
```
```

--------------------------------

### Search, SearchAsync, SearchAutoPaging, SearchAutoPagingAsync method signatures

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Shows the method signatures for Search, SearchAsync, SearchAutoPaging, and SearchAutoPagingAsync. The endpoint is GET /v1/customers/search.

```csharp
public virtual StripeSearchResult<Customer> Search(CustomerSearchOptions options = null, RequestOptions requestOptions = null)
// GET /v1/customers/search

public virtual Task<StripeSearchResult<Customer>> SearchAsync(CustomerSearchOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

public virtual IEnumerable<Customer> SearchAutoPaging(CustomerSearchOptions options = null, RequestOptions requestOptions = null)

public virtual IAsyncEnumerable<Customer> SearchAutoPagingAsync(CustomerSearchOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)
```

--------------------------------

### StripeConfiguration.SerializerOptions

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets or sets System.Text.Json options used for (de)serialization of all entities.

```APIDOC
## GET/SET StripeConfiguration.SerializerOptions

### Description
Gets or sets System.Text.Json options used for (de)serialization of all entities.

### Method
GET / SET

### Endpoint
StripeConfiguration.SerializerOptions (static property)

### Parameters
#### Set Value
- **value** (JsonSerializerOptions) - The serialization options to use.

### Response
#### Success Response (200)
- **value** (JsonSerializerOptions) - The current serialization options.

#### Response Example
```
{
  "PropertyNamingPolicy": "CamelCase"
}
```
```

--------------------------------

### StripeConfiguration.SerializerSettings (obsolete)

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets or sets Newtonsoft-style serialization settings. Obsolete; use SerializerOptions instead.

```APIDOC
## GET/SET StripeConfiguration.SerializerSettings (obsolete)

### Description
Gets or sets Newtonsoft-style serialization settings. This property is obsolete and will be removed in a future major version. Changing these is discouraged; if changed, `StripeObjectConverter` must remain among the converters or polymorphic resources break.

### Method
GET / SET

### Endpoint
StripeConfiguration.SerializerSettings (static property)

### Parameters
#### Set Value
- **value** (JsonSerializerSettings) - The serialization settings to use.

### Response
#### Success Response (200)
- **value** (JsonSerializerSettings) - The current serialization settings.

#### Response Example
```
{
  "Converters": ["StripeObjectConverter"]
}
```
```

--------------------------------

### StripeConfiguration.StripeClient

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets or sets the default client used by standalone service instances. Built lazily from current configuration.

```APIDOC
## GET/SET StripeConfiguration.StripeClient

### Description
Gets or sets the default client used by standalone service instances. Built lazily from the current `ApiKey`/`ClientId`/`MaxNetworkRetries`/`AppInfo`/`EnableTelemetry`; assigning a custom `StripeClient` (e.g. with a custom `SystemNetHttpClient` for proxies) replaces it.

### Method
GET / SET

### Endpoint
StripeConfiguration.StripeClient (static property)

### Parameters
#### Set Value
- **value** (IStripeClient) - The client to use as the default.

### Response
#### Success Response (200)
- **value** (IStripeClient) - The current default client.

#### Response Example
```
IStripeClient instance
```
```

--------------------------------

### StringEnum subclass example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/request-options.md

Shows how to define a custom StringEnum subclass with static readonly singleton instances and a private constructor. Used instead of native enums when a parameter must interoperate with primitives.

```csharp
public class FooBar : StringEnum
{
    public static readonly FooBar Foo = new FooBar("foo");
    public static readonly FooBar Bar = new FooBar("bar");
    private FooBar(string value) : base(value) {}
}
```

--------------------------------

### Create a customer with CustomerCreateOptions

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Shows how to instantiate CustomerCreateOptions with email, metadata, and shipping address, then call client.V1.Customers.Create(options).

```csharp
var options = new CustomerCreateOptions
{
    Email = "jenny.rosen@example.com",
    Metadata = { { "order", "1234" } },
    Shipping = new ShippingOptions
    {
        Name = "Jenny Rosen",
        Address = new AddressOptions { Line1 = "123 Main St", City = "SFO", Country = "US" },
    },
};
var customer = client.V1.Customers.Create(options);
```

--------------------------------

### Send custom request with RawRequestAsync and deserialize response

Source: https://github.com/stripe/stripe-dotnet/blob/master/README.md

Use RawRequestAsync on StripeClient to call an undocumented API endpoint or bypass library method definitions. The example sends a GET to /v1/accounts/acc_123 and optionally deserializes the response content into a strongly-typed Account object via Deserialize.

```C#
StripeClient client = new StripeClient();
StripeResponse response = await client.RawRequestAsync(HttpMethod.Get, "/v1/accounts/acc_123");

// Optionally use Deserialize to convert the response to strongly-typed object.
Account account = client.Deserialize<Account>(response.Content)
```

--------------------------------

### ConstructEvent in a web framework route

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/events.md

Example of using EventUtility.ConstructEvent to verify and parse a webhook payload in a web framework route. It catches StripeException for signature mismatch, timestamp out of tolerance, or API version mismatch and returns HTTP 400.

```csharp
// In a web framework route:
String payload = requestBody; // raw body string
String sigHeader = request.GetHeader("Stripe-Signature");
try
{
    Event event = EventUtility.ConstructEvent(payload, sigHeader, "whsec_...");
    switch (event.Type) { /* handle */ }
}
catch (StripeException e)
{
    // signature mismatch, timestamp out of tolerance, or API version mismatch
    return 400;
}
```

--------------------------------

### Using StripeClient vs Global Configuration pattern

Source: https://github.com/stripe/stripe-dotnet/blob/master/README.md

Shows the recommended StripeClient pattern and the legacy global configuration pattern for accessing Stripe services. The legacy pattern continues to be supported.

```C#
// StripeClient pattern (Recommended)
var client = new StripeClient("sk_test_...");
Customer customer = client.V1.Customers.Get("cus_1234");

// Global Configuration pattern (Legacy)
StripeConfiguration.ApiKey = "sk_test_...";
var service = new CustomerService();
Customer customer = service.Get("cus_1234");
```

--------------------------------

### EventService class definition

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/v2-api.md

Defines the EventService class with methods for retrieving, listing, and auto-paging events. The Get method uses GET /v2/core/events/{id}, List uses GET /v2/core/events. EventListOptions and EventListCreatedOptions filter events by Type, Context, or Created. The returned Event exposes RelatedObjects and can fetch related data.

```csharp
public class EventService : Service
{
    public virtual Event Get(string id, EventGetOptions options = null, RequestOptions requestOptions = null);      // GET /v2/core/events/{id}
    public virtual Task<Event> GetAsync(...);
    public virtual V2.StripeList<Event> List(EventListOptions options = null, RequestOptions requestOptions = null);  // GET /v2/core/events
    public virtual Task<V2.StripeList<Event>> ListAsync(...);
    public virtual IEnumerable<Event> ListAutoPaging(...);
    public virtual IAsyncEnumerable<Event> ListAutoPagingAsync(...);
}
```

--------------------------------

### Get /v2/core/event_destinations

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Lists event destinations.

```APIDOC
## GET /v2/core/event_destinations

### Description
Lists event destinations.

### Method
GET

### Endpoint
/v2/core/event_destinations
```

--------------------------------

### Standalone Service Usage (Legacy)

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-layer.md

Every service can be instantiated directly and configured via StripeConfiguration. This shows how to create a service and call methods.

```APIDOC
## Standalone Service Usage (Legacy)

### Description
Every service can be instantiated directly and configured via `StripeConfiguration`. A service bound to a client keeps using that client regardless of later `StripeConfiguration` changes.

### Constructors
- `public CustomerService()`
- `public CustomerService(IStripeClient client)`
- `internal CustomerService(ApiRequestor)` (used by registries)

### Usage Example
```csharp
StripeConfiguration.ApiKey = "sk_test_...";
var service = new CustomerService();
Customer customer = service.Get("cus_1234");
```
```

--------------------------------

### Create and CreateAsync method signatures

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Shows the synchronous and asynchronous Create method signatures for creating a customer. The synchronous method posts to /v1/customers; the async variant accepts a cancellation token.

```csharp
public virtual Customer Create(CustomerCreateOptions options, RequestOptions requestOptions = null)
// POST /v1/customers

public virtual Task<Customer> CreateAsync(CustomerCreateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)
```

--------------------------------

### Get /v2/core/accounts/{id}

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Retrieves an account by ID.

```APIDOC
## GET /v2/core/accounts/{id}

### Description
Retrieves an account by ID.

### Method
GET

### Endpoint
/v2/core/accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the account to retrieve.
```

--------------------------------

### Get /v2/core/event_destinations/{id}

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Retrieves an event destination by ID.

```APIDOC
## GET /v2/core/event_destinations/{id}

### Description
Retrieves an event destination by ID.

### Method
GET

### Endpoint
/v2/core/event_destinations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the event destination to retrieve.
```

--------------------------------

### Create / CreateAsync

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Creates a new customer. Sends a POST request to /v1/customers. Returns the newly created Customer entity.

```APIDOC
## POST /v1/customers

### Description
Creates a new customer.

### Method
POST

### Endpoint
/v1/customers

### Parameters
#### Request Body
- **options** (CustomerCreateOptions) - Required - Customer creation parameters.
- **requestOptions** (RequestOptions) - Optional - Per-request modifiers.
- **cancellationToken** (CancellationToken) - Optional - Cancellation for the async variant.

### Request Example
```csharp
var options = new CustomerCreateOptions
{
    Email = "customer@example.com",
    Name = "Jenny Rosen",
};
var customer = client.V1.Customers.Create(options);
Console.WriteLine(customer.Id);
```

### Response
#### Success Response (200)
- **Customer** - The newly created Customer entity.

#### Response Example
```csharp
var customer = client.V1.Customers.Create(options);
```

### Error Handling
Throws `StripeException` on API errors.
```

--------------------------------

### GET /v2/core/account_tokens/{id}

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/v2-api.md

Retrieves an account token by ID.

```APIDOC
## GET /v2/core/account_tokens/{id}

### Description
Retrieves an account token by ID.

### Method
GET

### Endpoint
/v2/core/account_tokens/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the account token to retrieve.

### Response
#### Success Response (200)
- **AccountToken** (object) - The account token.

```

--------------------------------

### StripeConfiguration.AppInfo

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Sets plugin identification appended to the User-Agent/X-Stripe-Client-User-Agent headers. Throws ArgumentException if Name is empty.

```APIDOC
## SET StripeConfiguration.AppInfo

### Description
Sets plugin identification appended to the `User-Agent`/`X-Stripe-Client-User-Agent` headers. **Throws** `ArgumentException("AppInfo.Name cannot be empty")` if `AppInfo.Name` is null/empty.

### Method
SET

### Endpoint
StripeConfiguration.AppInfo (static property)

### Parameters
#### Set Value
- **value** (AppInfo) - The plugin information. Must have a non-empty `Name`.

### Request Example
```csharp
StripeConfiguration.AppInfo = new AppInfo
{
    Name = "MyAwesomePlugin",
    Url = "https://myawesomeplugin.info",
    Version = "1.2.34",
};
```

### Response
#### Success Response (200)
No return value.

#### Error Response
- **ArgumentException** - Thrown if `AppInfo.Name` is null or empty.
```

--------------------------------

### Apps Endpoints

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Endpoints for managing app installs and secrets.

```APIDOC
## GET /v1/apps/installs

### Description
Retrieves a list of app installs.

### Method
GET

### Endpoint
/v1/apps/installs

## GET /v1/apps/installs/{id}

### Description
Retrieves a specific app install by ID.

### Method
GET

### Endpoint
/v1/apps/installs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the app install.

## GET /v1/apps/secrets

### Description
Retrieves a list of app secrets.

### Method
GET

### Endpoint
/v1/apps/secrets

## GET /v1/apps/secrets/find

### Description
Finds an app secret.

### Method
GET

### Endpoint
/v1/apps/secrets/find

## POST /v1/apps/installs

### Description
Creates a new app install.

### Method
POST

### Endpoint
/v1/apps/installs

## POST /v1/apps/installs/{id}

### Description
Updates an app install.

### Method
POST

### Endpoint
/v1/apps/installs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the app install.

## POST /v1/apps/installs/{id}/uninstall

### Description
Uninstalls an app.

### Method
POST

### Endpoint
/v1/apps/installs/{id}/uninstall

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the app install.

## POST /v1/apps/secrets

### Description
Creates a new app secret.

### Method
POST

### Endpoint
/v1/apps/secrets

## POST /v1/apps/secrets/delete

### Description
Deletes an app secret.

### Method
POST

### Endpoint
/v1/apps/secrets/delete

```

--------------------------------

### Create StripeClient with options and set Stripe-Account header

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-client.md

Creates a StripeClient using StripeClientOptions with an API key, client ID, and connected account. All requests from this client send the Stripe-Account header, as shown by the charge retrieval.

```csharp
var options = new StripeClientOptions
{
    ApiKey = "sk_test_...",
    ClientId = "ca_...",
    StripeAccount = "acct_connected",
};
var client = new StripeClient(options);
// All requests from this client send the Stripe-Account header.
var charge = client.V1.Charges.Get("ch_123");
```

--------------------------------

### Get /v2/core/accounts/{id}/persons

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Lists persons associated with an account.

```APIDOC
## GET /v2/core/accounts/{id}/persons

### Description
Lists persons associated with an account.

### Method
GET

### Endpoint
/v2/core/accounts/{id}/persons

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the account.
```

--------------------------------

### Get /v2/core/accounts/{parentId}/persons/{id}

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Retrieves a person associated with an account.

```APIDOC
## GET /v2/core/accounts/{parentId}/persons/{id}

### Description
Retrieves a person associated with an account.

### Method
GET

### Endpoint
/v2/core/accounts/{parentId}/persons/{id}

### Parameters
#### Path Parameters
- **parentId** (string) - Required - The ID of the parent account.
- **id** (string) - Required - The ID of the person to retrieve.
```

--------------------------------

### List, ListAsync, ListAutoPaging, ListAutoPagingAsync method signatures

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Shows the method signatures for List, ListAsync, ListAutoPaging, and ListAutoPagingAsync. List and ListAsync return a single StripeList<Customer> page, while the auto-paging variants lazily iterate all pages.

```csharp
public virtual StripeList<Customer> List(CustomerListOptions options = null, RequestOptions requestOptions = null)
// GET /v1/customers

public virtual Task<StripeList<Customer>> ListAsync(CustomerListOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

public virtual IEnumerable<Customer> ListAutoPaging(CustomerListOptions options = null, RequestOptions requestOptions = null)

public virtual IAsyncEnumerable<Customer> ListAutoPagingAsync(CustomerListOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)
```

--------------------------------

### Get /v2/core/accounts/{parentId}/person_tokens/{id}

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Retrieves a person token for an account.

```APIDOC
## GET /v2/core/accounts/{parentId}/person_tokens/{id}

### Description
Retrieves a person token for an account.

### Method
GET

### Endpoint
/v2/core/accounts/{parentId}/person_tokens/{id}

### Parameters
#### Path Parameters
- **parentId** (string) - Required - The ID of the parent account.
- **id** (string) - Required - The ID of the person token to retrieve.
```

--------------------------------

### StripeConfiguration.EnableTelemetry

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets or sets whether request-latency/feature telemetry is sent to Stripe. Defaults to true.

```APIDOC
## GET/SET StripeConfiguration.EnableTelemetry

### Description
Gets or sets whether request-latency/feature telemetry is sent to Stripe. Defaults to `true`.

### Method
GET / SET

### Endpoint
StripeConfiguration.EnableTelemetry (static property)

### Parameters
#### Set Value
- **value** (bool) - Whether telemetry is enabled.

### Response
#### Success Response (200)
- **value** (bool) - The current telemetry setting.

#### Response Example
```
true
```
```

--------------------------------

### StripeClient(string apiKey, ...)

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-client.md

Constructor for creating a StripeClient with an API key and optional configuration parameters.

```APIDOC
## StripeClient(string apiKey, ...)

### Description
Creates a new StripeClient instance with the given API key and optional configuration parameters. This is the primary entry point for the Stripe.net library.

### Method
Constructor

### Signature
```csharp
public StripeClient(
    string apiKey = null,
    string clientId = null,
    IHttpClient httpClient = null,
    string apiBase = null,
    string connectBase = null,
    string filesBase = null,
    string meterEventsBase = null)
```

### Parameters
- **apiKey** (string) - Optional - Secret API key used for `Authorization: Bearer <apiKey>` on every request.
- **clientId** (string) - Optional - Client ID used in OAuth requests (falls back to `StripeConfiguration.ClientId`).
- **httpClient** (IHttpClient) - Optional - Custom HTTP client; when null an HTTP client is created with default parameters.
- **apiBase** (string) - Optional - Stripe API base URL; defaults to `https://api.stripe.com`.
- **connectBase** (string) - Optional - OAuth API base URL; defaults to `https://connect.stripe.com`.
- **filesBase** (string) - Optional - Files API base URL; defaults to `https://files.stripe.com`.
- **meterEventsBase** (string) - Optional - Meter Events API base URL; defaults to `https://meter-events.stripe.com`.

### Throws
- `ArgumentNullException` if `apiKey` is null.
- `ArgumentException` if `apiKey` is empty or contains whitespace.

### Example
```csharp
var client = new StripeClient("sk_test_...");
Customer customer = client.V1.Customers.Get("cus_1234");
```

### Example with Custom HTTP Client
```csharp
var customHttp = new SystemNetHttpClient(
    new System.Net.Http.HttpClient { Timeout = TimeSpan.FromSeconds(120) },
    maxNetworkRetries: 5);
var client = new StripeClient("sk_test_...", httpClient: customHttp);
try
{
    var c = client.V1.Customers.Get("cus_1234");
}
catch (StripeException e)
{
    Console.WriteLine($"HTTP {e.HttpStatusCode}: {e.StripeError?.Message}");
}
```
```

--------------------------------

### StripeConfiguration.MaxNetworkRetries

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets or sets the maximum number of retries for intermittent failures. Default is 2.

```APIDOC
## GET/SET StripeConfiguration.MaxNetworkRetries

### Description
Gets or sets the maximum number of retries for intermittent failures. Default is `SystemNetHttpClient.DefaultMaxNumberRetries`, i.e. **2**. Set to 0 to disable retries.

### Method
GET / SET

### Endpoint
StripeConfiguration.MaxNetworkRetries (static property)

### Parameters
#### Set Value
- **value** (int) - The maximum number of retries.

### Response
#### Success Response (200)
- **value** (int) - The current maximum number of retries.

#### Response Example
```
2
```
```

--------------------------------

### POST /v2/core/account_links

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/v2-api.md

Creates an account link for onboarding or update use cases.

```APIDOC
## POST /v2/core/account_links

### Description
Creates an account link for onboarding or update use cases.

### Method
POST

### Endpoint
/v2/core/account_links

### Parameters
#### Request Body
- **use_case** (enum) - Required - The use case for the account link (onboarding or update).

### Response
#### Success Response (200)
- **AccountLink** (object) - The created account link.

```

--------------------------------

### Create customer with extra param and idempotency key (async)

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Creates a customer asynchronously with an extra parameter and a custom idempotency key. Catches StripeException and prints the HTTP status code, error code, and message.

```csharp
var options = new CustomerCreateOptions { Email = "customer@example.com" };
options.AddExtraParam("secret_feature_enabled", "true");
try
{
    var customer = await client.V1.Customers.CreateAsync(
        options,
        new RequestOptions { IdempotencyKey = "create-customer-42" });
}
catch (StripeException e)
{
    Console.WriteLine($"{e.HttpStatusCode} {e.StripeError?.Code}: {e.StripeError?.Message}");
}
```

--------------------------------

### Get Import

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/v2-api.md

Retrieves a specific product catalog import by ID. Returns the V2.Commerce.ProductCatalogImport object.

```APIDOC
## GET /v2/commerce/product_catalog/imports/{id}

### Description
Retrieves a specific product catalog import by ID.

### Method
GET

### Endpoint
/v2/commerce/product_catalog/imports/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the import to retrieve.

#### Query Parameters
- **options** (ImportGetOptions) - Optional - Additional options for the request.

### Request Example
```csharp
var service = new ImportService();
var import = service.Get("import_123");
```

### Response
#### Success Response (200)
- **V2.Commerce.ProductCatalogImport** - The retrieved import object.

#### Response Example
```json
{
  "id": "import_123",
  "object": "product_catalog_import",
  ...
}
```
```

--------------------------------

### Manual pagination with StripeList<T> (V1)

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/lists-and-search.md

Shows manual pagination using HasMore and StartingAfter. Iterates the current page, then fetches the next page using the last customer's ID. This is an alternative to auto-pagination.

```csharp
var page = client.V1.Customers.List(new CustomerListOptions { Limit = 100 });
while (page.HasMore)
{
    foreach (Customer customer in page) { /* ... */ }
    page = client.V1.Customers.List(new CustomerListOptions { StartingAfter = page.Data.Last().Id });
}
```

--------------------------------

### Post /v2/core/accounts

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/endpoints.md

Creates an account.

```APIDOC
## POST /v2/core/accounts

### Description
Creates an account.

### Method
POST

### Endpoint
/v2/core/accounts
```

--------------------------------

### StripeConfiguration.ClientId

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets or sets the client ID for OAuth requests. Falls back to the 'StripeClientId' AppSettings key.

```APIDOC
## GET/SET StripeConfiguration.ClientId

### Description
Gets or sets the client ID for OAuth requests. Falls back to the `StripeClientId` AppSettings key.

### Method
GET / SET

### Endpoint
StripeConfiguration.ClientId (static property)

### Parameters
#### Set Value
- **value** (string) - The client ID to set.

### Response
#### Success Response (200)
- **value** (string) - The current client ID.

#### Response Example
```
"ca_..."
```
```

--------------------------------

### AppInfo property

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Sets plugin identification appended to User-Agent headers. Throws ArgumentException if AppInfo.Name is empty.

```csharp
public static AppInfo AppInfo
{
    internal get => appInfo;
    set { /* throws ArgumentException if Name is empty */ }
}
```

--------------------------------

### StripeConfiguration.MajorApiVersion

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets the release-train name of the Stripe API version, e.g., 'endive'. Empty in preview builds.

```APIDOC
## GET StripeConfiguration.MajorApiVersion

### Description
Gets the release-train name of the Stripe API version, e.g., `endive`. Empty in preview builds.

### Method
GET

### Endpoint
StripeConfiguration.MajorApiVersion (static property)

### Parameters
None

### Response
#### Success Response (200)
- **value** (string) - The release-train name, e.g., `endive`.

#### Response Example
```
"endive"
```
```

--------------------------------

### Standalone service usage with StripeConfiguration

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-layer.md

Demonstrates legacy standalone usage: set the API key via StripeConfiguration and instantiate a service directly to call methods.

```csharp
StripeConfiguration.ApiKey = "sk_test_...";
var service = new CustomerService();
Customer customer = service.Get("cus_1234");
```

--------------------------------

### StripeConfiguration.ApiVersion

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-configuration.md

Gets the pinned Stripe API version that the SDK uses, sent in the Stripe-Version request header.

```APIDOC
## GET StripeConfiguration.ApiVersion

### Description
Gets the pinned Stripe API version that the SDK uses. This value is sent in the `Stripe-Version` request header.

### Method
GET

### Endpoint
StripeConfiguration.ApiVersion (static property)

### Parameters
None

### Response
#### Success Response (200)
- **value** (string) - The API version string, e.g., `2026-09-30.endive`.

#### Response Example
```
"2026-09-30.endive"
```
```

--------------------------------

### List / ListAsync / ListAutoPaging / ListAutoPagingAsync

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/service-customers.md

Lists customers. List and ListAsync return a single page of results, while ListAutoPaging variants lazily iterate all pages.

```APIDOC
## GET /v1/customers

### Description
Lists customers. List and ListAsync return a single StripeList<Customer> page, while ListAutoPaging variants lazily iterate all pages.

### Method
GET

### Endpoint
/v1/customers

### Parameters
#### Query Parameters
- **options** (CustomerListOptions) - Optional - Options for listing customers, such as pagination.
- **requestOptions** (RequestOptions) - Optional - Request options for the API call.

### Request Example
```csharp
var customers = client.V1.Customers.List();

string lastId = null;
foreach (Customer customer in customers)
{
    lastId = customer.Id;
}

customers = client.V1.Customers.List(new CustomerListOptions { StartingAfter = lastId }); // next page
```

```csharp
// All pages, async
await foreach (Customer customer in client.V1.Customers.ListAutoPagingAsync())
{
    Console.WriteLine(customer.Email);
}
```

### Response
#### Success Response (200)
- **StripeList<Customer>** - A page of customers.

#### Response Example
```json
{
  "object": "list",
  "data": [
    {
      "id": "cus_123",
      "email": "foo@bar.com"
    }
  ],
  "has_more": false
}
```
```

--------------------------------

### StripeClient constructor with StripeClientOptions

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-client.md

Defines the constructor that accepts a StripeClientOptions object. It delegates to the LiveApiRequestor with the provided options and the StripeClientUsage.

```csharp
public StripeClient(StripeClientOptions options)
    : this(new LiveApiRequestor(options, StripeClientUsage))
```

--------------------------------

### GET /v2/core/events

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/v2-api.md

Lists events, optionally filtered by EventListOptions or EventListCreatedOptions (e.g., by Type, Context, Created).

```APIDOC
## GET /v2/core/events

### Description
Lists events, optionally filtered by EventListOptions or EventListCreatedOptions (e.g., by Type, Context, Created).

### Method
GET

### Endpoint
/v2/core/events

### Parameters
#### Query Parameters
- **type** (string) - Optional - Filter by event type.
- **context** (string) - Optional - Filter by event context.
- **created** (object) - Optional - Filter by creation time.

### Response
#### Success Response (200)
- **V2.StripeList<Event>** (array) - A list of events.

```

--------------------------------

### Using AddExtraParam on CustomerCreateOptions

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/request-options.md

Shows how to add extra parameters to a CustomerCreateOptions instance, including a beta feature flag and a nested parameter.

```csharp
var options = new CustomerCreateOptions { Email = "jenny@example.com" };
options.AddExtraParam("secret_feature_enabled", "true");
options.AddExtraParam("secret_parameter[primary]", "primary value");
```

--------------------------------

### StripeClient(StripeClientOptions options)

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-client.md

Constructor for creating a StripeClient using a StripeClientOptions object for full configuration.

```APIDOC
## StripeClient(StripeClientOptions options)

### Description
Creates a new StripeClient instance using a StripeClientOptions object for full client configuration.

### Method
Constructor

### Signature
```csharp
public StripeClient(StripeClientOptions options)
    : this(new LiveApiRequestor(options, StripeClientUsage))
```

### Parameters
- **options** (StripeClientOptions) - Required - Full client configuration object.

### Example
```csharp
var options = new StripeClientOptions
{
    ApiKey = "sk_test_...",
    ClientId = "ca_...",
    StripeAccount = "acct_connected",
};
var client = new StripeClient(options);
// All requests from this client send the Stripe-Account header.
var charge = client.V1.Charges.Get("ch_123");
```
```

--------------------------------

### SystemNetHttpClient Constructor

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/http-client.md

Initializes a new instance of the SystemNetHttpClient class, which is the default IHttpClient implementation. Allows customization of the underlying HTTP client, retry count, app info, and telemetry.

```APIDOC
## SystemNetHttpClient Constructor

### Description
Initializes a new instance of the SystemNetHttpClient class, which is the default IHttpClient implementation. Allows customization of the underlying HTTP client, retry count, app info, and telemetry.

### Method
Constructor

### Signature
public SystemNetHttpClient(System.Net.Http.HttpClient httpClient = null, int maxNetworkRetries = DefaultMaxNumberRetries, AppInfo appInfo = null, bool enableTelemetry = true)

### Parameters
- **httpClient** (System.Net.Http.HttpClient) - Optional - Underlying HTTP client. Default is null (shared lazy default with 80 s timeout).
- **maxNetworkRetries** (int) - Optional - Retries on intermittent failures. Default is 2.
- **appInfo** (AppInfo) - Optional - Plugin identification appended to User-Agent. Default is null.
- **enableTelemetry** (bool) - Optional - Request latency/feature telemetry. Default is true.

### Example
```csharp
var stripeClient = new StripeClient(
    "sk_test_...",
    httpClient: new SystemNetHttpClient(
        new System.Net.Http.HttpClient
        {
            Timeout = TimeSpan.FromSeconds(120),
            // e.g. Proxy = ...
        },
        maxNetworkRetries: 0));
```
```

--------------------------------

### ParseEventNotification usage example

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/stripe-client.md

Shows how to parse an event notification with signature verification using the Stripe-Signature header and a webhook secret.

```csharp
EventNotification en = client.ParseEventNotification(
    body, request.headers["Stripe-Signature"], "whsec_...");
```

--------------------------------

### Retrieve customer and access fields

Source: https://github.com/stripe/stripe-dotnet/blob/master/_autodocs/api-reference/entities.md

Shows how to retrieve a customer by ID and access its Email property. Also demonstrates accessing undocumented/beta response fields via the raw JSON tree using RawJsonElement.

```csharp
var customer = client.V1.Customers.Get("cus_1234");
Console.WriteLine(customer.Email);

// Undocumented/beta response fields are reachable via the raw JSON tree
var secret = customer.RawJsonElement?["secret_parameter"]?["primary"];
```
Tokens:
Raw