Class: Stripe::Billing::Meter

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List, APIOperations::NestedResource
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.

Related guide: [Usage based billing](docs.stripe.com/billing/subscriptions/usage-based)

Constant Summary collapse

OBJECT_NAME = 
"billing.meter"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::NestedResource

nested_resource_class_methods

Methods included from APIOperations::Save

included, #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

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

Class Method Details

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

Creates a billing meter



25
26
27
 
# File 'lib/stripe/resources/billing/meter.rb', line 25

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



40
41
42
43
44
45
46
47
 
# File 'lib/stripe/resources/billing/meter.rb', line 40

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.



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

def self.list(filters = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/billing/meters", params: filters, opts: opts)
end

.object_name ⇒ Object 



16
17
18
 
# File 'lib/stripe/resources/billing/meter.rb', line 16

def self.object_name
  "billing.meter"
end

.reactivate(id, params = {}, opts = {}) ⇒ Object

Reactivates a billing meter



65
66
67
68
69
70
71
72
 
# File 'lib/stripe/resources/billing/meter.rb', line 65

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



75
76
77
78
79
80
81
82
 
# File 'lib/stripe/resources/billing/meter.rb', line 75

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



30
31
32
33
34
35
36
37
 
# File 'lib/stripe/resources/billing/meter.rb', line 30

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



55
56
57
58
59
60
61
62
 
# File 'lib/stripe/resources/billing/meter.rb', line 55

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