Class: Recurly::Requests::UsageCreate
- Inherits:
-
Recurly::Request
- Object
- Recurly::Request
- Recurly::Requests::UsageCreate
- Defined in:
- lib/recurly/requests/usage_create.rb
Instance Attribute Summary collapse
-
#amount ⇒ Float
The amount of usage.
-
#merchant_tag ⇒ String
Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
-
#recording_timestamp ⇒ DateTime
When the usage was recorded in your system.
-
#usage_timestamp ⇒ DateTime
When the usage actually happened.
Attributes inherited from Recurly::Request
Method Summary
Methods inherited from Recurly::Request
Methods included from Schema::SchemaFactory
Methods included from Schema::RequestCaster
Methods included from Schema::ResourceCaster
Methods included from Schema::SchemaValidator
#get_did_you_mean, #validate!, #validate_attribute!
Instance Attribute Details
#amount ⇒ Float
Returns The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is “500”).
11 |
# File 'lib/recurly/requests/usage_create.rb', line 11 define_attribute :amount, Float |
#merchant_tag ⇒ String
Returns Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
15 |
# File 'lib/recurly/requests/usage_create.rb', line 15 define_attribute :merchant_tag, String |
#recording_timestamp ⇒ DateTime
Returns When the usage was recorded in your system.
19 |
# File 'lib/recurly/requests/usage_create.rb', line 19 define_attribute :recording_timestamp, DateTime |
#usage_timestamp ⇒ DateTime
Returns When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
23 |
# File 'lib/recurly/requests/usage_create.rb', line 23 define_attribute :usage_timestamp, DateTime |