price.imported

Occurs when a price is imported.

created_at and updated_at may be null in events that occurred before this field was added to price entities.

event_idstring

Unique Paddle ID for this event, prefixed with evt_.

event_typestring

Type of event sent by Paddle, in the format entity.event_type.

occurred_atstring<date-time>

RFC 3339 datetime string of when this event occurred.

dataobject

Represents a price entity.

idstring

Unique Paddle ID for this price, prefixed with pri_.

product_idstring

Paddle ID for the product that this price is for, prefixed with pro_.

descriptionstring

Internal description for this price, not shown to customers. Typically notes for your team.

typestring or null

Type of item. Standard items are considered part of your catalog and are shown on the Paddle web app.

namestring or null

Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.

billing_cycleobject or null

How often this price should be charged. null if price is non-recurring (one-time).

trial_periodobject or null

Trial period for the product related to this price. The billing cycle begins once the trial period is over. null for no trial period. Requires billing_cycle.

tax_modestring

How tax is calculated for this price.

unit_priceobject

Base price. This price applies to all customers, except for customers located in countries where you have unit_price_overrides.

unit_price_overridesarray[object]

List of unit price overrides. Use to override the base price with a custom price and currency for a country or group of countries.

quantityobject

Limits on how many times the related product can be purchased at this price. Useful for discount campaigns.

statusstring

Whether this entity can be used in Paddle.

custom_dataobject or null

Your own structured key-value data.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

created_atstring<date-time> or null

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time> or null

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

notification_idstring

Unique Paddle ID for this notification, prefixed with ntf_.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1{
2  "event_id": "evt_01hgarz844zdfws6djn9rz6qm7",
3  "event_type": "price.imported",
4  "occurred_at": "2024-01-01T13:31:34.071379Z",
5  "notification_id": "ntf_01hd46rrqkrbndwzrarcew6t21",
6  "data": {
7    "id": "pri_01gsz95g2zrkagg294kpstx54r",
8    "product_id": "pro_01gsz92krfzy3hcx5h5rtgnfwz",
9    "type": "standard",
10    "description": "Monthly (recurring addon)",
11    "name": "Monthly (recurring addon)",
12    "billing_cycle": {
13      "interval": "month",
14      "frequency": 1
15    },
16    "trial_period": null,
17    "tax_mode": "account_setting",
18    "unit_price": {
19      "amount": "25000",
20      "currency_code": "USD"