> For the complete documentation index, see [llms.txt](https://help.inveterate.com/dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.inveterate.com/dev/api-reference-docs/legacy-public-api-reference/free-tiers-api.md).

# Free tiers API

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

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

## Sign up customer for free tier

<mark style="color:green;">`POST`</mark> `https://public.inveterateapi.com/signup-free-tier`

#### Request Body

| Name                                         | Type   | Description                                                                                                                                                      |
| -------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| merchantId<mark style="color:red;">\*</mark> | 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<mark style="color:red;">\*</mark> | String | Shopify legacy customer IDs with numerical values such as "6412233234" are supported. GraphQL IDs such as  "gid://shopify/Customer/6412233234" are not supported |
| 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.                     |

{% tabs %}
{% tab title="202: Accepted Successful response" %}

{% endtab %}

{% tab title="400: Bad Request Required body parameters are missing" %}

{% endtab %}

{% tab title="403: Forbidden Free tier is not enabled for the merchant" %}

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.inveterate.com/dev/api-reference-docs/legacy-public-api-reference/free-tiers-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
