Class: MetronomeSDK::Models::V1::CreditGrantListResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::CreditGrantListResponse

Defined in:

lib/metronome_sdk/models/v1/credit_grant_list_response.rb

Overview

See Also:

• Resources::V1::CreditGrants#list

Defined Under Namespace

Classes: Balance, GrantAmount, PaidAmount, Product

Instance Attribute Summary

• #balance ⇒ MetronomeSDK::Models::V1::CreditGrantListResponse::Balance

  The effective balance of the grant as of the end of the customer’s current billing period.

• #credit_grant_type ⇒ String^?
• #custom_fields ⇒ Hash{Symbol=>String}

  Custom fields to be added eg.

• #customer_id ⇒ String

  the Metronome ID of the customer.

• #deductions ⇒ Array<MetronomeSDK::Models::V1::CreditLedgerEntry>
• #effective_at ⇒ Time
• #expires_at ⇒ Time
• #grant_amount ⇒ MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount

  the amount of credits initially granted.

• #id ⇒ String

  the Metronome ID of the credit grant.

• #invoice_id ⇒ String^?

  the Metronome ID of the invoice with the purchase charge for this credit grant, if applicable.

• #name ⇒ String
• #paid_amount ⇒ MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount

  the amount paid for this credit grant.

• #pending_deductions ⇒ Array<MetronomeSDK::Models::V1::CreditLedgerEntry>
• #priority ⇒ Float
• #products ⇒ Array<MetronomeSDK::Models::V1::CreditGrantListResponse::Product>^?

  The products which these credits will be applied to.

• #reason ⇒ String^?
• #uniqueness_key ⇒ String^?

  Prevents the creation of duplicates.

Instance Method Summary

• #initialize(amount: , credit_type: ) ⇒ Object constructor

  the amount paid for this credit grant.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(amount: , credit_type: ) ⇒ Object

the amount paid for this credit grant

Parameters:

• amount (Float) (defaults to: )
• credit_type (MetronomeSDK::Models::CreditTypeData) (defaults to: ) —

  the credit type for the amount paid

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 110

Instance Attribute Details

#balance ⇒ MetronomeSDK::Models::V1::CreditGrantListResponse::Balance

The effective balance of the grant as of the end of the customer’s current billing period. Expiration deductions will be included only if the grant expires before the end of the current billing period.

Returns:

• (MetronomeSDK::Models::V1::CreditGrantListResponse::Balance)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 20

required :balance, -> { MetronomeSDK::Models::V1::CreditGrantListResponse::Balance }

#credit_grant_type ⇒ String^?

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 80

optional :credit_grant_type, String, nil?: true

#custom_fields ⇒ Hash{Symbol=>String}

Custom fields to be added eg. { “key1”: “value1”, “key2”: “value2” }

Returns:

• (Hash{Symbol=>String})

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 26

required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#customer_id ⇒ String

the Metronome ID of the customer

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 32

required :customer_id, String

#deductions ⇒ Array<MetronomeSDK::Models::V1::CreditLedgerEntry>

Returns:

• (Array<MetronomeSDK::Models::V1::CreditLedgerEntry>)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 37

required :deductions, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }

#effective_at ⇒ Time

Returns:

• (Time)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 42

required :effective_at, Time

#expires_at ⇒ Time

Returns:

• (Time)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 47

required :expires_at, Time

#grant_amount ⇒ MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount

the amount of credits initially granted

Returns:

• (MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 53

required :grant_amount, -> { MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount }

#id ⇒ String

the Metronome ID of the credit grant

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 12

required :id, String

#invoice_id ⇒ String^?

the Metronome ID of the invoice with the purchase charge for this credit grant, if applicable

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 87

optional :invoice_id, String, nil?: true

#name ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 58

required :name, String

#paid_amount ⇒ MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount

the amount paid for this credit grant

Returns:

• (MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 64

required :paid_amount, -> { MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount }

#pending_deductions ⇒ Array<MetronomeSDK::Models::V1::CreditLedgerEntry>

Returns:

• (Array<MetronomeSDK::Models::V1::CreditLedgerEntry>)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 69

required :pending_deductions,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }

#priority ⇒ Float

Returns:

• (Float)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 75

required :priority, Float

#products ⇒ Array<MetronomeSDK::Models::V1::CreditGrantListResponse::Product>^?

The products which these credits will be applied to. (If unspecified, the credits will be applied to charges for all products.)

Returns:

• (Array<MetronomeSDK::Models::V1::CreditGrantListResponse::Product>, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 94

optional :products,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CreditGrantListResponse::Product] }

#reason ⇒ String^?

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 100

optional :reason, String, nil?: true

#uniqueness_key ⇒ String^?

Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_response.rb', line 108

optional :uniqueness_key, String, nil?: true