View Source Stripe.Billing.MeterEventAdjustment (stripity_stripe v3.3.1)

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.

Summary

Types

cancel()

Specifies which event to cancel.

t()

The billing.meter_event_adjustment type.

Functions

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

Creates a billing meter event adjustment.

Types

Link to this type

cancel()

View Source 
@type cancel() :: %{optional(:identifier) => binary()}

Specifies which event to cancel.

Link to this type

t()

View Source 
@type t() :: %Stripe.Billing.MeterEventAdjustment{
  cancel: term() | nil,
  event_name: binary(),
  livemode: boolean(),
  object: binary(),
  status: binary(),
  type: binary()
}

The billing.meter_event_adjustment type.

  • cancel Specifies which event to cancel.
  • event_name The name of the meter event. Corresponds with the event_name field on a meter.
  • livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • object String representing the object's type. Objects of the same type share the same value.
  • status The meter event adjustment's status.
  • type Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.

Functions

Link to this function

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

View Source 
@spec create(
  params :: %{
    optional(:cancel) => cancel(),
    optional(:event_name) => binary(),
    optional(:expand) => [binary()],
    optional(:type) => :cancel
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a billing meter event adjustment.

Details

  • Method: post
  • Path: /v1/billing/meter_event_adjustments