Class: Stripe::Entitlements::ActiveEntitlement

Inherits:
APIResource show all
Extended by:
APIOperations::List
Defined in:
lib/stripe/resources/entitlements/active_entitlement.rb

Overview

An active entitlement describes access to a feature for a customer.

Defined Under Namespace

Classes: ListParams

Constant Summary collapse

OBJECT_NAME = 
"entitlements.active_entitlement"

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::List

list

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

#feature ⇒ Object (readonly)

The [Feature](stripe.com/docs/api/entitlements/feature) that the customer is entitled to.



42
43
44
 
# File 'lib/stripe/resources/entitlements/active_entitlement.rb', line 42

def feature
  @feature
end

#id ⇒ Object (readonly)

Unique identifier for the object.



44
45
46
 
# File 'lib/stripe/resources/entitlements/active_entitlement.rb', line 44

def id
  @id
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.



46
47
48
 
# File 'lib/stripe/resources/entitlements/active_entitlement.rb', line 46

def livemode
  @livemode
end

#lookup_key ⇒ Object (readonly)

A unique key you provide as your own system identifier. This may be up to 80 characters.



48
49
50
 
# File 'lib/stripe/resources/entitlements/active_entitlement.rb', line 48

def lookup_key
  @lookup_key
end

#object ⇒ Object (readonly)

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



50
51
52
 
# File 'lib/stripe/resources/entitlements/active_entitlement.rb', line 50

def object
  @object
end

Class Method Details

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

Retrieve a list of active entitlements for a customer



53
54
55
56
57
58
59
60
 
# File 'lib/stripe/resources/entitlements/active_entitlement.rb', line 53

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

.object_name ⇒ Object 



11
12
13
 
# File 'lib/stripe/resources/entitlements/active_entitlement.rb', line 11

def self.object_name
  "entitlements.active_entitlement"
end