Class: Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit

Defined in:

lib/stigg/models/v1/subscription_provision_params.rb

Defined Under Namespace

Modules: Cadence

Instance Attribute Summary

• #amount ⇒ Float

  Credit grant amount.

• #cadence ⇒ Symbol, Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit::Cadence

  Credit grant cadence (MONTH or YEAR).

• #id ⇒ String

  The custom currency ID for the credit entitlement.

• #type ⇒ Symbol, :CREDIT

  SubscriptionCreditEntitlementRequest.

Instance Method Summary

• #initialize(id:, amount:, cadence:, type: :CREDIT) ⇒ Object constructor

  Credit entitlement configuration for a subscription.

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(id:, amount:, cadence:, type: :CREDIT) ⇒ Object

Credit entitlement configuration for a subscription

Parameters:

• id (String) —

  The custom currency ID for the credit entitlement

• amount (Float) —

  Credit grant amount

• cadence (Symbol, Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit::Cadence) —

  Credit grant cadence (MONTH or YEAR)

• type (Symbol, :CREDIT) (defaults to: :CREDIT) —

  SubscriptionCreditEntitlementRequest

# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1084

Instance Attribute Details

#amount ⇒ Float

Credit grant amount

Returns:

• (Float)

# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1070

required :amount, Float

#cadence ⇒ Symbol, Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit::Cadence

Credit grant cadence (MONTH or YEAR)

Returns:

• (Symbol, Stigg::Models::V1::SubscriptionProvisionParams::Entitlement::Credit::Cadence)

# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1076

required :cadence, enum: -> { Stigg::V1::SubscriptionProvisionParams::Entitlement::Credit::Cadence }

#id ⇒ String

The custom currency ID for the credit entitlement

Returns:

• (String)

# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1064

required :id, String

#type ⇒ Symbol, :CREDIT

SubscriptionCreditEntitlementRequest

Returns:

• (Symbol, :CREDIT)

# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1082

required :type, const: :CREDIT