# `Polarex.CheckoutLinks`
[🔗](https://github.com/giusdp/polarex/blob/main/lib/polarex/operations/checkout_links.ex#L1)

Provides API endpoints related to checkout links

# `checkout_links_create`

```elixir
@spec checkout_links_create(
  body ::
    Polarex.CheckoutLinkCreateProduct.t()
    | Polarex.CheckoutLinkCreateProductPrice.t()
    | Polarex.CheckoutLinkCreateProducts.t(),
  opts :: keyword()
) :: {:ok, Polarex.CheckoutLink.t()} | {:error, Polarex.HTTPValidationError.t()}
```

Create Checkout Link

Create a checkout link.

**Scopes**: `checkout_links:write`

## Request Body

**Content Types**: `application/json`

# `checkout_links_delete`

```elixir
@spec checkout_links_delete(id :: String.t(), opts :: keyword()) ::
  :ok | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
```

Delete Checkout Link

Delete a checkout link.

**Scopes**: `checkout_links:write`

# `checkout_links_get`

```elixir
@spec checkout_links_get(id :: String.t(), opts :: keyword()) ::
  {:ok, Polarex.CheckoutLink.t()}
  | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
```

Get Checkout Link

Get a checkout link by ID.

**Scopes**: `checkout_links:read` `checkout_links:write`

# `checkout_links_list`

```elixir
@spec checkout_links_list(opts :: keyword()) ::
  {:ok, Polarex.ListResourceCheckoutLink.t()}
  | {:error, Polarex.HTTPValidationError.t()}
```

List Checkout Links

List checkout links.

**Scopes**: `checkout_links:read` `checkout_links:write`

## Options

  * `organization_id`: Filter by organization ID.
  * `product_id`: Filter by product ID.
  * `page`: Page number, defaults to 1.
  * `limit`: Size of a page, defaults to 10. Maximum is 100.
  * `sorting`: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

# `checkout_links_update`

```elixir
@spec checkout_links_update(
  id :: String.t(),
  body :: Polarex.CheckoutLinkUpdate.t(),
  opts :: keyword()
) ::
  {:ok, Polarex.CheckoutLink.t()}
  | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
```

Update Checkout Link

Update a checkout link.

**Scopes**: `checkout_links:write`

## Request Body

**Content Types**: `application/json`

---

*Consult [api-reference.md](api-reference.md) for complete listing*