Get billable event prices

GET

events

prices

curl --request GET \
  --url https://ingest.hyperline.co/v1/events/prices \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "cal_1234567890",
    "result": [
      {
        "customer_id": "cus_CrqwefTRWBWRT",
        "event_timestamp": "2024-12-20T16:04:11Z",
        "subscription_id": "<string>",
        "event_type": "api_call",
        "product_id": "itm_AweveQEoewer",
        "price_group": {
          "id": "grp_QalW2vTAdkR6IY",
          "name": "mastercard"
        },
        "record": {
          "id": "D32NAA8",
          "durationInMs": 32,
          "isVerified": true
        },
        "amount_excluding_tax": 10000,
        "tax_amount": 2000,
        "total_amount": 12000,
        "currency": "EUR",
        "ingested": true,
        "pre_calculated_at": "2024-12-20T16:04:11Z"
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

record_id

string

A unique identifier for your event, used to identify the event in your system and prevent duplicates.

Example:

"D32NAA8"

calculation_id

string

ID of the calculation.

Example:

"cal_1234567890"

Response

200 - application/json

Event prices previously calculated

string

required

ID of the calculation.

Example:

"cal_1234567890"

result

object[]

required

result.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.

Example:

"api_call"

result.product_id

string

required

Hyperline ID of the product.

Example:

"itm_AweveQEoewer"

result.record

object

required

Payload of the event containing an ID and any additional metadata.

Example:

{
  "id": "D32NAA8",
  "durationInMs": 32,
  "isVerified": true
}

result.amount_excluding_tax

number

required

Amount excluding tax.

Example:

10000

result.currency

enum<string>

required

Currency code. See ISO 4217.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

XOF,

BGN,

BHD,

BIF,

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

Example:

"EUR"

result.ingested

boolean

required

Whether the event has been ingested

Example:

true

result.pre_calculated_at

string

required

UTC date time string in the ISO 8601 format, or milliseconds since the epoch. The event timestamp is used to retrieve the events related to a specific billing period.

Example:

"2024-12-20T16:04:11Z"

result.customer_id

string

Hyperline ID or external ID of the existing customer.

Example:

"cus_CrqwefTRWBWRT"

result.event_timestamp

string

UTC date time string in the ISO 8601 format, or milliseconds since the epoch. The event timestamp is used to retrieve the events related to a specific billing period.

Example:

"2024-12-20T16:04:11Z"

result.subscription_id

string

result.price_group

object

result.tax_amount

number

Tax estimate.

Example:

2000

result.total_amount

number

Total amount. The final amount will be determined by the final invoice.

Example:

12000

Was this page helpful?

Get analytics Create billable event

curl --request GET \
  --url https://ingest.hyperline.co/v1/events/prices \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "cal_1234567890",
    "result": [
      {
        "customer_id": "cus_CrqwefTRWBWRT",
        "event_timestamp": "2024-12-20T16:04:11Z",
        "subscription_id": "<string>",
        "event_type": "api_call",
        "product_id": "itm_AweveQEoewer",
        "price_group": {
          "id": "grp_QalW2vTAdkR6IY",
          "name": "mastercard"
        },
        "record": {
          "id": "D32NAA8",
          "durationInMs": 32,
          "isVerified": true
        },
        "amount_excluding_tax": 10000,
        "tax_amount": 2000,
        "total_amount": 12000,
        "currency": "EUR",
        "ingested": true,
        "pre_calculated_at": "2024-12-20T16:04:11Z"
      }
    ]
  }
]

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoices > Transactions

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Get billable event prices

Authorizations

Query Parameters

Response