StripeManaged

https://hexdocs.pm/stripe_managed/0.1.0/
Admin
An Elixir client for Stripe Managed Payments that enables selling digital products with Stripe as...
Tokens:10,384
Snippets:177
Trust Score:9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Create a Product and Checkout Session

Source: https://hexdocs.pm/stripe_managed/0.1.0/readme.md

Quick start example demonstrating how to create a product with a monthly price and then initiate a checkout session with managed payments enabled. Remember to redirect the customer to the `session.url`.

```elixir
# Create a product with a monthly price
{:ok, product} = StripeManaged.Product.create(%{
  name: "Pro Plan",
  tax_code: "txcd_10103001",
  default_price_data: %{
    unit_amount: 2900,
    currency: "usd",
    recurring: %{interval: "month"}
  }
})

# Start a checkout session (Stripe as merchant of record)
{:ok, session} = StripeManaged.CheckoutSession.create(%{
  line_items: [%{price: product.default_price, quantity: 1}],
  mode: "subscription",
  managed_payments: %{enabled: true},
  success_url: "https://yourapp.com/success"
})

# Redirect customer to session.url
```

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

### get

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Performs a GET request to the Stripe API. It takes a path and a keyword list of options.

```APIDOC
## get

### Description
Performs a GET request.

### Method
GET

### Endpoint
[ENDPOINT]

### Parameters
#### Path Parameters
- **path** (String.t()) - Required - The path for the GET request.

#### Query Parameters
- **options** (keyword()) - Optional - A keyword list of options for the request.

### Response
#### Success Response (200)
- **response** (:ok | {:error, StripeManaged.Error.t()}) - The result of the operation, either success or error.
```

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

### Get Tax Code for Software (Business Use)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the specific tax code for software products intended for business use.

```elixir
StripeManaged.TaxCode.software_business()
```

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

### Get Tax Code for Software (Personal Use)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the specific tax code for software products intended for personal use.

```elixir
StripeManaged.TaxCode.software_personal()
```

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

### Get Tax Code for SaaS (Business Use)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the specific tax code for SaaS products intended for business use.

```elixir
StripeManaged.TaxCode.saas_business()
```

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

### Configure StripeManaged Client

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.md

Configure the StripeManaged client with your API key, API version, and webhook secret. This setup is required before using the client's functionalities.

```elixir
config :stripe_managed,
  api_key: "sk_test_...",
  api_version: "2025-03-31.basil",
  webhook_secret: "whsec_..."
```

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

### Get description for a tax code

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the description for a given tax code.

```APIDOC
## `description`

### Description

Retrieves the description associated with a specific tax code.

### Parameters

- **tax_code** (String.t()) - The tax code for which to retrieve the description.

### Returns

- `String.t()` - The description of the tax code, or `nil` if the tax code is not found.

### Usage

```elixir
StripeManaged.TaxCode.description("txcd_10103001")
# => "SaaS (personal use)"
```
```

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

### Get Tax Code for Ebooks (Personal Use)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the specific tax code for ebooks intended for personal use.

```elixir
StripeManaged.TaxCode.ebooks_personal()
```

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

### Get tax code for SaaS (personal use)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the specific tax code for SaaS products intended for personal use.

```APIDOC
## `saas_personal`

### Description

Retrieves the tax code for SaaS products intended for personal use.

### Usage

```elixir
StripeManaged.TaxCode.saas_personal()
# => "txcd_10103001"
```
```

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

### Get Tax Code for Online Courses (Personal Use)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the specific tax code for online courses intended for personal use.

```elixir
StripeManaged.TaxCode.online_courses_personal()
```

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

### List All Eligible Tax Codes

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves a map containing all eligible tax codes and their corresponding descriptions. Use this to get a comprehensive list for product categorization.

```elixir
StripeManaged.TaxCode.all()
```

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

### Get Tax Code for SaaS (Personal Use)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the specific tax code for SaaS products intended for personal use. This is useful for categorizing sales accurately.

```elixir
StripeManaged.TaxCode.saas_personal()
```

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

### Handle Stripe Webhook Events

Source: https://hexdocs.pm/stripe_managed/0.1.0/readme.md

Example of how to handle incoming webhook events in a Phoenix controller. This snippet shows how to construct the event from the payload and signature, and then handle success or error cases.

```elixir
# In your Phoenix controller
def webhook(conn, _params) do
  payload = conn.assigns.raw_body
  signature = Plug.Conn.get_req_header(conn, "stripe-signature") |> List.first()

  case StripeManaged.Webhook.construct_event(payload, signature) do
    {:ok, event} ->
      handle_event(event)
      send_resp(conn, 200, "ok")

    {:error, reason} ->
      send_resp(conn, 400, reason)
  end
end
```

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

### Stripe API GET Request Specification

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Specifies the function signature for performing a GET request to the Stripe API. It takes a string path and a keyword list of options.

```elixir
@spec get(
  String.t(),
  keyword()
) :: response()
```

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

### Get Tax Code Description

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the human-readable description for a given tax code. Returns nil if the tax code is not found or invalid.

```elixir
StripeManaged.TaxCode.description("txcd_10103001")
```

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

### Get Tax Code for Video Games (Personal Use)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves the specific tax code for video games intended for personal use.

```elixir
StripeManaged.TaxCode.video_games_personal()
```

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

### create

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Creates a new product with the provided details. Requires a map of attributes and optional client options.

```APIDOC
## `create`

### Description
Creates a new product.

### Parameters
#### Request Body
- **attributes** (map) - Required - Product attributes such as name, description, tax_code, and default_price_data.
- **options** (keyword) - Optional - Client options.

### Response
#### Success Response (StripeManaged.Client.response())
Details of the created product.

### Example
```elixir
StripeManaged.Product.create(%{
  name: "Pro Plan",
  description: "Full access to all features",
  tax_code: "txcd_10103001",
  default_price_data: %{
    unit_amount: 2900,
    currency: "usd",
    recurring: %{interval: "month"}
  }
})
```
```

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

### Create a Subscription Checkout Session

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Use this to create a checkout session for a subscription. Ensure `managed_payments` is enabled.

```elixir
 {:ok, session} = StripeManaged.CheckoutSession.create(%{
   line_items: [%{price: "price_abc", quantity: 1}],
   mode: "subscription",
   managed_payments: %{enabled: true},
   success_url: "https://example.com/success"
 })
```

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

### list

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Lists existing products. Accepts optional filter parameters to refine the results.

```APIDOC
## `list`

### Description
Lists products. Accepts optional filter params.

### Parameters
#### Request Body
- **filters** (map) - Optional - Parameters to filter the product list.
- **options** (keyword) - Optional - Client options.

### Response
#### Success Response (StripeManaged.Client.response())
A list of products matching the filter criteria.

### Example
```elixir
StripeManaged.Product.list(%{limit: 10})
```
```

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

### create

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Price.md

Creates a new price for a Stripe product. It accepts a map of price attributes and optional keyword arguments.

```APIDOC
## `create`

### Description
Creates a new price.

### Parameters
- `params` (map) - A map containing price details such as product, unit_amount, currency, recurring, and tax_behavior.
- `options` (keyword) - Optional keyword arguments.

### Returns
`StripeManaged.Client.response()` - The result of the create operation.
```

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

### list_all

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Returns a lazy Stream of all products, automatically handling pagination for comprehensive retrieval.

```APIDOC
## `list_all`

### Description
Returns a lazy Stream of all products, auto-paginating.

### Parameters
#### Request Body
- **filters** (map) - Optional - Parameters to filter the product list.
- **options** (keyword) - Optional - Client options.

### Response
#### Success Response (Enumerable.t())
A lazy stream of all products.

### Example
```elixir
StripeManaged.Product.list_all()
```
```

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

### Create a One-Time Payment Checkout Session

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Use this to create a checkout session for a one-time payment. Ensure `managed_payments` is enabled.

```elixir
 {:ok, session} = StripeManaged.CheckoutSession.create(%{
   line_items: [%{price: "price_xyz", quantity: 1}],
   mode: "payment",
   managed_payments: %{enabled: true},
   success_url: "https://example.com/thanks"
 })
```

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

### Create a Stripe Product

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Use this to create a new product in Stripe. Ensure that the product uses eligible tax codes for Managed Payments. The `default_price_data` can be used to set an initial price.

```elixir
 {:ok, product} = StripeManaged.Product.create(%{
  name: "Pro Plan",
  description: "Full access to all features",
  tax_code: "txcd_10103001",
  default_price_data: %{
    unit_amount: 2900,
    currency: "usd",
    recurring: %{interval: "month"}
  }
})
```

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

### list

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Price.md

Lists existing prices. This function can accept optional filter parameters, such as `product`, to narrow down the results.

```APIDOC
## `list`

### Description
Lists prices. Accepts optional filter params like `product`.

### Parameters
- `filters` (map) - Optional map of filter parameters, e.g., `%{product: "prod_abc123"}`.
- `options` (keyword) - Optional keyword arguments.

### Returns
`StripeManaged.Client.response()` - The result of the list operation.
```

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

### create

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Refund.md

Creates a refund for a given payment. You can specify a partial amount and a reason for the refund. Metadata can also be included.

```APIDOC
## create

### Description
Creates a refund.

### Method
POST (assumed, based on creation action)

### Endpoint
/v1/refunds (assumed, based on Stripe API conventions)

### Parameters
#### Request Body
- **payment_intent** (string) - Required - The ID of the payment intent to refund.
- **charge** (string) - Required - The ID of the charge to refund.
- **amount** (integer) - Optional - Partial refund amount in cents.
- **reason** (string) - Optional - Reason for the refund. Allowed values: `"duplicate"`, `"fraudulent"`, or `"requested_by_customer"`.
- **metadata** (map) - Optional - Key-value metadata.
```

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

### list

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Lists all checkout sessions.

```APIDOC
## `list`

### Description
Lists checkout sessions.

### Parameters
#### Map Parameters
- `params` (map) - Parameters to filter the list of sessions.

#### Keyword Parameters
- `options` (keyword) - Additional options for listing sessions.
```

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

### list

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Customer.md

Lists customers with optional filtering and pagination parameters.

```APIDOC
## list

### Description
Lists customers with optional filtering and pagination parameters.

### Method Signature
`list(map(), keyword()) :: StripeManaged.Client.response()`

### Parameters
- `map()`: A map of parameters for filtering and pagination.
- `keyword()`: A keyword list of additional options.
```

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

### create

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Creates a new Checkout Session for one-time payments or subscriptions with managed payments enabled.

```APIDOC
## `create`

### Description
Creates a new Checkout Session.

### Parameters
#### Required Parameters
- `line_items` (list) - List of `%{price: price_id, quantity: n}`.
- `mode` (string) - Either `"subscription"` or `"payment"`.
- `managed_payments` (map) - Must be `%{enabled: true}`.
- `success_url` (string) - Redirect URL after successful payment.

#### Optional Parameters
- `cancel_url` (string) - Redirect URL if customer cancels.
- `customer` (string) - Existing customer ID.
- `customer_email` (string) - Pre-fill email.
- `metadata` (map) - Key-value metadata.
- `saved_payment_method_options` (map) - Saved payment method configuration.
- `payment_method_collection` (string) - Set to `"if_required"` for free trials.
```

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

### Create Checkout Session

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Creates a new Checkout Session. Requires `line_items`, `mode`, `managed_payments`, and `success_url`. Supports optional parameters like `cancel_url`, `customer`, and `metadata`.

```elixir
@spec create(
  map(),
  keyword()
) :: StripeManaged.Client.response()
```

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

### retrieve

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Retrieves a specific product using its unique ID.

```APIDOC
## `retrieve`

### Description
Retrieves a product by ID.

### Parameters
#### Path Parameters
- **product_id** (String.t()) - Required - The ID of the product to retrieve.
#### Request Body
- **options** (keyword) - Optional - Client options.

### Response
#### Success Response (StripeManaged.Client.response())
Details of the requested product.

### Example
```elixir
StripeManaged.Product.retrieve("prod_12345")
```
```

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

### list_all

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Price.md

Returns a lazy Stream of all prices, automatically handling pagination.

```APIDOC
## `list_all`

### Description
Returns a lazy Stream of all prices, auto-paginating.

### Parameters
- `params` (map) - Optional map of parameters for filtering or pagination.
- `options` (keyword) - Optional keyword arguments.

### Returns
`Enumerable.t()` - A lazy Stream of all prices.
```

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

### Create a Checkout Session with StripeManaged

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.md

Create a checkout session for a subscription with Stripe Managed Payments. This requires the product's price ID, mode, and success URL. Ensure managed_payments is enabled.

```elixir
StripeManaged.CheckoutSession.create(%{
  line_items: [%{price: product.default_price, quantity: 1}],
  mode: "subscription",
  managed_payments: %{enabled: true},
  success_url: "https://example.com/success"
})
```

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

### List Checkout Sessions

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Lists all checkout sessions. Accepts optional parameters for filtering and pagination.

```elixir
@spec list(
  map(),
  keyword()
) :: StripeManaged.Client.response()
```

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

### List All Stripe Products (Lazy Stream)

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Returns a lazy Stream of all products, automatically handling pagination. This is useful for iterating over a large number of products without loading them all into memory at once.

```elixir
StripeManaged.Product.list_all(filter_params)
```

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

### list_all

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Customer.md

Returns a lazy Stream of all customers, automatically handling pagination.

```APIDOC
## list_all

### Description
Returns a lazy Stream of all customers, automatically handling pagination.

### Method Signature
`list_all(map(), keyword()) :: Enumerable.t()`

### Parameters
- `map()`: A map of parameters for filtering.
- `keyword()`: A keyword list of additional options.
```

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

### list

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Subscription.md

Lists subscriptions. Allows filtering by parameters such as `customer`, `price`, and `status`.

```APIDOC
## list

### Description
Lists subscriptions. Filter by `customer`, `price`, `status`, etc.

### Method Signature
```elixir
@spec list(
  map(),
  keyword()
) :: StripeManaged.Client.response()
```
```

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

### Create a Product with StripeManaged

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.md

Use this snippet to create a new product in Stripe Managed Payments. It includes product details such as name, tax code, and default pricing information.

```elixir
StripeManaged.Product.create(%{
  name: "Pro Plan",
  tax_code: "txcd_10103001",
  default_price_data: %{
    unit_amount: 2900,
    currency: "usd",
    recurring: %{interval: "month"}
  }
})
```

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

### resume

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Subscription.md

Resumes a subscription that has been paused.

```APIDOC
## resume

### Description
Resumes a paused subscription.

### Method Signature
```elixir
@spec resume(String.t(), map(), keyword()) :: StripeManaged.Client.response()
```
```

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

### list

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Refund.md

Lists existing refunds. This operation supports filtering by parameters such as `payment_intent` and `charge`.

```APIDOC
## list

### Description
Lists refunds. Filter by `payment_intent`, `charge`, etc.

### Method
GET (assumed, based on listing action)

### Endpoint
/v1/refunds (assumed, based on Stripe API conventions)

### Parameters
#### Query Parameters
- **payment_intent** (string) - Optional - Filter refunds by payment intent ID.
- **charge** (string) - Optional - Filter refunds by charge ID.
- Other filtering parameters may be available.
```

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

### List all Stripe prices

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Price.md

Returns a lazy Stream of all prices, automatically handling pagination. This is useful for iterating through a large number of prices without loading them all into memory at once.

```elixir
@spec list_all(
  map(),
  keyword()
) :: Enumerable.t()
```

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

### list

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Invoice.md

Lists invoices. Filter by `customer`, `subscription`, `status`, etc.

```APIDOC
## list

### Description
Lists invoices. Filter by `customer`, `subscription`, `status`, etc.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
APIDOC

#### Query Parameters
APIDOC

#### Request Body
APIDOC

### Request Example
APIDOC

### Response
#### Success Response (200)
APIDOC

#### Response Example
APIDOC
```

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

### List Line Items for a Session

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Retrieves line items for a specific checkout session. Requires the session ID and optional parameters.

```elixir
@spec list_line_items(String.t(), map(), keyword()) :: StripeManaged.Client.response()
```

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

### list_all

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Refund.md

Returns a lazy Stream of all refunds, automatically handling pagination for comprehensive retrieval.

```APIDOC
## list_all

### Description
Returns a lazy Stream of all refunds, auto-paginating.

### Method
GET (assumed, based on listing action)

### Endpoint
/v1/refunds (assumed, based on Stripe API conventions, with automatic pagination)

### Parameters
No specific parameters are detailed for this method, implying it retrieves all refunds with automatic pagination.
```

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

### retrieve

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Price.md

Retrieves a specific price by its unique ID.

```APIDOC
## `retrieve`

### Description
Retrieves a price by ID.

### Parameters
- `id` (String.t) - The unique identifier of the price to retrieve.
- `options` (keyword) - Optional keyword arguments.

### Returns
`StripeManaged.Client.response()` - The retrieved price object.
```

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

### Add StripeManaged to Mix Dependencies

Source: https://hexdocs.pm/stripe_managed/0.1.0/readme.md

Add this to your `mix.exs` file to include the StripeManaged library in your project.

```elixir
{:stripe_managed, "~> 0.1"}
```

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

### Configure StripeManaged

Source: https://hexdocs.pm/stripe_managed/0.1.0/readme.md

Configure the StripeManaged client with your Stripe API key, API version, and webhook secret. It's recommended to use environment variables for sensitive information.

```elixir
config :stripe_managed,
  api_key: System.get_env("STRIPE_SECRET_KEY"),
  api_version: "2025-03-31.basil",
  webhook_secret: System.get_env("STRIPE_WEBHOOK_SECRET")
```

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

### upcoming

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Invoice.md

Retrieves the upcoming invoice for a subscription.

```APIDOC
## upcoming

### Description
Retrieves the upcoming invoice for a subscription.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
APIDOC

#### Query Parameters
APIDOC

#### Request Body
APIDOC

### Request Example
APIDOC

### Response
#### Success Response (200)
APIDOC

#### Response Example
APIDOC
```

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

### List all eligible codes

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Retrieves a map of all eligible tax codes and their corresponding descriptions.

```APIDOC
## `all`

### Description

Returns all eligible tax codes as a map where keys are the tax codes and values are their descriptions.

### Returns

- `map()` - A map of eligible tax codes to their descriptions.

### Usage

```elixir
StripeManaged.TaxCode.all()
```
```

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

### Construct Event with Signature Verification

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Webhook.md

Verifies the webhook signature and parses the event payload. Use this function to safely construct event objects from incoming webhook data. Options allow overriding the webhook secret and setting a tolerance for signature age.

```elixir
@spec construct_event(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, String.t()}
```

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

### list_all

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Subscription.md

Returns a lazy Stream of all subscriptions, automatically handling pagination.

```APIDOC
## list_all

### Description
Returns a lazy Stream of all subscriptions, auto-paginating.

### Method Signature
```elixir
@spec list_all(
  map(),
  keyword()
) :: Enumerable.t()
```
```

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

### retrieve

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Retrieves a specific checkout session by its ID.

```APIDOC
## `retrieve`

### Description
Retrieves a session by ID.

### Parameters
#### Path Parameters
- `session_id` (string) - The ID of the checkout session to retrieve.

#### Keyword Parameters
- `options` (keyword) - Additional options for retrieving the session.
```

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

### List Stripe Products

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Retrieves a list of Stripe products. Optional filter parameters can be provided to refine the results.

```elixir
StripeManaged.Product.list(filter_params)
```

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

### list_all

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Invoice.md

Returns a lazy Stream of all invoices, auto-paginating.

```APIDOC
## list_all

### Description
Returns a lazy Stream of all invoices, auto-paginating.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
APIDOC

#### Query Parameters
APIDOC

#### Request Body
APIDOC

### Request Example
APIDOC

### Response
#### Success Response (200)
APIDOC

#### Response Example
APIDOC
```

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

### update

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Subscription.md

Updates an existing subscription. This includes changing prices for upgrades/downgrades, modifying quantity, updating metadata, and controlling proration with `payment_behavior`.

```APIDOC
## update

### Description
Updates a subscription. Supports changing prices (upgrade/downgrade), quantity, metadata, and `payment_behavior` for proration control.

### Method Signature
```elixir
@spec update(String.t(), map(), keyword()) :: StripeManaged.Client.response()
```
```

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

### update

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Updates an existing product identified by its ID with new attributes.

```APIDOC
## `update`

### Description
Updates a product.

### Parameters
#### Path Parameters
- **product_id** (String.t()) - Required - The ID of the product to update.
#### Request Body
- **attributes** (map) - Required - The attributes to update for the product.
- **options** (keyword) - Optional - Client options.

### Response
#### Success Response (StripeManaged.Client.response())
Details of the updated product.

### Example
```elixir
StripeManaged.Product.update("prod_12345", %{description: "Updated description"})
```
```

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

### Retrieve a Stripe Product

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Retrieves a specific product from Stripe using its unique ID.

```elixir
StripeManaged.Product.retrieve(product_id)
```

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

### retrieve

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Invoice.md

Retrieves an invoice by ID.

```APIDOC
## retrieve

### Description
Retrieves an invoice by ID.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
- **id** (String.t) - Required - The ID of the invoice to retrieve.

#### Query Parameters
APIDOC

#### Request Body
APIDOC

### Request Example
APIDOC

### Response
#### Success Response (200)
APIDOC

#### Response Example
APIDOC
```

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

### retrieve

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Customer.md

Retrieves a specific customer record by their unique ID.

```APIDOC
## retrieve

### Description
Retrieves a customer by their unique ID.

### Method Signature
`retrieve(String.t(), keyword()) :: StripeManaged.Client.response()`

### Parameters
- `String.t()`: The unique identifier of the customer to retrieve.
- `keyword()`: A keyword list of additional options.
```

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

### Create a new Stripe price

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Price.md

Use this function to create a new price for a Stripe product. Ensure you provide the product ID, unit amount, currency, and recurring interval. Tax behavior defaults to 'exclusive'.

```elixir
 {:ok, price} = StripeManaged.Price.create(%{
  product: "prod_abc123",
  unit_amount: 29900,
  currency: "usd",
  recurring: %{interval: "year"},
  tax_behavior: "exclusive"
 })
```

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

### StripeManaged.Webhook.construct_event

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Webhook.md

Verifies the webhook signature and parses the event payload. Returns `{:ok, event_map}` or `{:error, reason}`.

```APIDOC
## `StripeManaged.Webhook.construct_event`

### Description
Verifies the webhook signature and parses the event payload.

### Method Signature
```elixir
@spec construct_event(String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, String.t()}
```

### Parameters
- `payload` (String.t()) - The raw webhook payload.
- `signature` (String.t()) - The `stripe-signature` header value.
- `options` (keyword()) - Optional arguments:
  - `:webhook_secret` - override the configured secret
  - `:tolerance` - max age in seconds (default: 300)

### Returns
- `{:ok, map()}` - If the signature is valid and the event is parsed successfully.
- `{:error, String.t()}` - If the signature is invalid or an error occurs during parsing.
```

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

### retrieve

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Refund.md

Retrieves a specific refund using its unique ID.

```APIDOC
## retrieve

### Description
Retrieves a refund by ID.

### Method
GET (assumed, based on retrieval action)

### Endpoint
/v1/refunds/{refund_id} (assumed, based on Stripe API conventions)

### Parameters
#### Path Parameters
- **refund_id** (string) - Required - The unique identifier of the refund to retrieve.
```

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

### Phoenix Endpoint Configuration

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Webhook.md

Configure your Phoenix endpoint to parse raw request bodies for webhook routes. This is necessary for signature verification.

```elixir
plug Plug.Parsers,
  parsers: [:urlencoded, :multipart, :json],
  pass: ["*/*"],
  body_reader: {CacheBodyReader, :read_body, []},
  json_decoder: Jason
```

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

### list_paginated

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Lists resources with auto-pagination support. Returns a Stream that lazily fetches pages.

```APIDOC
## list_paginated

### Description
Lists resources with auto-pagination support. Returns a Stream that lazily fetches pages.

### Method
GET

### Endpoint
[ENDPOINT]

### Parameters
#### Path Parameters
- **path** (String.t()) - Required - The path for the list request.

#### Query Parameters
- **params** (map()) - Required - Parameters for the list request.
- **options** (keyword()) - Optional - A keyword list of options for the request.

### Response
#### Success Response (200)
- **Enumerable.t()** - A stream that lazily fetches pages of resources.
```

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

### Retrieve Checkout Session

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Retrieves a specific checkout session by its ID. Accepts optional parameters.

```elixir
@spec retrieve(
  String.t(),
  keyword()
) :: StripeManaged.Client.response()
```

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

### cancel

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Subscription.md

Cancels a subscription. By default, it cancels immediately. To cancel at the end of the current billing period, pass `cancel_at_period_end: true`.

```APIDOC
## cancel

### Description
Cancels a subscription. By default, cancels immediately. Pass `cancel_at_period_end: true` to cancel at the end of the current billing period instead.

### Method Signature
```elixir
@spec cancel(String.t(), map(), keyword()) :: StripeManaged.Client.response()
```
```

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

### update

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Price.md

Updates an existing price. Only specific fields like `active`, `metadata`, `nickname`, and `tax_behavior` can be modified.

```APIDOC
## `update`

### Description
Updates a price. Only `active`, `metadata`, `nickname`, and `tax_behavior` can be updated.

### Parameters
- `id` (String.t) - The unique identifier of the price to update.
- `updates` (map) - A map containing the fields to update.
- `options` (keyword) - Optional keyword arguments.

### Returns
`StripeManaged.Client.response()` - The updated price object.
```

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

### post

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Performs a POST request with a form-encoded body to the Stripe API. It takes a path, a map or nil for the body, and a keyword list of options.

```APIDOC
## post

### Description
Performs a POST request with form-encoded body.

### Method
POST

### Endpoint
[ENDPOINT]

### Parameters
#### Path Parameters
- **path** (String.t()) - Required - The path for the POST request.

#### Query Parameters
- **body** (map() | nil) - Optional - The form-encoded body for the request.
- **options** (keyword()) - Optional - A keyword list of options for the request.

### Response
#### Success Response (200)
- **response** (:ok | {:error, StripeManaged.Error.t()}) - The result of the operation, either success or error.
```

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

### retrieve

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Subscription.md

Retrieves a specific subscription using its ID.

```APIDOC
## retrieve

### Description
Retrieves a subscription by ID.

### Method Signature
```elixir
@spec retrieve(
  String.t(),
  keyword()
) :: StripeManaged.Client.response()
```
```

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

### delete

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Deletes a product by its ID. This operation is only successful if the product has no associated prices.

```APIDOC
## `delete`

### Description
Deletes a product (only if it has no prices).

### Parameters
#### Path Parameters
- **product_id** (String.t()) - Required - The ID of the product to delete.
#### Request Body
- **options** (keyword) - Optional - Client options.

### Response
#### Success Response (StripeManaged.Client.response())
Confirmation of deletion or error.

### Example
```elixir
StripeManaged.Product.delete("prod_12345")
```
```

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

### Stripe API Paginated List Specification

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Defines the function signature for listing resources with automatic pagination. It returns a lazy Stream for fetching pages.

```elixir
@spec list_paginated(String.t(), map(), keyword()) :: Enumerable.t()
```

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

### update

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Refund.md

Updates the metadata associated with an existing refund. This operation requires the refund's ID.

```APIDOC
## update

### Description
Updates a refund's metadata.

### Method
POST or PUT (assumed, based on update action)

### Endpoint
/v1/refunds/{refund_id} (assumed, based on Stripe API conventions)

### Parameters
#### Path Parameters
- **refund_id** (string) - Required - The unique identifier of the refund to update.

#### Request Body
- **metadata** (map) - Required - Key-value metadata to update for the refund.
```

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

### list_line_items

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Retrieves the line items associated with a specific checkout session.

```APIDOC
## `list_line_items`

### Description
Retrieves line items for a session.

### Parameters
#### Path Parameters
- `session_id` (string) - The ID of the checkout session.

#### Map Parameters
- `params` (map) - Parameters to filter the line items.

#### Keyword Parameters
- `options` (keyword) - Additional options for listing line items.
```

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

### Update a Stripe Product

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Updates an existing product in Stripe. You can modify various attributes of the product.

```elixir
StripeManaged.Product.update(product_id, update_params)
```

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

### Verify Webhook Signature

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Webhook.md

Verifies a webhook signature without parsing the payload. This function is useful if you only need to confirm the signature's validity before further processing.

```elixir
@spec verify(String.t(), String.t(), keyword()) :: :ok | {:error, String.t()}
```

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

### Phoenix Controller Webhook Handler

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Webhook.md

Implement a webhook handler in your Phoenix controller to receive and process Stripe events. It extracts the raw payload and signature, then constructs the event.

```elixir
def webhook(conn, _params) do
  payload = conn.assigns.raw_body
  signature = get_req_header(conn, "stripe-signature") |> List.first()

  case StripeManaged.Webhook.construct_event(payload, signature) do
    {:ok, event} -> handle_event(event)
    {:error, msg} -> send_resp(conn, 400, msg)
  end
end
```

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

### StripeManaged.Webhook.verify

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Webhook.md

Verifies a webhook signature without parsing the payload. Returns `:ok` or `{:error, reason}`.

```APIDOC
## `StripeManaged.Webhook.verify`

### Description
Verifies a webhook signature without parsing the payload.

### Method Signature
```elixir
@spec verify(String.t(), String.t(), keyword()) :: :ok | {:error, String.t()}
```

### Parameters
- `payload` (String.t()) - The raw webhook payload.
- `signature` (String.t()) - The `stripe-signature` header value.
- `options` (keyword()) - Optional arguments:
  - `:webhook_secret` - override the configured secret
  - `:tolerance` - max age in seconds (default: 300)

### Returns
- `:ok` - If the signature is valid.
- `{:error, String.t()}` - If the signature is invalid.
```

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

### Update a Stripe price

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Price.md

Updates an existing price. Only 'active', 'metadata', 'nickname', and 'tax_behavior' fields can be modified after creation.

```elixir
@spec update(String.t(), map(), keyword()) :: StripeManaged.Client.response()
```

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

### expire

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Expires a checkout session, preventing it from being completed.

```APIDOC
## `expire`

### Description
Expires a checkout session so it can no longer be completed.

### Parameters
#### Path Parameters
- `session_id` (string) - The ID of the checkout session to expire.

#### Keyword Parameters
- `options` (keyword) - Additional options for expiring the session.
```

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

### Stripe API POST Request Specification

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Specifies the function signature for performing a POST request with a form-encoded body. It accepts a string path, an optional map for the body, and a keyword list of options.

```elixir
@spec post(String.t(), map() | nil, keyword()) :: response()
```

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

### delete

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Performs a DELETE request to the Stripe API. It takes a path and a keyword list of options.

```APIDOC
## delete

### Description
Performs a DELETE request.

### Method
DELETE

### Endpoint
[ENDPOINT]

### Parameters
#### Path Parameters
- **path** (String.t()) - Required - The path for the DELETE request.

#### Query Parameters
- **options** (keyword()) - Optional - A keyword list of options for the request.

### Response
#### Success Response (200)
- **response** (:ok | {:error, StripeManaged.Error.t()}) - The result of the operation, either success or error.
```

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

### Stripe API Response Type

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Defines the possible response types from the Stripe API: either a successful map or an error tuple.

```elixir
@type response() :: {:ok, map()} | {:error, StripeManaged.Error.t()}
```

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

### Check Tax Code Eligibility

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Verifies if a given tax code is eligible for use with Stripe Managed Payments. Returns true if eligible, false otherwise.

```elixir
StripeManaged.TaxCode.eligible?("txcd_10103001")
```

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

### Expire Checkout Session

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.CheckoutSession.md

Expires a checkout session so it can no longer be completed. Requires the session ID.

```elixir
@spec expire(
  String.t(),
  keyword()
) :: StripeManaged.Client.response()
```

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

### Stripe API DELETE Request Specification

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Client.md

Specifies the function signature for performing a DELETE request to the Stripe API. It takes a string path and a keyword list of options.

```elixir
@spec delete(
  String.t(),
  keyword()
) :: response()
```

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

### Delete a Stripe Product

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Product.md

Deletes a product from Stripe. This operation is only permitted if the product has no associated prices.

```elixir
StripeManaged.Product.delete(product_id)
```

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

### StripeManaged.Error Struct

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Error.md

Defines the structure of the error object returned by StripeManaged API calls, including its fields and their types.

```APIDOC
## StripeManaged.Error

Structured error returned by all API calls.

### Fields

  * `:type` - error category (`:api_error`, `:card_error`, `:invalid_request`,
    `:authentication`, `:rate_limit`, `:network`)
  * `:code` - Stripe error code string (e.g. `"resource_missing"`)
  * `:message` - human-readable description
  * `:param` - the parameter that caused the error (if applicable)
  * `:status` - HTTP status code

### Type Definition

```elixir
@type t() :: %StripeManaged.Error{
  code: String.t() | nil,
  message: String.t(),
  param: String.t() | nil,
  status: integer() | nil,
  type: atom()
}
```
```

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

### Check if a tax code is eligible

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.TaxCode.md

Determines if a given tax code is eligible for use with Stripe Managed Payments.

```APIDOC
## `eligible?`

### Description

Checks if the provided tax code is eligible for Stripe Managed Payments.

### Parameters

- **tax_code** (String.t()) - The tax code to check for eligibility.

### Returns

- `true` if the tax code is eligible, `false` otherwise.

### Usage

```elixir
StripeManaged.TaxCode.eligible?("txcd_10103001")
# => true
```
```

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

### StripeManaged.Error Struct Type Definition

Source: https://hexdocs.pm/stripe_managed/0.1.0/StripeManaged.Error.md

Defines the structure of the StripeManaged.Error type, specifying the data types for each field. This is used to represent API errors.

```elixir
@type t() :: %StripeManaged.Error{
  code: String.t() | nil,
  message: String.t(),
  param: String.t() | nil,
  status: integer() | nil,
  type: atom()
}
```
Tokens:
Raw