Skip to main content

Chargebee

Integrating Chargebee with Osano​

Connecting to Chargebee​

In order for Osano to discover data stored in your systems, we must connect to those data providers via an API. We require, at minimum, read-only access to establish a connection to these providers. Each provider you connect may require different information. Please see the linked vendor documentation (below) for instructions on where and how to obtain this data.

Required Fields​

  • API Key
  • Site Name

Instructions for obtaining your Chargebee API Key.

Your site name will be the value that appears in your URL when you log in to Chargebee. Example: If our Chargebee domain is osano-test.chargebee.com, the Site Name is osano-test.

Auth​

  • Token Based

Endpoints​

Used for data discovery

  • GET /customers
  • GET /subscriptions
  • GET /promotional_credits
  • GET /invoices
  • GET /credit_notes
  • GET /unbilled_charges GET /orders
  • GET /gifts
  • GET /transactions
  • GET /quotes

Used for user search

  • GET /customers?email[is]={{email}}
  • GET /subscriptions?customer_id[is]={{customerId}}
  • GET /promotional_credits?customer_id[is]={{customerId}}
  • GET /invoices?customer_id[is]={{customerId}}
  • GET /credit_notes?customer_id[is]={{customerId}}
  • GET /unbilled_charges?customer_id[is]={{customerId}}
  • GET /orders?customer_id[is]={{customerId}}
  • GET /gifts?customer_id[is]={{customerId}}
  • GET /transactions?customer_id[is]={{customerId}}
  • GET /quotes?customer_id[is]={{customerId}}