ReCharge API Client
Ruby client for ReCharge Payments' recurring payments API for Shopify.
Installation
Ruby gems:
gem install recharge-api
Bundler:
gem "recharge-api", :require => "recharge"
Usage
require "recharge"
ReCharge.api_key = "YOUR_KEY" # Can also use Recharge
data = {
:address_id => 123234321,
:customer_id => 565728,
# ... more stuff
:next_charge_scheduled_at => Time.new,
:properties => {
:name => "size",
:value => "medium"
}
}
subscription = ReCharge::Subscription.create(data)
subscription.address_id = 454343
subscription.save
# Or
ReCharge::Subscription.update(id, data)
subscription = ReCharge::Subscription.new(data)
subscription.save
order1 = ReCharge::Order.get(123123)
order1.line_items.each do |li|
p li.title
p li.quantity
end
order2 = ReCharge::Order.get(453321)
p "Different" if order1 != order2
JSON.dump(order2.to_h)
customers = ReCharge::Customer.list(:page => 10, :limit => 50)
customers.each do |customer|
addresses = ReCharge::Customer.addresses(customer.id)
# ...
end
For complete documentation refer to the API docs: http://rdoc.info/gems/recharge-api
Rake Tasks for Webhook Management
Requiring recharge/tasks
will include several Rake tasks for webhook management.
All tasks require RECHARGE_API_KEY
be set.
The hooks are:
recharge:hook:create
- create webhookHOOK
to be sent toCALLBACK
recharge:hooks:delete
- delete the webhook(s) given byID
recharge:hooks:delete_all
- delete all webhooksrecharge:hooks:list
- list webhooks
License
Released under the MIT License: www.opensource.org/licenses/MIT
Made by ScreenStaring