module ChargebeeRails

guides.rubyonrails.org/generators.html

Public Class Methods

add_customer_contacts(customer, options={}) click to toggle source

Add contacts to a chargebee customer, the subscription owner and the contact details hash is given as options.

  • Args :

    • customer -> the subscription owner

    • options -> the options hash allowed for adding contacts to customer in chargebee

For more details on the options hash, refer the input parameters for apidocs.chargebee.com/docs/api/customers?lang=ruby#add_contacts_to_a_customer

  • Returns :

    • the updated chargebee customer

  • Raises :

    • ChargeBee::InvalidRequestError -> If customer or options is invalid

# File lib/chargebee_rails.rb, line 67
def self.add_customer_contacts(customer, options={})
  ChargeBee::Customer.add_contact(customer.chargebee_id, options).customer
end
update_billing_info(customer, options={}) click to toggle source

Update the billing information of the chargebee customer. The changes in the billing details are also reflected in the subscription owner's chargebee_customer_data

  • Args :

    • customer -> the subscription owner

    • options -> the options hash allowed for updating customer billing info in chargebee

For more details on the options hash, refer the input parameters for apidocs.chargebee.com/docs/api/customers?lang=ruby#update_billing_info_for_a_customer

  • Returns :

    • the updated subscription owner

  • Raises :

    • ChargeBee::InvalidRequestError -> If customer or options is invalid

# File lib/chargebee_rails.rb, line 49
def self.update_billing_info(customer, options={})
  chargebee_customer = ChargeBee::Customer.update_billing_info(customer.chargebee_id, options).customer
  customer.update(chargebee_id: chargebee_customer.id, chargebee_data: chargebee_customer_data(chargebee_customer))
  customer
end
update_customer(customer, options={}) click to toggle source

This method is used to update the chargebee customer and also reflects the changes to the subscription owner in the application.

  • Args :

    • customer -> the subscription owner

    • options -> the options hash allowed for customer update in chargebee

For more details on the options hash, refer the input parameters for apidocs.chargebee.com/docs/api/customers?lang=ruby#update_a_customer

  • Returns :

    • the updated subscription owner

  • Raises :

    • ChargeBee::InvalidRequestError -> If customer or options is invalid

# File lib/chargebee_rails.rb, line 30
def self.update_customer(customer, options={})
  chargebee_customer = ChargeBee::Customer.update(customer.chargebee_id, options).customer
  customer.update(chargebee_id: chargebee_customer.id, chargebee_data: chargebee_customer_data(chargebee_customer))
  customer
end
update_customer_contacts(customer, options={}) click to toggle source

Update the contacts for a chargebee customer - the chargebee contact id must be passed in the options to update the existing contact for the subscription owner

  • Args :

    • customer -> the subscription owner

    • options -> the options hash allowed for updating customer contacts in chargebee

For more details on the options hash, refer the input parameters for apidocs.chargebee.com/docs/api/customers?lang=ruby#update_contacts_for_a_customer

  • Returns :

    • the updated chargebee customer

  • Raises :

    • ChargeBee::InvalidRequestError -> If customer or options is invalid

# File lib/chargebee_rails.rb, line 84
def self.update_customer_contacts(customer, options={})
  ChargeBee::Customer.update_contact(customer.chargebee_id, options).customer
end

Private Instance Methods

billing_address(customer_billing_address) click to toggle source 
# File lib/chargebee_rails.rb, line 107
def billing_address customer_billing_address
  {
    first_name: customer_billing_address.first_name,
    last_name: customer_billing_address.last_name,
    company: customer_billing_address.company,
    address_line1: customer_billing_address.line1,
    address_line2: customer_billing_address.line2,
    address_line3: customer_billing_address.line3,
    city: customer_billing_address.city,
    state: customer_billing_address.state,
    country: customer_billing_address.country,
    zip: customer_billing_address.zip
  } if customer_billing_address.present?
end
chargebee_customer_data(customer) click to toggle source 
# File lib/chargebee_rails.rb, line 90
def chargebee_customer_data customer
  {
    customer_details: customer_details(customer),
    billing_address: billing_address(customer.billing_address)
  }
end
customer_details(customer) click to toggle source 
# File lib/chargebee_rails.rb, line 97
def customer_details customer
  {
    first_name: customer.first_name,
    last_name: customer.last_name,
    email: customer.email,
    company: customer.company,
    vat_number: customer.vat_number
  }
end