Free tiers API

This page covers api endpoints that allow merchants add customers to their free tier membership

To sign up for free tier membership, customer has to be registered in Shopify.

{
    merchantId: string,
    customerId: string,
    segmentId: string?,
}

Sign up customer for free tier

POST https://public.inveterateapi.com/signup-free-tier

Request Body

Name	Type	Description
merchantId*	String	merchantId is the first part of the shop domain. For example if the shop domain is inveterate-demo.myshopify.com, Merchant ID is inveterate-demo
customerId*	String	Shopify legacy customer id like 6412233234 etc
segmentId	String	Optionally provided to specify which free tier the customer is to be enrolled into. If absent, the first free tier to be created is assumed.

202: Accepted Successful response

400: Bad Request Required body parameters are missing

403: Forbidden Free tier is not enabled for the merchant