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, CreateParams, ExpireParams, ListParams, UpdateParams, VoidGrantParams

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

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



204
205
206
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 204

def amount
  @amount
end

#applicability_config ⇒ Object (readonly)

Attribute for field applicability_config



206
207
208
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 206

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.



208
209
210
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 208

def category
  @category
end

#created ⇒ Object (readonly)

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



210
211
212
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 210

def created
  @created
end

#customer ⇒ Object (readonly)

ID of the customer receiving the billing credits.



212
213
214
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 212

def customer
  @customer
end

#effective_at ⇒ Object (readonly)

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



214
215
216
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 214

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.



216
217
218
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 216

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



218
219
220
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 218

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.



220
221
222
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 220

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.



222
223
224
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 222

def metadata
  @metadata
end

#name ⇒ Object (readonly)

A descriptive name shown in dashboard.



224
225
226
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 224

def name
  @name
end

#object ⇒ Object (readonly)

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



226
227
228
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 226

def object
  @object
end

#priority ⇒ Object (readonly)

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



228
229
230
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 228

def priority
  @priority
end

#test_clock ⇒ Object (readonly)

ID of the test clock this credit grant belongs to.



230
231
232
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 230

def test_clock
  @test_clock
end

#updated ⇒ Object (readonly)

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



232
233
234
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 232

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.



234
235
236
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 234

def voided_at
  @voided_at
end

Class Method Details

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

Creates a credit grant.



237
238
239
240
241
242
243
244
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 237

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.



257
258
259
260
261
262
263
264
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 257

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

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

Retrieve a list of credit grants.



267
268
269
270
271
272
273
274
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 267

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.



277
278
279
280
281
282
283
284
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 277

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.



297
298
299
300
301
302
303
304
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 297

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.



247
248
249
250
251
252
253
254
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 247

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.



287
288
289
290
291
292
293
294
 
# File 'lib/stripe/resources/billing/credit_grant.rb', line 287

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