Zid Docs
Merchant APIPayment APIAppsThemes
Merchant APIPayment APIAppsThemes
Help Center
Slack
  1. Apps
  • Create your First App
  • Embedded Apps
  • App Scripts
  • App Events
  • App Subscription
    • Get Subscription Details
      GET
    • Update Usage-Based Charges
      POST
  1. Apps

Create your First App

To begin creating and developing subscription apps for the Zid App Market, ensure you have a registered partner account. Simply log in and follow the steps outlined below. Through the Partner Dashboard, you can build apps, test them on demo stores, launch them in the Zid App Market, and unlock new revenue opportunities!
ZAM Merchant Dashboard Frame (3).png
Subscription Apps
Shipping Apps

Create Your Draft App#

Navigate to My Apps from your Partner Dashboard. Click on Create Application button, and select Private/Public Application.
2024-09-09 13.29.46.gif
Begin by entering the basic details for your app, which will be displayed in Zid App Market to attract merchants!
ItemDescription
Application NameThe name of your app in Arabic an English as it will appear to merchants
App CategoriesChoose relevant categories (max 3) to help merchants find your app
Application LanguageSpecify the language(s) your app supports
Maintainer E-mailProvide an email address for merchant support and inquiries
image.png
Once you click on Create Application, your app will be saved as a draft. You can return and continue editing it at any time.

Configure App General Settings#

After creating your draft app, you'll be redirected to the App Details page, where you can complete the required app configuration.
1
View Your API Keys
To authorize your app for use by merchants, you'll need to access and use the following credentials from the App Keys section:
ItemDescription
OAuth 2.0 End-PointThe authorization URL for handling OAuth requests
Client IDThe unique identifier for your app
Client SecretThe secret key used to authenticate your app
image.png
2
Select App Scopes
App scopes define what features and services your app can access. In this section, choose the scopes required for your app's functionality. Be sure to provide clear justifications for each scope to help the review team approve your selections.
image.png
3
Embed Your App
Embedding your app allows merchants to seamlessly interact with it directly within merchant dashboard, enhancing the user experience by minimizing the need to navigate to external pages.
Before enabling the embed feature, ensure that you have selected the embedded apps in the App Scopes section.
image.png

Fill App Details#

1
Add App Links
Provide the necessary URLs to enable Zid merchants to access your application seamlessly. The following URLs are essential:
ItemDescription
Application URLThe main URL where your app is hosted and accessed by merchants
Redirection URLThe URL merchants will be redirected to after a successful installation
Callback URLThe URL used for communication between your app and Zid for OAuth integrations
image.png
2
Fill in App Description
Add a clear and concise description of your app that highlights its key features, functionalities, and benefits to merchants. This will help merchants understand the value your app brings to their store.
image.png
3
Define App Developer
Provide information about the app developer or the development company. This allows merchants to know who is behind the app and how they can reach out for support.
image.png
4
Add Media for Your app
Application Video: Showcase your app through a video that demonstrates how it works and the value it provides.
Supported format
Embedded YouTube video URL (e.g. https://www.youtube.com/embed/######)
image.png
Application Pictures: Add images that visually represent your app, its features, or interface.
You can add different images for both Arabic and English language settings. If no English-specific images are provided, the Arabic images will be used by default.
image.png
Application Icon: Upload a distinctive icon that will represent your app in Zid App Market and Merchant Dashboard.
image.png
5
Install on Development Stores
Set up your app on development stores after creating them, to test its functionality and ensure everything works as intended before making it publicly available.
image.png

Manage App Webhooks#

Subscribe to the available webhooks designed to provide your with real-time update about app subscriptions. Add your target Webhook URL in where you will be receiving the events you choose to listen to.
🔗
Learn more about webhook events and their conditions here
2024-09-10 14.27.48.gif

Add Plans and Prices#

The final step before submitting your app for review is to define pricing plans that merchants can choose and subscribe to.
CleanShot 2025-02-15 at 16.13.39@2x.png
1
Select Subscription Model
Choose the appropriate subscription model for your app based on how you want to charge merchants.
Recurring: Merchants are charged a fixed amount at regular intervals (e.g., monthly or yearly) for continuous access to the app’s features.
Usage-Based: Merchants are billed based on their actual consumption of a specific resource (e.g., per order, message, or API request), with costs varying according to usage.
2
Add App Plans
To publish your app, you must create at least one pricing plan, with a maximum of four.
🔁 Recurring Plans
App Recurring Plan.png
Adding Recurring Plan
FieldDescription
NameA clear and relevant name that highlights the plan’s features or pricing. This name will be visible to merchants.
DurationThe length of the plan’s subscription period, defining when the merchant's access starts and ends.
Trial PeriodOptionally, offer number of days merchants can use the app for free before committing to a subscription.
DescriptionA summary of what the plan offers, including any specific conditions or limitations.
FeaturesList up to five key features that highlight the value of the plan.
PriceThe fixed base price for the plan.
One-time FeeOptionally, apply an additional fee merchants pay only once, such as an installation or setup fee.
OfferOptionally, apply a discount to attract new merchants by selecting an offer type and specifying the discount rate.
📶 Usage-Based Plans
App Usage-Based Plan
Adding Usage-Based Plan
FieldDescription
NameA clear and relevant name that highlights the plan’s features or pricing. This name will be visible to merchants.
DescriptionA brief overview of the plan, including what it offers, the billing cycle, and any constraints.
FeaturesList up to five key features that highlight the value of the plan.
Usage TypeThe unit of measurement for usage-based billing. Merchants will be charged based on their consumption.
Initial CostA one-time fee merchants must pay to activate their subscription before incurring usage-based charges.

Manage Private Plans#

In this section, you can offer merchants the option to request custom plans if the available public plans don’t meet their needs.
Enable Private Plans
Activate this option to allow merchants to request tailored pricing plans directly from your app’s page in the merchant dashboard.
CleanShot 2025-02-15 at 16.23.22@2x.png
Partner Settings
CleanShot 2025-02-15 at 16.30.55@2x.png
Merchant View
View Merchant Requests
Receive notifications for new requests, review merchant requirements, send customized pricing offers, and track their subscription status.
CleanShot 2025-02-15 at 16.38.51@2x.png
Private Plans Management
Create Plan for a Specific Store
Click on "Add Private Plan" to send a pricing offer to a specific store. Define usage limits, pricing details, and any special terms before activating the plan.
CleanShot 2025-02-15 at 16.40.42@2x.png
Adding Private Plan for Store

Request App Publish#

Once all required details are filled in, you can submit your app for Zid's review and testing. Our team will assess your app’s functionality, usability, and overall readiness before approval.
To ensure a smooth review process, make sure your app is fully prepared:
✅ Signed a partnership agreement.
✅ Tested on a development store to confirm all features work as expected.
✅ App platform test accounts and login credentials are ready.
✅ QA test cases prepared to assist with validation.
✅ Merchant activation steps, setup requirements, and FAQs outlined.
Once submitted, you’ll receive a notification regarding your app’s review status and estimated publish date. Ensuring your app is well-prepared will speed up approval and minimize iterations. 🚀
Modified at 2025-03-12 22:57:13
Next
Embedded Apps
Built with