Class: Dodopayments::Models::SubscriptionRetrieveCreditUsageResponse::Item

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(balance:, credit_entitlement_id:, credit_entitlement_name:, limit_reached:, overage:, overage_enabled:, unit:, overage_limit: nil, remaining_headroom: nil) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::SubscriptionRetrieveCreditUsageResponse::Item for more details.

Per-entitlement credit usage status for a subscription

Parameters:

  • balance (String) —

    Customer’s current credit balance for this entitlement (customer-wide)

  • credit_entitlement_id (String)
  • credit_entitlement_name (String)
  • limit_reached (Boolean) —

    True if overage has reached or exceeded the limit.

  • overage (String) —

    Current overage amount accrued (customer-wide)

  • overage_enabled (Boolean) —

    Whether overage is enabled for this entitlement on this subscription

  • unit (String) —

    Unit label for the credit entitlement (e.g. “API Calls”, “Tokens”)

  • overage_limit (String, nil) (defaults to: nil) —

    Maximum allowed overage before deductions are blocked.

  • remaining_headroom (String, nil) (defaults to: nil) —

    How much more overage can accumulate before being blocked.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 24

class Item < Dodopayments::Internal::Type::BaseModel
  # @!attribute balance
  #   Customer's current credit balance for this entitlement (customer-wide)
  #
  #   @return [String]
  required :balance, String

  # @!attribute credit_entitlement_id
  #
  #   @return [String]
  required :credit_entitlement_id, String

  # @!attribute credit_entitlement_name
  #
  #   @return [String]
  required :credit_entitlement_name, String

  # @!attribute limit_reached
  #   True if overage has reached or exceeded the limit. When true, further deductions
  #   that would increase overage will fail.
  #
  #   @return [Boolean]
  required :limit_reached, Dodopayments::Internal::Type::Boolean

  # @!attribute overage
  #   Current overage amount accrued (customer-wide)
  #
  #   @return [String]
  required :overage, String

  # @!attribute overage_enabled
  #   Whether overage is enabled for this entitlement on this subscription
  #
  #   @return [Boolean]
  required :overage_enabled, Dodopayments::Internal::Type::Boolean

  # @!attribute unit
  #   Unit label for the credit entitlement (e.g. "API Calls", "Tokens")
  #
  #   @return [String]
  required :unit, String

  # @!attribute overage_limit
  #   Maximum allowed overage before deductions are blocked. None means unlimited
  #   overage (when overage_enabled is true).
  #
  #   @return [String, nil]
  optional :overage_limit, String, nil?: true

  # @!attribute remaining_headroom
  #   How much more overage can accumulate before being blocked. None if overage is
  #   not enabled or there is no limit (unlimited). A value of 0 means the next
  #   deduction that increases overage will be blocked.
  #
  #   @return [String, nil]
  optional :remaining_headroom, String, nil?: true

  # @!method initialize(balance:, credit_entitlement_id:, credit_entitlement_name:, limit_reached:, overage:, overage_enabled:, unit:, overage_limit: nil, remaining_headroom: nil)
  #   Some parameter documentations has been truncated, see
  #   {Dodopayments::Models::SubscriptionRetrieveCreditUsageResponse::Item} for more
  #   details.
  #
  #   Per-entitlement credit usage status for a subscription
  #
  #   @param balance [String] Customer's current credit balance for this entitlement (customer-wide)
  #
  #   @param credit_entitlement_id [String]
  #
  #   @param credit_entitlement_name [String]
  #
  #   @param limit_reached [Boolean] True if overage has reached or exceeded the limit.
  #
  #   @param overage [String] Current overage amount accrued (customer-wide)
  #
  #   @param overage_enabled [Boolean] Whether overage is enabled for this entitlement on this subscription
  #
  #   @param unit [String] Unit label for the credit entitlement (e.g. "API Calls", "Tokens")
  #
  #   @param overage_limit [String, nil] Maximum allowed overage before deductions are blocked.
  #
  #   @param remaining_headroom [String, nil] How much more overage can accumulate before being blocked.
end

Instance Attribute Details

#balance ⇒ String

Customer’s current credit balance for this entitlement (customer-wide)

Returns:

  • (String) 


29
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 29

required :balance, String

#credit_entitlement_id ⇒ String

Returns:

  • (String) 


34
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 34

required :credit_entitlement_id, String

#credit_entitlement_name ⇒ String

Returns:

  • (String) 


39
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 39

required :credit_entitlement_name, String

#limit_reached ⇒ Boolean

True if overage has reached or exceeded the limit. When true, further deductions that would increase overage will fail.

Returns:

  • (Boolean) 


46
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 46

required :limit_reached, Dodopayments::Internal::Type::Boolean

#overage ⇒ String

Current overage amount accrued (customer-wide)

Returns:

  • (String) 


52
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 52

required :overage, String

#overage_enabled ⇒ Boolean

Whether overage is enabled for this entitlement on this subscription

Returns:

  • (Boolean) 


58
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 58

required :overage_enabled, Dodopayments::Internal::Type::Boolean

#overage_limit ⇒ String?

Maximum allowed overage before deductions are blocked. None means unlimited overage (when overage_enabled is true).

Returns:

  • (String, nil) 


71
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 71

optional :overage_limit, String, nil?: true

#remaining_headroom ⇒ String?

How much more overage can accumulate before being blocked. None if overage is not enabled or there is no limit (unlimited). A value of 0 means the next deduction that increases overage will be blocked.

Returns:

  • (String, nil) 


79
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 79

optional :remaining_headroom, String, nil?: true

#unit ⇒ String

Unit label for the credit entitlement (e.g. “API Calls”, “Tokens”)

Returns:

  • (String) 


64
 
# File 'lib/dodopayments/models/subscription_retrieve_credit_usage_response.rb', line 64

required :unit, String