Stripe.WebhookEndpoint (stripity_stripe v2.17.2) View Source

Work with Stripe webhook_endpoint objects. You can:

Link to this section Summary

Types

t()

Functions

create(params, opts \\ [])

Create a webhook endpoint. See the Stripe docs.

delete(id, opts \\ [])

Delete a webhook endpoint. See the Stripe docs.

list(params \\ %{}, opts \\ [])

List all webhook endpoints. See the Stripe docs.

retrieve(id, opts \\ [])

Retrieve a webhook endpoint. See the Stripe docs.

update(id, params, opts \\ [])

Update a webhook endpoint. See the Stripe docs.

Link to this section Types

t()

Specs

t() :: %Stripe.WebhookEndpoint{
  application: String.t() | nil,
  created: Stripe.timestamp(),
  deleted: boolean(),
  description: String.t(),
  enabled_events: [String.t()],
  id: Stripe.id(),
  livemode: boolean(),
  metadata: map(),
  object: String.t(),
  secret: String.t() | nil,
  status: String.t(),
  url: String.t()
}

Link to this section Functions

create(params, opts \\ [])

Specs

create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:api_version) => String.t(),
         optional(:connect) => boolean(),
         optional(:description) => String.t(),
         :enabled_events => [String.t()],
         optional(:metadata) => map(),
         url: String.t()
       }
       | %{}

Create a webhook endpoint. See the Stripe docs.

delete(id, opts \\ [])

Specs

delete(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Delete a webhook endpoint. See the Stripe docs.

list(params \\ %{}, opts \\ [])

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:ending_before) => t() | Stripe.id(),
         optional(:limit) => 1..100,
         optional(:starting_after) => t() | Stripe.id()
       }
       | %{}

List all webhook endpoints. See the Stripe docs.

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a webhook endpoint. See the Stripe docs.

update(id, params, opts \\ [])

Specs

update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:description) => String.t(),
         optional(:disabled) => boolean(),
         optional(:enabled_events) => [String.t()],
         optional(:metadata) => map(),
         optional(:url) => String.t()
       }
       | %{}

Update a webhook endpoint. See the Stripe docs.