Class: Stripe::Billing::CreditGrantCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/billing/credit_grant_create_params.rb

Defined Under Namespace

Classes: Amount, ApplicabilityConfig

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, applicability_config: nil, category: nil, customer: nil, effective_at: nil, expand: nil, expires_at: nil, metadata: nil, name: nil, priority: nil) ⇒ CreditGrantCreateParams

Returns a new instance of CreditGrantCreateParams.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 78

def initialize(
  amount: nil,
  applicability_config: nil,
  category: nil,
  customer: nil,
  effective_at: nil,
  expand: nil,
  expires_at: nil,
  metadata: nil,
  name: nil,
  priority: nil
)
  @amount = amount
  @applicability_config = applicability_config
  @category = category
  @customer = customer
  @effective_at = effective_at
  @expand = expand
  @expires_at = expires_at
  @metadata = metadata
  @name = name
  @priority = priority
end

Instance Attribute Details

#amount ⇒ Object

Amount of this credit grant.



58
59
60
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 58

def amount
  @amount
end

#applicability_config ⇒ Object

Configuration specifying what this credit grant applies to. We currently only support ‘metered` prices that have a [Billing Meter](docs.stripe.com/api/billing/meter) attached to them.



60
61
62
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 60

def applicability_config
  @applicability_config
end

#category ⇒ Object

The category of this credit grant. It defaults to ‘paid` if not specified.



62
63
64
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 62

def category
  @category
end

#customer ⇒ Object

ID of the customer to receive the billing credits.



64
65
66
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 64

def customer
  @customer
end

#effective_at ⇒ Object

The time when the billing credits become effective-when they’re eligible for use. It defaults to the current timestamp if not specified.



66
67
68
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 66

def effective_at
  @effective_at
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



68
69
70
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 68

def expand
  @expand
end

#expires_at ⇒ Object

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



70
71
72
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 70

def expires_at
  @expires_at
end

#metadata ⇒ Object

Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.



72
73
74
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 72

def metadata
  @metadata
end

#name ⇒ Object

A descriptive name shown in the Dashboard.



74
75
76
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 74

def name
  @name
end

#priority ⇒ Object

The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.



76
77
78
 
# File 'lib/stripe/params/billing/credit_grant_create_params.rb', line 76

def priority
  @priority
end