---
title: "Simulate billable event prices"
method: POST
path: "/v1/events/simulate-prices"
tags: ["Billable events"]
---

# Simulate billable event prices

`POST /v1/events/simulate-prices`

Simulate prices for a single billable event without ingesting it.

## Query parameters

- `product_id` string — Hyperline ID of the product.
- `subscription_id` string — Hyperline ID of the subscription.
- `include_tax` boolean, nullable — Whether to include amounts with tax

## Request body

- object
  - `event_type` string, required — Type corresponding to the event. When creating a dynamic product, this type will be used to map the related events to specific prices.
  - `record` object, required — Payload of the event containing an ID and any additional metadata.
    - `id` union, required — A unique identifier for your event, used to identify the event in your system and prevent duplicates.
      - string
      - number
  - `customer_id` string — Hyperline ID or external ID of the existing customer.
  - `timestamp` string, date-time — UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, or milliseconds since the epoch. The event timestamp is used to retrieve the events related to a specific billing period.

## Response `200`

Event prices simulated

- object
  - `id` string, required — ID of the calculation.
  - `result` object[], required
    - `customer_id` string, nullable
    - `subscription_id` string, nullable
    - `product_id` string, required — Hyperline ID of the product.
    - `price_group` object
      - `id` string, required — ID of the group of tiers.
      - `name` string, required — Name of the group of tiers.
    - `amount_excluding_tax` number, required — Amount excluding tax.
    - `tax_amount` number — Tax estimate.
    - `total_amount` number — Total amount. The final amount will be determined by the final invoice.
    - `currency` 'EUR' | 'AED' | 'AFN' | 'XCD' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'USD' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'XOF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'NOK' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'XAF' | 'CHF' | 'NZD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'ANG' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'MAD' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'XPF' | 'NGN' | 'NIO' | 'NPR' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)