Welcome to Apps in Recurpay. This extends the functionality of your subscription store. These integrations enable developers and partners to build tools that interact with Recurpay's APIs, allowing for deeper customization, workflow automation, and enhanced subscriber experiences.

Getting Started

With apps, you can:

• 📢 Custom Features: Add unique capabilities to the Recurpay subscription experience tailored to specific use cases. Whether it’s a UI enhancement, custom logic, or a new custom flow on the customer account, Custom Feature apps allow you to enrich the way merchants and subscribers interact with your store.
• 📢 Automations and Flows: Streamline repetitive tasks by creating apps that automate billing, customer engagement, renewals, or other workflows. These apps help merchants save time and reduce errors while improving operational efficiency.
• 📢 Connector: Seamlessly integrate Recurpay with other platforms like CRMs, ERPs, marketing tools, or fulfillment services. Connector apps ensure that data flows smoothly across systems, enhancing the overall merchant ecosystem.
• 📢 Analytics: Deliver actionable insights with real-time dashboards, reporting tools, or predictive analytics. Analytics apps empower merchants to monitor performance, identify trends, and make data-driven decisions with confidence.
• 📢 Loyalty: Boost customer retention with loyalty apps that offer rewards, referrals, and personalized offers. These integrations help merchants build deeper relationships with subscribers and drive long-term engagement.

Each app can be installed, configured, and managed by merchants through the Recurpay dashboard, providing a seamless way to enhance their store functionality.

Available Endpoints:

• Retrieve a list of apps: Get all available apps.
• Retrieve a single app: Get details for a specific app.
• Create a new app: Register a new app with Recurpay.
• Update an app: Modify app, such as scopes, callback URL, or icons.

Authentication:

Basic authentication is required to interact with the Recurpay App APIs. Partners must authenticate using the registered email and password associated with their Recurpay Partner account.

📘

Authorization: Basic base64(email:password)

🔐 Example: If your email is[email protected]and your password is securepass, encode it as:
[email protected]:securepass→ Base64 → ZGV2ZWxvcGVyQGV4YW1wbGUuY29tOnNlY3VyZXBhc3M=

Your request header will look like: Authorization: Basic ZGV2ZWxvcGVyQGV4YW1wbGUuY29tOnNlY3VyZXBhc3M=

Important Notes:

• Always use HTTPS to ensure your credentials are transmitted securely.
• Keep your credentials safe and avoid exposing them in frontend applications or unsecured environments.
• In future updates, Recurpay may introduce token-based authentication for enhanced security.

Scopes:

Scopes define the level of access your app has to various parts of the Recurpay API. When creating or configuring an app, you must specify which scopes are required based on the data and actions your app needs.

Plans

• read-plans: View available subscription plans.
• write-plans: Create, update, or delete subscription plans.

Customers

• read-customers: Retrieve subscriber details.
• write-customers: Add or modify subscriber information.

Orders

• read-orders: Access details of subscription orders.
• write-orders: Create or update order records.

Subscriptions

• read-subscriptions: View subscriptions.
• write-subscriptions: Create, modify, or cancel subscriptions.

Payments

• read-payments: Access payment history and status.
• write-payments: Trigger payment retries or handle manual payments (if applicable).

Webhooks

• read-webhooks: View configured webhooks for event tracking.
• write-webhooks: Register or manage webhook endpoints.

Script Tags

• read-script-tags: View injected script tags on customer account, bundle (if applicable).
• write-script-tags: Add or update scripts for advanced customizations or tracking.

Coupons

• read-coupons: View discount codes and coupon settings.
• write-coupons: Create or manage promotional coupon codes.