Custom Implementation

• You can handle all the rendering and create your own custom pricing/plan page and use a multi-step process with our REST endpoints to create checkout sessions. This is best for established companies with an existing workflow.

Before you continue, have a look at our page on Checkout Sessions and make sure your configuration is set up.

Custom

If you have an existing workflow or a design theme you really want to follow for your pricing page, this process is for you!

This process is fairly straightforward :

1. Render a list of all the currently available products.

   Create a GET request with your Public Key to <https://api.archetype.dev/public/v2/api/{YOUR_PUBLIC_KEY}/products>

   This returns a JSON list of products that are currently publicly available. The response will be a JSON list of Products formatted like below.

Example

[
	{  
		"name": "Basic", 
		"description": "Basic Description", 
		"has_full_access": true, 
		"has_quota": true, 
		"has_trial": false, 
		"is_free": false,
		"period": "month", 
		"price": 40.0, 
		"quota": 1000, 
		"tier_id": "prod_KqVFQR9chN5jB0", 
		"trial_length": 1, 
		"trial_time_frame": "month" 
	}
	...
]

📘

Looking for more details on Products?

For more details on what you can do with the products, head over to Products.

With this you'll be able to get all the relevant details like the price, quota, trial length and features.

When a user is ready to subscribe to a tier, you'll need the tier_id for the specific product to create a checkout session for the next step.

2. Create a custom checkout session when a user clicks "subscribe" or tries to sign up for a plan.

You need to create a POST request to:

https://api.archetype.dev/public/v2/api/create-checkout-session

and add these to the body:

Request Body

This request will return the below checkout session url.

Redirect your user to the newly generated checkout session url. This will take them through the flow and once the user completes or cancels the flow, it'll take them to the return url or redirect url you set in your API settings.

Response

{
	"url": "CHECKOUT_SESSION_URL"
}

Once they've completed the checkout session, they'll be redirected to the url you set for the redirect_url in your settings page.

Notes

• The uid will be whatever unique identifier you've set for each user. This needs to be static and unchanging.

• If the user has not been previously registered before, we'll automatically create a new user with the default parameters.

Check out our Users page for more details.

• Checkout sessions are ephemeral so you'll always have to create a new checkout session. Do not try to cache a checkout session for each user.

• These are for currently signed in users, default behavior for non-signed in users should be to take them to your signup flow and keep their planned tier in your session to direct them.