---
title: "Simulate subscription pricing"
method: POST
path: "/api/public/v1/subscriptions/simulator"
tags: ["Subscriptions"]
---

# Simulate subscription pricing

`POST /api/public/v1/subscriptions/simulator`

## Request

- Base URL: `http://localhost:3009`
- URL: `http://localhost:3009/api/public/v1/subscriptions/simulator`
- Auth: HTTP basic

Calculates subscription pricing breakdown including subscriber fees based on tiered pricing

## Headers

- `Authorization` string, required

## Request body

- object
  - `merchant` object, required
    - `id` string, required: Merchant reference
  - `cart_items` object[], required
    - `price_with_tax` integer, required: Total price including tax
    - `name` string
    - `type` 'material_subscription' | 'contact_lens_subscription' | 'subscription_package': Item type. Defaults to material_subscription. Contact lens items are priced over their exchange cycle instead of the standard 24 months
    - `items` object[]: Sub-items of a subscription_package. A subscription_package must carry its sub-items, and each of them must declare its type
      - `price_with_tax` integer, required
      - `name` string
      - `type` string, required

## Response `200`

pricing breakdown calculated successfully

## Other responses

- `401`: unauthorized
- `422`: invalid cart items

---

[API](https://skmtc.dev/sequra/apis/instore-api.md) - [All operations](https://skmtc.dev/sequra/apis/instore-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sequra/apis/instore-api/revisions/29430b803abc?raw)