`usage_credits`

Demo app for the 💳✨ usage_credits gem

The basics: get and spend credits

Subscribe to a plan:

Subscribe to PRO (10 credits/mo)

Buy credit packs:

Get arbitrary bonuses:

Spend credits:

Ledger status

Date	Amount	Category	Expiration
`Nov 05, 6:09 AM`	+20 credits	referral_bonus referral	–
`Nov 05, 6:09 AM`	+10 credits	bonus expiring_bonus_credits	🗑️ expired
`Nov 05, 6:09 AM`	+10 credits	signup_bonus signup	–
`Nov 05, 6:09 AM`	+10 credits	subscription_credits first_cycle	expires in 29 days
`Nov 05, 6:09 AM`	+1000 credits	credit_pack_purchase	–
`Nov 05, 6:09 AM`	+10 credits	credit_pack_purchase	–
`Nov 05, 6:09 AM`	+5100 credits	credit_pack_purchase	–

Payment records (`pay` gem)

The user has paid $248.99 total

Pay::Charge (3)

# {
                        :id => 1593,
               :customer_id => 2518,
           :subscription_id => nil,
              :processor_id => "bp5rmqLNAUFFjACDFEyiu",
                    :amount => 99,
                  :currency => nil,
    :application_fee_amount => nil,
           :amount_refunded => nil,
                  :metadata => {
         "purchase_type" => "credit_pack",
             "pack_name" => "tiny",
               "credits" => 10,
         "bonus_credits" => 0,
           "price_cents" => 99,
        "price_currency" => "USD"
    },
                      :data => {
        "payment_method_type" => "card",
                      "brand" => "Fake",
                      "last4" => 1234,
                  "exp_month" => 11,
                   "exp_year" => 2025
    },
            :stripe_account => nil,
                :created_at => 2025-11-05 06:09:00.999578000 UTC +00:00,
                :updated_at => 2025-11-05 06:09:00.999578000 UTC +00:00,
                      :type => "Pay::FakeProcessor::Charge"
}

# {
                        :id => 1592,
               :customer_id => 2518,
           :subscription_id => nil,
              :processor_id => "h6c8eDWaf2RdfsPkVDHMw",
                    :amount => 4900,
                  :currency => nil,
    :application_fee_amount => nil,
           :amount_refunded => nil,
                  :metadata => {
         "purchase_type" => "credit_pack",
             "pack_name" => "starter",
               "credits" => 1000,
         "bonus_credits" => 0,
           "price_cents" => 4900,
        "price_currency" => "USD"
    },
                      :data => {
        "payment_method_type" => "card",
                      "brand" => "Fake",
                      "last4" => 1234,
                  "exp_month" => 11,
                   "exp_year" => 2025
    },
            :stripe_account => nil,
                :created_at => 2025-11-05 06:09:00.990574000 UTC +00:00,
                :updated_at => 2025-11-05 06:09:00.990574000 UTC +00:00,
                      :type => "Pay::FakeProcessor::Charge"
}

# {
                        :id => 1594,
               :customer_id => 2518,
           :subscription_id => nil,
              :processor_id => "zw6PcLgq5Lsqjn8-z1fd-",
                    :amount => 19900,
                  :currency => nil,
    :application_fee_amount => nil,
           :amount_refunded => nil,
                  :metadata => {
         "purchase_type" => "credit_pack",
             "pack_name" => "pro",
               "credits" => 5000,
         "bonus_credits" => 100,
           "price_cents" => 19900,
        "price_currency" => "USD"
    },
                      :data => {
        "payment_method_type" => "card",
                      "brand" => "Fake",
                      "last4" => 1234,
                  "exp_month" => 11,
                   "exp_year" => 2025
    },
            :stripe_account => nil,
                :created_at => 2025-11-05 06:09:01.006760000 UTC +00:00,
                :updated_at => 2025-11-05 06:09:01.006760000 UTC +00:00,
                      :type => "Pay::FakeProcessor::Charge"
}

Pay::Subscription (1)

# {
                         "id" => 909,
                "customer_id" => 2518,
                       "name" => "default",
               "processor_id" => "rrTJiaLZ8SmZCdKdPthuZ",
             "processor_plan" => "abcdef123456",
                   "quantity" => 1,
                     "status" => "active",
       "current_period_start" => nil,
         "current_period_end" => nil,
              "trial_ends_at" => nil,
                    "ends_at" => nil,
                    "metered" => nil,
             "pause_behavior" => nil,
            "pause_starts_at" => nil,
           "pause_resumes_at" => nil,
    "application_fee_percent" => nil,
                   "metadata" => {
                   "purchase_type" => "credit_subscription",
               "subscription_name" => "test_plan",
              "fulfillment_period" => "1 month",
              "credits_per_period" => 10,
            "signup_bonus_credits" => 0,
                   "trial_credits" => 0,
                "rollover_enabled" => false,
        "expire_credits_on_cancel" => false,
        "credit_expiration_period" => nil,
                        "metadata" => {}
    },
                       "data" => nil,
             "stripe_account" => nil,
          "payment_method_id" => nil,
                 "created_at" => 2025-11-05 06:09:00.952453000 UTC +00:00,
                 "updated_at" => 2025-11-05 06:09:00.952453000 UTC +00:00,
                       "type" => "Pay::FakeProcessor::Subscription",
                    "prorate" => true
}

Model records

UsageCredits::Fulfillment (4)

# {
                          :id => 2500,
                   :wallet_id => 2523,
                 :source_type => "Pay::Subscription",
                   :source_id => 909,
    :credits_last_fulfillment => 10,
            :fulfillment_type => "subscription",
           :last_fulfilled_at => 2025-11-05 06:09:00.965378000 UTC +00:00,
         :next_fulfillment_at => 2025-12-05 06:09:00.952453000 UTC +00:00,
          :fulfillment_period => "1 month",
                    :stops_at => nil,
                    :metadata => {
        "subscription_id" => 909,
                   "plan" => "abcdef123456"
    },
                  :created_at => 2025-11-05 06:09:00.965982000 UTC +00:00,
                  :updated_at => 2025-11-05 06:09:00.965982000 UTC +00:00
}

# {
                          :id => 2501,
                   :wallet_id => 2523,
                 :source_type => "Pay::Charge",
                   :source_id => 1592,
    :credits_last_fulfillment => 1000,
            :fulfillment_type => "credit_pack",
           :last_fulfilled_at => 2025-11-05 06:09:00.994795000 UTC +00:00,
         :next_fulfillment_at => nil,
          :fulfillment_period => nil,
                    :stops_at => nil,
                    :metadata => {
        "purchase_charge_id" => 1592,
              "purchased_at" => "2025-11-05T06:09:00.990Z",
             "purchase_type" => "credit_pack",
                 "pack_name" => "starter",
                   "credits" => 1000,
             "bonus_credits" => 0,
               "price_cents" => 4900,
            "price_currency" => "USD"
    },
                  :created_at => 2025-11-05 06:09:00.995286000 UTC +00:00,
                  :updated_at => 2025-11-05 06:09:00.995286000 UTC +00:00
}

# {
                          :id => 2502,
                   :wallet_id => 2523,
                 :source_type => "Pay::Charge",
                   :source_id => 1593,
    :credits_last_fulfillment => 10,
            :fulfillment_type => "credit_pack",
           :last_fulfilled_at => 2025-11-05 06:09:01.002873000 UTC +00:00,
         :next_fulfillment_at => nil,
          :fulfillment_period => nil,
                    :stops_at => nil,
                    :metadata => {
        "purchase_charge_id" => 1593,
              "purchased_at" => "2025-11-05T06:09:00.999Z",
             "purchase_type" => "credit_pack",
                 "pack_name" => "tiny",
                   "credits" => 10,
             "bonus_credits" => 0,
               "price_cents" => 99,
            "price_currency" => "USD"
    },
                  :created_at => 2025-11-05 06:09:01.003185000 UTC +00:00,
                  :updated_at => 2025-11-05 06:09:01.003185000 UTC +00:00
}

# {
                          :id => 2503,
                   :wallet_id => 2523,
                 :source_type => "Pay::Charge",
                   :source_id => 1594,
    :credits_last_fulfillment => 5100,
            :fulfillment_type => "credit_pack",
           :last_fulfilled_at => 2025-11-05 06:09:01.010071000 UTC +00:00,
         :next_fulfillment_at => nil,
          :fulfillment_period => nil,
                    :stops_at => nil,
                    :metadata => {
        "purchase_charge_id" => 1594,
              "purchased_at" => "2025-11-05T06:09:01.006Z",
             "purchase_type" => "credit_pack",
                 "pack_name" => "pro",
                   "credits" => 5000,
             "bonus_credits" => 100,
               "price_cents" => 19900,
            "price_currency" => "USD"
    },
                  :created_at => 2025-11-05 06:09:01.010471000 UTC +00:00,
                  :updated_at => 2025-11-05 06:09:01.010471000 UTC +00:00
}

UsageCredits::Transaction (7)

# {
                :id => 4083,
         :wallet_id => 2523,
            :amount => 20,
          :category => "referral_bonus",
        :expires_at => nil,
    :fulfillment_id => nil,
          :metadata => {
        "reason" => "referral"
    },
        :created_at => 2025-11-05 06:09:00.704608000 UTC +00:00,
        :updated_at => 2025-11-05 06:09:00.704608000 UTC +00:00
}

# {
                :id => 4084,
         :wallet_id => 2523,
            :amount => 10,
          :category => "bonus",
        :expires_at => 2025-11-05 06:10:00.927612000 UTC +00:00,
    :fulfillment_id => nil,
          :metadata => {
        "reason" => "expiring_bonus_credits"
    },
        :created_at => 2025-11-05 06:09:00.929945000 UTC +00:00,
        :updated_at => 2025-11-05 06:09:00.929945000 UTC +00:00
}

# {
                :id => 4085,
         :wallet_id => 2523,
            :amount => 10,
          :category => "signup_bonus",
        :expires_at => nil,
    :fulfillment_id => nil,
          :metadata => {
        "reason" => "signup"
    },
        :created_at => 2025-11-05 06:09:00.937570000 UTC +00:00,
        :updated_at => 2025-11-05 06:09:00.937570000 UTC +00:00
}

# {
                :id => 4086,
         :wallet_id => 2523,
            :amount => 10,
          :category => "subscription_credits",
        :expires_at => 2025-12-05 06:14:00.952453000 UTC +00:00,
    :fulfillment_id => 2500,
          :metadata => {
        "subscription_id" => 909,
                 "reason" => "first_cycle",
                   "plan" => "abcdef123456",
           "fulfilled_at" => "2025-11-05T06:09:00.962Z"
    },
        :created_at => 2025-11-05 06:09:00.963802000 UTC +00:00,
        :updated_at => 2025-11-05 06:09:00.963802000 UTC +00:00
}

# {
                :id => 4087,
         :wallet_id => 2523,
            :amount => 1000,
          :category => "credit_pack_purchase",
        :expires_at => nil,
    :fulfillment_id => nil,
          :metadata => {
        "purchase_charge_id" => 1592,
              "purchased_at" => "2025-11-05T06:09:00.990Z",
         "credits_fulfilled" => true,
              "fulfilled_at" => "2025-11-05T06:09:00.992Z",
             "purchase_type" => "credit_pack",
                 "pack_name" => "starter",
                   "credits" => 1000,
             "bonus_credits" => 0,
               "price_cents" => 4900,
            "price_currency" => "USD"
    },
        :created_at => 2025-11-05 06:09:00.993457000 UTC +00:00,
        :updated_at => 2025-11-05 06:09:00.993457000 UTC +00:00
}

# {
                :id => 4088,
         :wallet_id => 2523,
            :amount => 10,
          :category => "credit_pack_purchase",
        :expires_at => nil,
    :fulfillment_id => nil,
          :metadata => {
        "purchase_charge_id" => 1593,
              "purchased_at" => "2025-11-05T06:09:00.999Z",
         "credits_fulfilled" => true,
              "fulfilled_at" => "2025-11-05T06:09:01.000Z",
             "purchase_type" => "credit_pack",
                 "pack_name" => "tiny",
                   "credits" => 10,
             "bonus_credits" => 0,
               "price_cents" => 99,
            "price_currency" => "USD"
    },
        :created_at => 2025-11-05 06:09:01.001766000 UTC +00:00,
        :updated_at => 2025-11-05 06:09:01.001766000 UTC +00:00
}

# {
                :id => 4089,
         :wallet_id => 2523,
            :amount => 5100,
          :category => "credit_pack_purchase",
        :expires_at => nil,
    :fulfillment_id => nil,
          :metadata => {
        "purchase_charge_id" => 1594,
              "purchased_at" => "2025-11-05T06:09:01.006Z",
         "credits_fulfilled" => true,
              "fulfilled_at" => "2025-11-05T06:09:01.008Z",
             "purchase_type" => "credit_pack",
                 "pack_name" => "pro",
                   "credits" => 5000,
             "bonus_credits" => 100,
               "price_cents" => 19900,
            "price_currency" => "USD"
    },
        :created_at => 2025-11-05 06:09:01.009030000 UTC +00:00,
        :updated_at => 2025-11-05 06:09:01.009030000 UTC +00:00
}

UsageCredits::Allocation (0)

none

Audit trail

[
    [0] [
        [0] "referral_bonus",
        [1] 20,
        [2] {
            "reason" => "referral"
        }
    ],
    [1] [
        [0] "bonus",
        [1] 10,
        [2] {
            "reason" => "expiring_bonus_credits"
        }
    ],
    [2] [
        [0] "signup_bonus",
        [1] 10,
        [2] {
            "reason" => "signup"
        }
    ],
    [3] [
        [0] "subscription_credits",
        [1] 10,
        [2] {
            "subscription_id" => 909,
                     "reason" => "first_cycle",
                       "plan" => "abcdef123456",
               "fulfilled_at" => "2025-11-05T06:09:00.962Z"
        }
    ],
    [4] [
        [0] "credit_pack_purchase",
        [1] 1000,
        [2] {
            "purchase_charge_id" => 1592,
                  "purchased_at" => "2025-11-05T06:09:00.990Z",
             "credits_fulfilled" => true,
                  "fulfilled_at" => "2025-11-05T06:09:00.992Z",
                 "purchase_type" => "credit_pack",
                     "pack_name" => "starter",
                       "credits" => 1000,
                 "bonus_credits" => 0,
                   "price_cents" => 4900,
                "price_currency" => "USD"
        }
    ],
    [5] [
        [0] "credit_pack_purchase",
        [1] 10,
        [2] {
            "purchase_charge_id" => 1593,
                  "purchased_at" => "2025-11-05T06:09:00.999Z",
             "credits_fulfilled" => true,
                  "fulfilled_at" => "2025-11-05T06:09:01.000Z",
                 "purchase_type" => "credit_pack",
                     "pack_name" => "tiny",
                       "credits" => 10,
                 "bonus_credits" => 0,
                   "price_cents" => 99,
                "price_currency" => "USD"
        }
    ],
    [6] [
        [0] "credit_pack_purchase",
        [1] 5100,
        [2] {
            "purchase_charge_id" => 1594,
                  "purchased_at" => "2025-11-05T06:09:01.006Z",
             "credits_fulfilled" => true,
                  "fulfilled_at" => "2025-11-05T06:09:01.008Z",
                 "purchase_type" => "credit_pack",
                     "pack_name" => "pro",
                       "credits" => 5000,
                 "bonus_credits" => 100,
                   "price_cents" => 19900,
                "price_currency" => "USD"
        }
    ]
]

Loaded config

Literal, raw config file

      # frozen_string_literal: true

UsageCredits.configure do |config|

  # Default test operations
  operation :small_operation do
    costs 1.credit
  end

  # operation :test_operation do
  #   costs 10.credits + 1.credits_per(:mb)
  #   validate ->(params) { params[:size].to_i <= 100.megabytes }, "File too large (max: 100 MB)"
  # end

  operation :prohibitive_operation do
    costs 1_000_000.credits
  end

  operation :this_operation_will_always_fail do
    costs 42.credits
  end


  # Define test credit packs
  credit_pack :tiny do
    gives 10.credits
    costs 99.cents
  end

  credit_pack :starter do
    gives 1000.credits
    costs 49.dollars
  end

  credit_pack :pro do
    gives 5000.credits
    bonus 100.credits  # Optional: give bonus credits
    costs 199.dollars
    currency :usd
  end


  # Define subscriptions
  subscription_plan :test_plan do
    processor_plan(:fake_processor, "abcdef123456")
    gives 10.credits.every(:month)
    unused_credits :expire
  end

  # Alert when balance drops below 100 credits
  # Set to nil to disable low balance alerts
  # config.low_balance_threshold = 20.credits

  # # Handle low credit balance alerts
  # config.on_low_balance do |user|
  #   # Send notification to user when their balance drops below the threshold
  #   ApplicationMailer.generic_email(to: user.email, body: "Heads up! You're low on credits.", subject: "Low credits alert").deliver_now
  # end

end

Credit-consuming operations

small_operation
cost_calculator: #<UsageCredits::Cost::Fixed:0x00007a443cd32160>
validation_rules: []
prohibitive_operation
cost_calculator: #<UsageCredits::Cost::Fixed:0x00007a443cd32020>
validation_rules: []
this_operation_will_always_fail
cost_calculator: #<UsageCredits::Cost::Fixed:0x00007a443cd31f80>
validation_rules: []

Credit packs

tiny
credits: 10
bonus_credits: 0
total_credits: 10
credits_per_dollar: 10.1
price_cents: 99
price_currency: USD
formatted_price: 0.99 USD
display_name: Tiny pack
starter
credits: 1000
bonus_credits: 0
total_credits: 1000
credits_per_dollar: 20.41
price_cents: 4900
price_currency: USD
formatted_price: 49.00 USD
display_name: Starter pack
pro
credits: 5000
bonus_credits: 100
total_credits: 5100
credits_per_dollar: 25.63
price_cents: 19900
price_currency: USD
formatted_price: 199.00 USD
display_name: Pro pack

Credit subscription plans

test_plan
credits_per_period: 10
fulfillment_period: 2629746
rollover_enabled: false
processor_plan_ids: {:fake_processor=>"abcdef123456"}

Rest of the config

      {
  "default_currency": "usd",
  "rounding_strategy": "ceil",
  "credit_formatter": {},
  "fulfillment_grace_period": 300,
  "allow_negative_balance": false,
  "low_balance_threshold": null,
  "low_balance_callback": null
}