Integrating your App with Chargebee

​

Developing an App to Integrate with Chargebee

​

Steps to Develop Your Application

1. Understand the OpenAPI Specification: Review the OpenAPI specification and integration details to design and build an app with seamless functionality.
2. Implement SPI-Defined Endpoints: Develop endpoints as outlined in the SPI documentation to ensure compatibility with Chargebee’s ecosystem.
3. Adhere to Requirements: Review the General Requirements and Technical Requirements to ensure compliance with Chargebee’s guidelines.
4. Test the Integration: Perform both API Testing and End-to-End Testing to ensure a seamless integration with Chargebee:
   • API Testing: Validate and test your App using the provided Postman collection.
   • End-to-End Testing: Test all required Chargebee use cases by integrating your app with Chargebee’s sandbox environment. To request sandbox access, follow -> Step 3.

​

Onboarding Process for Apps via SPI

​

General Requisites

1. Compliance with PII Standards
   • Ensure your app complies with Personal Identifiable Information (PII) standards.
   • Handle merchant-specific confidential data securely and in accordance with PII guidelines.
   • Refer to Chargebee’s Security and Compliance Guidelines to meet data privacy and security requirements.
   • Provide Service Level Agreements (SLAs) that address data deletion requirements.
2. Traffic Management
   • Accept traffic only from allow-listed servers to maintain secure interactions within Chargebee’s ecosystem.
3. Legal Agreements
   • Sign a formal agreement with Chargebee to establish clear terms and conditions.
4. Responsibilities as a Solution Provider
   • Execute agreements directly with merchants using your app.
   • Clearly define the scope of data accessed from Chargebee, including customer and transaction details.
5. Pre-Go-Live Deliverables Submit the following details to the Chargebee team:
   • Escalation Matrix: Define critical issue resolution steps.
   • Merchant Support Email: Provide contact information for merchant queries.
   • Partner Support Email: Share a dedicated technical support email.
   • Merchant User Guides: Include links to detailed guides for merchants.
   • Configuration Documentation: Explain configurations such as managing API keys and importing plans.
6. System Status and Maintenance Updates
   • Maintain a public external product status page to communicate system outages and scheduled maintenance. This status page must reflect the health status of both the actual service provider and the application.
7. Terms, Consent, and Privacy Policies
   • Publish the following policies on your website:
     • Terms of Service
     • Consent Policy
     • Privacy Policy

​

Technical Requisites

1. Availability
   • Ensure 99.9% uptime for your app.
   • Provide advance notice for scheduled downtime to minimize disruptions. Note: Uninformed downtimes may lead to the app being delisted from the marketplace.
2. Rate Limiting
   • Rate limiting is enforced based on the Chargebee customer’s subscription plan. Detailed information is available here
   • The App must account for these rate limits and implement appropriate mechanisms to handle requests within the allowed capacity.
3. Latency

• Respond within a maximum latency of 250ms per request. Latencies exceeding this threshold are considered unacceptable.

4. Quality
   • Provide a consistent and positive experience to merchants.
5. Security & Certifications

• Use Transport Layer Security (TLS) for all communication to ensure a secure channel.
• Obtain PII compliance certification to proceed with agreements as Chargebee shares customers’ data.

7. Concurrency Handling

• Ensure your application can handle concurrent requests effectively for seamless operation during peak loads.

​

Go Live Steps

1. Fill Configuration & Capability

• Fill the configuration and capability details of your app here and generate the JSON.
• Use the JSON Schema for reference.

2. Submit Details to Chargebee

• Send the completed configurations, capabilities details, and test suite results to the Chargebee team at taxation@chargebee.com(Update Chargebee Partners EmailID).

3. Internal Review & Testing

• Reach out to the Partnership Team for access to the Chargebee production sandbox site.
• In parallel develop and test the app service based on the requirements mentioned here: Developing an App to Integrate with Chargebee.
• Once submitted, Chargebee’s internal review team will test your integration through a combination of manual and automated testing.
• Your integration will also undergo stress testing to ensure it can handle Chargebee’s peak loads.

4. Marketplace Listing Form

• After the review team approves your app, fill out the marketplace listing form which will be provided by Chargebee team. This form will include:
• Details to be published on your app’s landing page on the Chargebee marketplace.
• Product screenshots or videos as required.

5. Accept the Marketplace Agreement

• Review and accept the marketplace agreement with Chargebee.

​

Publishing Your App on the Marketplace

​

Why Publish on the Chargebee Marketplace?

• Visibility: The marketplace is a platform where merchants discover and install apps to extend Chargebee’s capabilities.
• Ease of Use: By listing your app, merchants can install it with a single click and start using it immediately.
• Promotion: Leverage Chargebee’s marketing channels to reach a broader audience of merchants.

​

Publication Process

1. Private App Launch

• Initially, your app will be published as a private app on the marketplace.
• Merchants can access private apps through a private URL, enabled via backend configuration. To gain access, merchants must contact Chargebee support.

2. Transition to Public App

• Once at least five merchants actively use your integration, you can request to make your app public by contacting taxation@chargebee.com.
• Chargebee’s team will review your request and approve your app for public listing.