Packages
stripity_stripe
3.3.1
3.3.2
3.3.1
3.2.0
3.1.1
3.1.0
3.0.0
2.17.3
2.17.2
2.17.1
2.17.0
2.16.0
2.15.1
2.15.0
2.14.1
2.14.0
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.2
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.3
2.2.2
2.2.1
2.2.0
2.1.0
2.0.1
2.0.0
2.0.0-alpha.11
2.0.0-alpha.10
2.0.0-alpha.9
2.0.0-alpha.8
2.0.0-alpha.7
2.0.0-alpha.6
2.0.0-alpha.5
2.0.0-alpha.4
2.0.0-alpha.3
2.0.0-alpha.2
2.0.0-alpha.1
1.6.2
1.6.1
1.6.0
1.4.0
1.3.0
1.2.0
1.1.0
0.5.0
0.4.0
0.3.0
0.2.0
A Stripe client for Elixir.
Current section
Files
Jump to
Current section
Files
lib/generated/billing__meter_event_adjustment.ex
defmodule Stripe.Billing.MeterEventAdjustment do
use Stripe.Entity
@moduledoc "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer."
(
defstruct [:cancel, :event_name, :livemode, :object, :status, :type]
@typedoc "The `billing.meter_event_adjustment` type.\n\n * `cancel` Specifies which event to cancel.\n * `event_name` The name of the meter event. Corresponds with the `event_name` field on a meter.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The meter event adjustment's status.\n * `type` Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.\n"
@type t :: %__MODULE__{
cancel: term | nil,
event_name: binary,
livemode: boolean,
object: binary,
status: binary,
type: binary
}
)
(
@typedoc "Specifies which event to cancel."
@type cancel :: %{optional(:identifier) => binary}
)
(
nil
@doc "<p>Creates a billing meter event adjustment.</p>\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/billing/meter_event_adjustments`\n"
(
@spec create(
params :: %{
optional(:cancel) => cancel,
optional(:event_name) => binary,
optional(:expand) => list(binary),
optional(:type) => :cancel
},
opts :: Keyword.t()
) ::
{:ok, Stripe.Billing.MeterEventAdjustment.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def create(params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params("/v1/billing/meter_event_adjustments", [], [])
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:post)
|> Stripe.Request.make_request()
end
)
)
end