Class: Stripe::Billing::MeterEventAdjustment

Inherits:
APIResource show all
Extended by:
APIOperations::Create
Defined in:
lib/stripe/resources/billing/meter_event_adjustment.rb

Overview

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.

Defined Under Namespace

Classes: Cancel, CreateParams

Constant Summary collapse

OBJECT_NAME = 
"billing.meter_event_adjustment"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#cancel ⇒ Object (readonly)

Specifies which event to cancel.



46
47
48
 
# File 'lib/stripe/resources/billing/meter_event_adjustment.rb', line 46

def cancel
  @cancel
end

#event_name ⇒ Object (readonly)

The name of the meter event. Corresponds with the ‘event_name` field on a meter.



48
49
50
 
# File 'lib/stripe/resources/billing/meter_event_adjustment.rb', line 48

def event_name
  @event_name
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



50
51
52
 
# File 'lib/stripe/resources/billing/meter_event_adjustment.rb', line 50

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



52
53
54
 
# File 'lib/stripe/resources/billing/meter_event_adjustment.rb', line 52

def object
  @object
end

#status ⇒ Object (readonly)

The meter event adjustment’s status.



54
55
56
 
# File 'lib/stripe/resources/billing/meter_event_adjustment.rb', line 54

def status
  @status
end

#type ⇒ Object (readonly)

Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.



56
57
58
 
# File 'lib/stripe/resources/billing/meter_event_adjustment.rb', line 56

def type
  @type
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a billing meter event adjustment.



59
60
61
62
63
64
65
66
 
# File 'lib/stripe/resources/billing/meter_event_adjustment.rb', line 59

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/billing/meter_event_adjustments",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



11
12
13
 
# File 'lib/stripe/resources/billing/meter_event_adjustment.rb', line 11

def self.object_name
  "billing.meter_event_adjustment"
end