Skip to main content

Chargebee Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a sync or streaming data flow that sends data to a Chargebee location.
chargebee_api.png

Chargebee

Create a Chargebee Destination​

  1. Click the + icon on the Nexset that will be sent to the Chargebee destination, and select the Send to Destination option from the menu.

  2. Select the Chargebee connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Chargebee organization, and click Next; or, create a new Chargebee credential for use in this flow.

  3. In Nexla, Chargebee destinations can be created using pre-built endpoint templates, which expedite destination setup for common Chargebee endpoints. Each template is designed specifically for the corresponding Chargebee endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Chargebee destinations can also be configured manually, allowing you to send data to Chargebee endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Chargebee endpoints. Each template is designed specifically for the corresponding Chargebee endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create a Customer

    This endpoint creates a new customer in your Chargebee account. Use this endpoint when you need to create customer records from your data sources, such as importing customer information or creating new customer accounts.

    • The endpoint uses POST requests to https://{site}.chargebee.com/api/v2/customers where {site} is your Chargebee site identifier from the credential configuration. The endpoint URL is automatically constructed based on your credential's site configuration.
    • The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the customer data to create. The request body should follow the Chargebee API v2 specification for creating customers, including required fields and field names.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a customer. If you need to create multiple customers, you can send multiple records, but each will be processed as a separate request.

    The request body must be properly formatted JSON that matches the Chargebee API v2 specification for creating customers. The endpoint requires Basic Authentication with your API key as the username, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating customers, including required fields, field names, and request formats, see the Chargebee API documentation.

    Create an order

    This endpoint creates a new order in your Chargebee account. Use this endpoint when you need to create order records from your data sources, such as importing order information or creating new orders.

    • The endpoint uses POST requests to https://{site}.chargebee.com/api/v2/orders where {site} is your Chargebee site identifier from the credential configuration. The endpoint URL is automatically constructed based on your credential's site configuration.
    • The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the order data to create. The request body should follow the Chargebee API v2 specification for creating orders, including required fields and field names.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create an order. If you need to create multiple orders, you can send multiple records, but each will be processed as a separate request.

    The request body must be properly formatted JSON that matches the Chargebee API v2 specification for creating orders. The endpoint requires Basic Authentication with your API key as the username, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating orders, including required fields, field names, and request formats, see the Chargebee API documentation.

Configure Manually​

Chargebee destinations can be manually configured to send data to any valid Chargebee API v2 endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Chargebee API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Chargebee API from the Method pulldown menu. The Chargebee API v2 primarily uses POST requests for data writing operations. The most common methods are:

    • POST: For creating new resources (e.g., creating customers, creating orders)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

Data Format​

  1. Select the format in which the Nexset data will be sent to the Chargebee API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Chargebee API v2 typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Chargebee API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Chargebee API endpoints typically follow the pattern https://{site}.chargebee.com/api/v2/{endpoint_path} where {site} is your Chargebee site identifier.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Basic Authentication with your API key as the username, which is handled automatically by your credential configuration. For detailed information about Chargebee API endpoints and available APIs, see the Chargebee API documentation.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization (Basic Auth), Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. The Chargebee API v2 requires Basic Authentication with your API key as the username, which is handled automatically by your credential configuration. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Request Body​

Optional

  • If the API endpoint requires a specific request body format, configure how Nexla should format the request body from your Nexset data. The request body can be sent as JSON, XML, or form data, depending on the API endpoint requirements.

    • For JSON format, select JSON from the Request Body Format dropdown, and the Nexset data will be sent as a JSON object in the request body. Chargebee API v2 endpoints typically use JSON format for request bodies.

    • For XML format, select XML from the Request Body Format dropdown, and the Nexset data will be converted to XML format in the request body.

    • For Form data format, select Form Data from the Request Body Format dropdown, and the Nexset data will be sent as form-encoded data in the request body.

Save the Destination​

  1. Once all configuration steps have been completed, click the Save button to save your destination configuration.

  2. The destination will now be available in your data flow and will begin sending data to the Chargebee endpoint according to the configured settings.