Automate Chargebee Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access Chargebee data from PowerShell? This article demonstrates how to utilize the Chargebee Cmdlets for tasks like connecting to Chargebee data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to Chargebee.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for Chargebee; this tutorial shows how to use the Provider to retrieve Chargebee data.

Once you have acquired the necessary connection properties, accessing Chargebee data in PowerShell can be enabled in three steps.

Start by setting the Profile connection property to the location of the Chargebee Profile on disk (e.g. C:\profiles\Chargebee.apip). Next, set the ProfileSettings connection property to the connection string for Chargebee (see below).

Chargebee API Profile Settings

Generate an API Key from your Chargebee account via Settings > Configure Chargebee > API Keys and Webhooks. Your site name is the subdomain from your Chargebee account URL.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
        
  2. Connect to Chargebee:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Chargebee.apip;ProfileSettings='APIKey=your_api_key;Site=your_site_name';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, Name from Addons"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.id $_.name
    }
      

Ready to get started?

Connect to live data from Chargebee with the API Driver

Connect to Chargebee