Billing App development and submission process
While integrating with Poynt Billing is relatively simple and straightforward, the process of development and testing using the same package name that you would use for Live deployment could be challenging. As an app that requires the merchants to pay for subscriptions, you would need to make sure you handle one or more billing plans (as per your monetization strategy), managing existing and new subscriptions, receive and handle webhooks for start & stop of subscriptions and payments, and above all managing multiple versions of your app in different states of development, testing and deployment.
For these reasons, we recommend the following process for a seamless integration and deployment of your app using the Poynt Billing APIs (on terminal or on cloud).
- Application Setup
- Building a new App
- Adding billing to existing App with no prior billing
- Updating existing app with billing
- Billing use cases
Application setup
- Use a dev variant for integration and testing. Android Studio and Gradle provide a nice and convenient way to manage multiple variants for your application. We recommend creating a new “dev” variant with package name appended by “.dev” and use it to create a test app on Poynt App Portal for your integration and testing. To create a new build variant (e.g. package name: “com.example.myapp.dev”) open the build.gradle file in your project and add the following inside the buildTypes block:
dev {
initWith debug
applicationIdSuffix ".dev"
}
- Once you create and submit a test app using your “dev” variant, please contact Poynt dev support to enable this app to show up in Poynt Apps marketplace for “test merchants”. Please note that this will enable your test app to only show up for “test merchant” accounts used by developers.
- When you are satisfied with your integration and testing, generate a release build with your live package name (Eg. “com.example.myapp”) and submit for App Review as your final app. Note that the appId and App credentials (RSA public key pair) for your live application would be different from the test application, and you would need to create the billing plans again for the live app.
- Once your live app is reviewed and approved by our App Review team, your billing plans will be marked as live and your application can be published in the Poynt Apps marketplace.
Below you’ll find more detailed step by step process on how to setup your application based on in which state you are.
If you are building a brand new app:
- Create new dev variant with package name appended with “.dev” suffix.
- Create new Application on Poynt app Portal with the dev variant application.
- Create billing plans for development and testing.
- Contact Poynt Dev Support to mark the app available for testing through Poynt Apps Marketplace.
- Poynt Dev Support will approve your test billing plans and mark your app available for testing through Poynt apps Marketplace. Please note that this only enables for “Test Merchants”.
- Do your development and testing.
- When ready, generate your “release” build with your final package name.
- Create new app on Poynt app Portal with the release build apk.
- Create billing plans for Live
- Submit your app for review. Please note that you would need to complete all the formalities required for submitting an applications for review - failing so could delay your application review process.
- Poynt App review team, will review your billing plans and Application as per the Poynt App Review process, and approves for Live.
- Now your app will be available for merchants in Live Poynt Apps marketplace.
If you are updating an existing app with no prior billing plans:
- Create new dev variant with package name appended with “.dev” suffix.
- Create new Application on Poynt app Portal with the dev variant application.
- Create billing plans for development and testing.
- Contact Poynt Dev Support to mark the app available for testing through Poynt Apps Marketplace.
- Poynt Dev Support will approve your test billing plans and mark your app available for testing through Poynt apps Marketplace. Please note that this only enables for “Test Merchants”.
- Do your development and testing.
- When ready, generate your “release” build with your final package name.
- Upload your new release build apk for your existing Application on Poynt App Portal.
- Create billing plans for Live
- Submit your app for review. Please note that you would need to complete all the formalities required for submitting an applications for review - failing so could delay your application review process.
- Poynt App review team, will review your billing plans and Application as per the Poynt App Review process, and approves for Live.
- Now your app is available for merchants in Live Poynt Apps marketplace.
If you are updating an existing app with prior billing plans:
- If you’ve integrated with Poynt Billing before without a dev variant, please follow previous two section to create a new dev variant with package name appended with “.dev” suffix.
- Create new billing plans for development and testing. Note: You can leave existing billing plans as they are or submit request to Poynt Dev Support to deprecate your old plans.
- Contact Poynt Dev Support to mark the app available for testing through Poynt Apps Marketplace.
- Poynt Dev Support will approve your test billing plans and mark your app available for testing through Poynt apps Marketplace. Please note that this only enables for “Test Merchants”.
- Do your development and testing.
- When ready, generate your “release” build with your final package name.
- Upload your new release build apk for your existing Application on Poynt App Portal.
- Create new billing plans for Live.
- Submit your app for review. Please note that you would need to complete all the formalities required for submitting an applications for review - failing so could delay your application review process. Note that if you are changing your pre-existing billing plans, you must indicate so in the app submission process for Poynt App Review team to deprecate any plans as needed.
- Poynt App review team, will review your billing plans and Application as per the Poynt App Review process, and approves for Live.
- Now your app is available for merchants in Live Poynt Apps marketplace.
Billing use cases
While integrating with Poynt Billing, please consider the following scenarios and make sure your application code can handle these as necessary. Please refer to App Billing Best Practices to make sure your app covers all possible billing scenarios.
- merchant has a valid subscription but never used your app before (first time subscriber)
- merchant has a valid subscription and has used your app before (returning subscriber)
- merchant has a canceled subscription after using your app (canceled subscriber)
- merchant has no subscriptions and never used your app - although this is no longer possible once you’ve integrated with Poynt Billing, we still recommend you to handle this scenario to prevent any fraud that might occur in the future. (not a subscriber)
- merchant has no subscriptions and has used your app before - these are your existing merchants before you’ve switched to Poynt billing. You must make sure you grandfather these merchants to provide a more graceful upgrade process to billing. (grandfathered subscriber)
- merchant has a valid subscription but wants to upgrade or downgrade (upsell/downsell subscriber)