Class: Stripe::Billing::CreditGrant

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/billing/credit_grant.rb

Overview

A credit grant is an API resource that documents the allocation of some billing credits to a customer.

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

Defined Under Namespace

Classes: Amount, ApplicabilityConfig

Constant Summary collapse

OBJECT_NAME = 
"billing.credit_grant"

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

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

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

#==, #[], #[]=, #_get_inner_class_type, 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

#amount ⇒ Object (readonly)

Attribute for field amount



87
88
89
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 87

def amount
  @amount
end

#applicability_config ⇒ Object (readonly)

Attribute for field applicability_config



89
90
91
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 89

def applicability_config
  @applicability_config
end

#category ⇒ Object (readonly)

The category of this credit grant. This is for tracking purposes and isn’t displayed to the customer.



91
92
93
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 91

def category
  @category
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



93
94
95
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 93

def created
  @created
end

#customer ⇒ Object (readonly)

ID of the customer receiving the billing credits.



95
96
97
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 95

def customer
  @customer
end

#effective_at ⇒ Object (readonly)

The time when the billing credits become effective-when they’re eligible for use.



97
98
99
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 97

def effective_at
  @effective_at
end

#expires_at ⇒ Object (readonly)

The time when the billing credits expire. If not present, the billing credits don’t expire.



99
100
101
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 99

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



101
102
103
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 101

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.



103
104
105
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 103

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



105
106
107
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 105

def metadata
  @metadata
end

#name ⇒ Object (readonly)

A descriptive name shown in dashboard.



107
108
109
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 107

def name
  @name
end

#object ⇒ Object (readonly)

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



109
110
111
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 109

def object
  @object
end

#priority ⇒ Object (readonly)

The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.



111
112
113
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 111

def priority
  @priority
end

#test_clock ⇒ Object (readonly)

ID of the test clock this credit grant belongs to.



113
114
115
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 113

def test_clock
  @test_clock
end

#updated ⇒ Object (readonly)

Time at which the object was last updated. Measured in seconds since the Unix epoch.



115
116
117
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 115

def updated
  @updated
end

#voided_at ⇒ Object (readonly)

The time when this credit grant was voided. If not present, the credit grant hasn’t been voided.



117
118
119
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 117

def voided_at
  @voided_at
end

Class Method Details

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

Creates a credit grant.



120
121
122
123
124
125
126
127
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 120

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

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

Expires a credit grant.



140
141
142
143
144
145
146
147
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 140

def self.expire(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



193
194
195
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 193

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



189
190
191
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 189

def self.inner_class_types
  @inner_class_types = { amount: Amount, applicability_config: ApplicabilityConfig }
end

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

Retrieve a list of credit grants.



150
151
152
153
154
155
156
157
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 150

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

.object_name ⇒ Object 



15
16
17
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 15

def self.object_name
  "billing.credit_grant"
end

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

Updates a credit grant.



160
161
162
163
164
165
166
167
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 160

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/billing/credit_grants/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

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

Voids a credit grant.



180
181
182
183
184
185
186
187
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 180

def self.void_grant(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#expire(params = {}, opts = {}) ⇒ Object

Expires a credit grant.



130
131
132
133
134
135
136
137
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 130

def expire(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#void_grant(params = {}, opts = {}) ⇒ Object

Voids a credit grant.



170
171
172
173
174
175
176
177
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 170

def void_grant(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end