Class: Stripe::Billing::Meter
- Inherits:
-
APIResource
- Object
- StripeObject
- APIResource
- Stripe::Billing::Meter
- Includes:
- APIOperations::Save
- Defined in:
- lib/stripe/resources/billing/meter.rb
Overview
A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.
Constant Summary collapse
- OBJECT_NAME =
"billing.meter"
Constants inherited from StripeObject
StripeObject::RESERVED_FIELD_NAMES
Instance Attribute Summary
Attributes inherited from APIResource
Attributes inherited from StripeObject
Class Method Summary collapse
-
.create(params = {}, opts = {}) ⇒ Object
Creates a billing meter.
-
.deactivate(id, params = {}, opts = {}) ⇒ Object
Deactivates a billing meter.
-
.list(filters = {}, opts = {}) ⇒ Object
Retrieve a list of billing meters.
- .object_name ⇒ Object
-
.reactivate(id, params = {}, opts = {}) ⇒ Object
Reactivates a billing meter.
-
.update(id, params = {}, opts = {}) ⇒ Object
Updates a billing meter.
Instance Method Summary collapse
-
#deactivate(params = {}, opts = {}) ⇒ Object
Deactivates a billing meter.
-
#reactivate(params = {}, opts = {}) ⇒ Object
Reactivates a billing meter.
Methods included from APIOperations::Create
Methods included from APIOperations::List
Methods included from APIOperations::NestedResource
Methods included from APIOperations::Save
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
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
Class Method Details
.create(params = {}, opts = {}) ⇒ Object
Creates a billing meter
23 24 25 |
# File 'lib/stripe/resources/billing/meter.rb', line 23 def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/billing/meters", params: params, opts: opts) end |
.deactivate(id, params = {}, opts = {}) ⇒ Object
Deactivates a billing meter
38 39 40 41 42 43 44 45 |
# File 'lib/stripe/resources/billing/meter.rb', line 38 def self.deactivate(id, params = {}, opts = {}) request_stripe_object( method: :post, path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(id) }), params: params, opts: opts ) end |
.list(filters = {}, opts = {}) ⇒ Object
Retrieve a list of billing meters.
48 49 50 |
# File 'lib/stripe/resources/billing/meter.rb', line 48 def self.list(filters = {}, opts = {}) request_stripe_object(method: :get, path: "/v1/billing/meters", params: filters, opts: opts) end |
.object_name ⇒ Object
14 15 16 |
# File 'lib/stripe/resources/billing/meter.rb', line 14 def self.object_name "billing.meter" end |
.reactivate(id, params = {}, opts = {}) ⇒ Object
Reactivates a billing meter
63 64 65 66 67 68 69 70 |
# File 'lib/stripe/resources/billing/meter.rb', line 63 def self.reactivate(id, params = {}, opts = {}) request_stripe_object( method: :post, path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(id) }), params: params, opts: opts ) end |
.update(id, params = {}, opts = {}) ⇒ Object
Updates a billing meter
73 74 75 76 77 78 79 80 |
# File 'lib/stripe/resources/billing/meter.rb', line 73 def self.update(id, params = {}, opts = {}) request_stripe_object( method: :post, path: format("/v1/billing/meters/%<id>s", { id: CGI.escape(id) }), params: params, opts: opts ) end |
Instance Method Details
#deactivate(params = {}, opts = {}) ⇒ Object
Deactivates a billing meter
28 29 30 31 32 33 34 35 |
# File 'lib/stripe/resources/billing/meter.rb', line 28 def deactivate(params = {}, opts = {}) request_stripe_object( method: :post, path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(self["id"]) }), params: params, opts: opts ) end |
#reactivate(params = {}, opts = {}) ⇒ Object
Reactivates a billing meter
53 54 55 56 57 58 59 60 |
# File 'lib/stripe/resources/billing/meter.rb', line 53 def reactivate(params = {}, opts = {}) request_stripe_object( method: :post, path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(self["id"]) }), params: params, opts: opts ) end |