Appearance
Field Reference
This page lists every importable entity type, its columns, and the column names TiruPay recognises. Use it to prepare your CSV files.
How to Read These Tables
Each entity type has a table with four columns:
| Column | Meaning |
|---|---|
| Field | The TiruPay field the column fills. |
| Required | Whether a value is required on every row. |
| Type | The expected value format (see Value types). |
| Also accepted as | Alternative column names TiruPay recognises automatically, including German variants. You do not have to rename your columns to these - any of them works. |
Beyond the listed names, TiruPay also maps close near-misses automatically and reports when it does. If a column still cannot be mapped, supply a column correction.
Value Types
| Type | Format |
|---|---|
| Text | Any text. |
| Whole number | An integer, e.g. 3. |
| Number | A decimal. Both 12.50 and 12,50 are accepted. |
| Date/time | 2024-01-15 or 2024-01-15T10:00:00. 15.01.2024 is also accepted. |
| Yes/No | true/false, yes/no, ja/nein, 1/0. |
| Choice | One of a fixed set of values, listed with the field. Common English and German wordings are accepted and mapped automatically. |
External IDs and References
external_idis required on every row of every entity type - it is your source system's own ID for the record.- Columns ending in
_external_idare references: they hold theexternal_idof a related record. See References between files.
The product catalog (article categories, articles, extensions and PAYG plans) can be imported - see Product Catalog below. References to article / article_extension / payg_plan resolve against catalog items imported in the same upload or already present in your service (tagged with the External ID they had in your source system - see Linking to existing catalog items).
Core Customer Data
customer
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
email | Yes | Text | email_address, e_mail, mail, e-mail |
first_name | No | Text | firstname, vorname, given_name, givenname |
last_name | No | Text | lastname, nachname, surname, family_name, familyname |
street | Yes | Text | address, street_address, strasse, adresse |
city | Yes | Text | stadt, town, ort, locality |
postal_code | Yes | Text | zip, postleitzahl, plz, zip_code, postcode |
country_code | Yes | Text (2-letter ISO, e.g. DE) | country, land, iso_country, country_iso, laendercode |
is_company | No | Yes/No | company, is_business, firma, geschaeftskunde, b2b |
company_name | No | Text | firma_name, business_name, organisation, firmenname, unternehmen |
company_vat_id | No | Text | vat, ustid, tax_id, vat_number, ust_id, umsatzsteuer_id |
company_tax_exempt | No | Yes/No (default No) | tax_exempt, reverse_charge, steuerbefreit, steuerfrei |
phone | No | Text | phone_number, telefon, tel, telefonnummer, mobil |
locale | No | Text | language, sprache, lang |
ext_invoicing_id | No | Text | invoicing_id, billing_id, rechnungs_id |
internal_note | No | Text | note, notes, notiz, notizen, interne_notiz |
Company vs. private customers
If is_company is set, company_name becomes required; company_vat_id stays optional. Otherwise, at least one of first_name or last_name is required.
company_tax_exempt (reverse charge) is imported as given. Unlike the customer API, the import (currently) does not verify it against the VAT registry.
user
A portal login account linked to a customer.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
customer_external_id | Yes | Reference → customer | customer_id, customer_ext_id, kunde_id |
email | Yes | Text | email_address, e_mail, mail |
first_name | No | Text | firstname, vorname, given_name |
last_name | No | Text | lastname, nachname, surname, family_name |
mandate
A stored payment authorisation (e.g. SEPA direct debit or card token).
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
customer_external_id | Yes | Reference → customer | customer_id, kunde_id, customer_ext_id |
partner | Yes | Choice: mollie, stripe, nemo | payment_partner, provider, zahlungsanbieter |
payment_method_identifier | Yes | Choice: payment method, e.g. sepa_direct_debit, credit_card, paypal | method_identifier, zahlungsmethode, zahlungsmethode_id, payment_method, methode |
partner_mandate_id | Yes | Text | mandate_id, mandat_id, external_mandate_id |
status | No | Choice: valid, pending, invalid, revoked, expired | mandate_status, mandat_status |
Subscriptions
subscription
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
customer_external_id | Yes | Reference → customer | customer_id, kunde_id, customer_ext_id |
paying_customer_external_id | No | Reference → customer | paying_customer_id, payer_id, payer_external_id, zahler_id |
article_external_id | Yes | Reference → article (catalog) | article_id, product_id, artikel_id |
status | Yes | Choice: active, cancelled, paused, terminated, expired | subscription_status, abo_status, state |
interval | Yes | Choice: day, week, month, quarter, half_year, year | billing_interval, period, abrechnungsintervall |
started_at | Yes | Date/time | start_date, start, activation_date, startdatum |
current_period_start | Yes | Date/time | period_start, periode_start, billing_start |
current_period_end | Yes | Date/time | period_end, renewal_date, next_billing_date, periode_ende |
currency_code | No | Text (3-letter ISO) | waehrung, currency |
country_code | No | Text (2-letter ISO) | country, tax_country, tax_country_code, land, steuerland |
locked_article_price | No | Number | price, locked_price, preis |
min_term_periods | No | Whole number | min_term, mindestlaufzeit |
coupon_external_id | No | Reference → coupon | coupon_id, gutschein_id |
cancelled_at | No | Date/time | cancellation_date, kuendigungsdatum |
cancellation_effective_at | No | Date/time | effective_cancellation, kuendigung_wirksam_ab |
payment_method_identifier | No | Choice: payment method, e.g. sepa_direct_debit, credit_card, paypal | method_identifier, zahlungsmethode, zahlungsmethode_id, payment_method, methode |
payment_partner | No | Choice: mollie, stripe, nemo | partner, zahlungsanbieter |
mandate_external_id | No | Reference → mandate | mandate_id, mandat_id |
Subscription rules
The referenced article must be a subscription article. If status is cancelled, cancelled_at is required. An active subscription needs a completed order and a payment mandate to renew - import these alongside it (the mandate via mandate_external_id, or payment_method_identifier + payment_partner).
Paid by someone else
Set paying_customer_external_id on an order or subscription when another customer pays for it - see Paying Customer. Leave it empty, or repeat customer_external_id, when the customer pays for themselves. When someone else pays:
- the mandate must belong to the paying customer
- the article must be available in the paying customer's country, and the order or subscription is taxed there, unless it sets
country_code - articles and extensions with pay-as-you-go usage are not allowed
Tax country of a subscription
Set country_code to tax a subscription's renewals in a different country than its paying customer's. It stays fixed for the subscription's lifetime, and the article must be available in that country. Leave it empty to use the paying customer's country.
subscription_extension
An add-on booked on a subscription.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
subscription_external_id | Yes | Reference → subscription | subscription_id, abo_id |
article_extension_external_id | Yes | Reference → article extension (catalog) | extension_id, erweiterung_id |
locked_price | No | Number | price, preis |
quantity | No | Number | menge, anzahl |
locked_price is the net price per unit; the renewal charges locked_price × quantity. Without quantity the extension is booked once.
subscription_pending_change
A scheduled plan change that takes effect at the next renewal.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
subscription_external_id | Yes | Reference → subscription | subscription_id, abo_id |
new_article_external_id | Yes | Reference → article (catalog) | new_article_id, neuer_artikel_id |
effective_at | Yes | Date/time | effective_date, wirksamkeit |
Orders & Payments
order
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
customer_external_id | Yes | Reference → customer | customer_id, kunde_id |
paying_customer_external_id | No | Reference → customer | paying_customer_id, payer_id, payer_external_id, zahler_id |
subscription_external_id | No | Reference → subscription | subscription_id, abo_id |
order_number | Yes | Text, unique per service | bestellnummer, rechnungsnummer, invoice_number |
order_status | Yes | Choice: draft, pending, completed_outstanding, completed_finalized, partially_refunded, refunded, revoked, dunning, cancelled | status, bestellstatus |
order_date | No | Date/time | date, bestelldatum, rechnungsdatum |
total_amount | No | Number | total, gesamt, betrag |
total_tax | No | Number | tax, steuer, mwst |
currency_code | No | Text (3-letter ISO) | waehrung, currency |
country_code | No | Text (2-letter ISO) | country, tax_country, tax_country_code, land, steuerland |
due_date | No | Date/time | faelligkeitsdatum, payment_due |
Tax country
Set country_code to tax an order in a different country than its paying customer's, like the country override on a draft order. Leave it empty to use the paying customer's country.
order_position
A line item within an order. Reference exactly one of article or article extension.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
order_external_id | Yes | Reference → order | order_id, bestell_id, rechnungs_id |
article_external_id | No* | Reference → article (catalog) | article_id, artikel_id |
article_extension_external_id | No* | Reference → article extension (catalog) | extension_id, erweiterung_id |
quantity | No | Number | menge, anzahl |
unit_price | No | Number | einzelpreis, preis_pro_einheit |
total_price | No | Number | gesamtpreis, gesamt |
sort_order | No | Whole number | position, reihenfolge |
overwrite_name | No | Text | name, bezeichnung |
overwrite_description | No | Text | description, beschreibung |
* Exactly one of article_external_id or article_extension_external_id must be set.
payment
A recorded payment transaction against an order.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
order_external_id | Yes | Reference → order | order_id, bestell_id |
pp_payment_id | Yes | Text | payment_processor_id, zahlungs_id, transaction_id |
payment_method_identifier | No | Choice: payment method, e.g. sepa_direct_debit, credit_card, paypal | method_identifier, zahlungsmethode, zahlungsmethode_id, payment_method, methode |
payment_partner | No | Choice: mollie, stripe, nemo | partner, zahlungsanbieter |
order_refund
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
order_external_id | Yes | Reference → order | order_id, bestell_id |
refund_type | Yes | Choice: full, position, position_partial, subscription_upgrade, subscription_termination | type, erstattungstyp |
net_amount | Yes | Number | nettobetrag, betrag |
tax_amount | No | Number | steuer, steuerbetrag |
gross_amount | No | Number | bruttobetrag |
description | No | Text | beschreibung, grund, reason |
ext_credit_note_id | No | Text | credit_note_id, gutschrift_id |
Amount consistency
If net_amount, tax_amount and gross_amount are all present, the gross must equal net + tax.
Balance System
balance_type
Defines a category of unit-based balance (e.g. SMS credits).
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
name | Yes | Text | bezeichnung, typ_name, typname |
description | No | Text | beschreibung |
payment_mode | Yes | Choice: prepaid, payg | zahlungsmodus, modus |
payg_payment_grace_days | No | Whole number | grace_days, zahlungsfrist |
INFO
payg_payment_grace_days only applies to payg types; on a prepaid type it is ignored.
balance_usage_category
A consumption category within a balance type.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
balance_type_external_id | Yes | Reference → balance_type | balance_type_id, kontotyp_id |
name | Yes | Text | bezeichnung, kategorie_name |
description | No | Text | beschreibung |
price_per_unit | No* | Number | preis_pro_einheit, unit_price |
* Required when the referenced balance type is prepaid; must be empty when it is payg.
balance
A unit-based balance account for a customer.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
customer_external_id | Yes | Reference → customer | customer_id, kunde_id |
balance_type_external_id | Yes | Reference → balance_type | balance_type_id, kontotyp_id |
status | No | Choice: active, partially_frozen, frozen | balance_status |
payg | No* | Yes/No | is_payg, pay_as_you_go |
current_balance | No | Number | balance, guthaben, kontostand |
limit_payg | No** | Number | payg_limit, limit |
* Set payg to true for pay-as-you-go balances. If omitted, it defaults based on the balance type's payment_mode.
** limit_payg only applies when payg is true.
balance_usage
A single usage event drawing on a balance.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
balance_external_id | Yes | Reference → balance | balance_id, konto_id |
title | Yes | Text | bezeichnung, name |
billing_status | Yes | Choice: pending, billed_pending, billed, reserved, denied, refunded, revoked | status, usage_status |
total_cost | No | Number | kosten, betrag |
balance_usage_item
A line within a usage event.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
balance_usage_external_id | Yes | Reference → balance_usage | usage_id, verbrauch_id |
usage_category_external_id | Yes | Reference → balance_usage_category | category_id, kategorie_id |
units_used | Yes | Number | einheiten, menge |
cost | No | Number | kosten |
is_reservation | No | Yes/No | reservierung, reserved |
payg_activation
A record that a pay-as-you-go balance has been activated. Required for every PAYG balance - without one, usage would fail at runtime.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
balance_external_id | Yes | Reference → balance | balance_id, konto_id |
payg_plan_external_id | Yes | Reference → payg_plan | payg_plan_id, plan_id, plan_ext_id |
status | No | Choice: active, cancelled | activation_status |
monthly_free_amount | No | Number | monthly_free, monatlicher_freibetrag |
limit_payg | No | Number | limit, payg_limit |
Required alongside every PAYG balance
Import a payg_activation row alongside every PAYG balance - or ensure the activation already exists in your service. A PAYG balance without an active activation produces a payg_activation_missing error.
payg_plan_external_id must reference the External ID of a PAYG plan - either imported in the same upload (see payg_plan) or already configured in your service. The executor automatically creates a price snapshot (PaygActivationCategoryPrice) from the plan's current prices when the activation is imported - so usage is always billed at the prices that were in effect at activation time.
Credit Balance (Prepaid Wallet)
credit_balance
A global prepaid wallet for a customer.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
customer_external_id | Yes | Reference → customer | customer_id, kunde_id |
currency_code | Yes | Text (3-letter ISO) | waehrung, currency |
current_balance | No | Number | balance, guthaben, kontostand |
status | No | Choice: active, partially_frozen, frozen | balance_status |
credit_transaction
A movement on a credit balance.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
credit_balance_external_id | Yes | Reference → credit_balance | balance_id, guthaben_id |
transaction_type | Yes | Choice: credit, debit, refund | type, buchungstyp |
amount | Yes | Number (greater than 0) | betrag |
balance_before | No | Number | vorher, stand_vorher |
balance_after | No | Number | nachher, stand_nachher |
description | No | Text | beschreibung, verwendungszweck |
INFO
When amount, balance_before and balance_after are all present, the resulting balance must match: a credit or refund adds the amount, a debit subtracts it.
Coupons
coupon
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
code | Yes | Text | gutscheincode, coupon_code, rabattcode |
name | Yes | Text | bezeichnung, gutscheinname |
description | No | Text | beschreibung |
coupon_type | Yes | Choice: percentage, amount | typ, rabatttyp |
discount_percentage | No* | Number | rabatt_prozent, prozent, percentage |
discount_amount | No* | Number | rabatt_betrag, betrag, amount |
min_order_amount | No | Number | mindestbestellwert, min_betrag |
currency_code | No* | Text (3-letter ISO) | waehrung, currency |
valid_from | No | Date/time | gueltig_ab, start |
valid_until | No | Date/time | gueltig_bis, ablauf, expiry |
is_global | No | Yes/No | global, global_gueltig |
max_redemptions | No | Whole number | max_einloesungen, max_uses |
* For a percentage coupon, discount_percentage (0-100) is required and discount_amount must be empty. For an amount coupon, discount_amount and currency_code are required and discount_percentage must be empty.
applied_coupon
A record of a coupon applied to an order.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
order_external_id | Yes | Reference → order | order_id, bestell_id |
coupon_external_id | Yes | Reference → coupon | coupon_id, gutschein_id |
applied_at | No | Date/time | angewendet_am, used_at |
total_discount_granted | No | Number | rabatt, discount |
Features
feature
A feature definition for the service.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
public_name | Yes | Text | name, oeffentlicher_name, bezeichnung |
internal_name | Yes | Text | internal_id, interner_name, key |
description | No | Text | beschreibung |
type | Yes | Choice: boolean, integer | feature_type, typ |
feature_assignment
Assigns a feature directly to a customer.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
customer_external_id | Yes | Reference → customer | customer_id, kunde_id |
feature_external_id | Yes | Reference → feature | feature_id, merkmal_id |
quantity | No | Whole number | menge, anzahl |
order_feature_log
A record of a feature grant triggered by an order.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
order_external_id | Yes | Reference → order | order_id, bestell_id |
customer_external_id | Yes | Reference → customer | customer_id, kunde_id |
feature_external_id | Yes | Reference → feature | feature_id, merkmal_id |
quantity | No | Whole number | menge, anzahl |
granted_at | No | Date/time | gewaehrt_am, start |
ended_at | No | Date/time | beendet_am, end |
Product Catalog
The product catalog defines what you sell. Import the catalog in dependency order: categories first, then articles, then extensions and the links that articles provide (features, balance topups, PAYG activations). PAYG plans and their prices can be imported in the same upload.
article_category
A grouping for articles. Service-scoped.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
name | Yes | Text | bezeichnung, kategorie_name, category_name, kategoriename |
description | No | Text | beschreibung |
unique_subscription | No | Boolean | abo_eindeutig, eindeutiges_abo, exklusives_abo |
article
A sellable product or subscription plan.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
article_category_external_id | Yes | Reference → article_category | category_id, kategorie_id, article_category_id, category_ext_id |
name | Yes | Text | bezeichnung, artikelname, produkt, produktname, title |
description | No | Text | beschreibung |
net_price | Yes | Number | nettopreis, preis, price, net, netto |
hidden | No | Yes/No | versteckt, is_hidden, ausgeblendet |
is_subscription | No | Yes/No | abo, subscription, ist_abo, is_abo |
allow_multiple | No | Yes/No | mehrfach, mehrfach_erlaubt, multiple |
interval | No* | Choice: day, week, month, quarter, half_year, year | billing_interval, abrechnungsintervall, intervall, period |
min_term_periods | No* | Whole number | min_term, mindestlaufzeit, min_laufzeit |
* interval is required when is_subscription is true, and must be empty otherwise. min_term_periods is only allowed on subscription articles. A mismatch produces an article_interval_required / article_interval_not_allowed error.
article_extension
An add-on attached to a subscription article. The parent article must be a subscription.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
article_external_id | Yes | Reference → article | article_id, artikel_id, parent_article_id |
name | Yes | Text | bezeichnung, erweiterungsname, title |
description | No | Text | beschreibung |
net_price | Yes | Number | nettopreis, preis, price, net, netto |
hidden | No | Yes/No | versteckt, is_hidden, ausgeblendet |
allow_multiple | No | Yes/No | mehrfach, mehrfach_erlaubt, multiple |
article_feature_link
A feature granted by an article, with its value. Provide exactly one of value_bool (for boolean features) or value_int (for integer features).
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
article_external_id | Yes | Reference → article | article_id, artikel_id |
feature_external_id | Yes | Reference → feature | feature_id, merkmal_id |
value_bool | No* | Yes/No | bool_value, wert_bool, boolean |
value_int | No* | Whole number | int_value, wert_int, menge, anzahl |
* Exactly one of value_bool or value_int must be set.
article_balance_topup
The balance amount a customer receives when an article or extension is purchased. Reference exactly one of article or extension.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | No | Text | ext_id, id, source_id, src_id, uid |
article_external_id | No* | Reference → article | article_id, artikel_id |
article_extension_external_id | No* | Reference → article_extension | extension_id, erweiterung_id, article_extension_id |
balance_type_external_id | Yes | Reference → balance_type | balance_type_id, kontotyp_id |
topup_amount | Yes | Number (> 0) | betrag, amount, aufladebetrag, guthaben |
* Exactly one of article_external_id or article_extension_external_id must be set.
Deduplication depends on whether you provide an External ID
Unlike other entities, external_id is optional here. How re-imports behave depends on it:
- With an
external_id(recommended): the topup is deduplicated exactly like every other entity - a re-import of the same External ID is skipped, so no duplicate is created. If your source system already has a per-topup ID, supply it. - Without an
external_id: there is no reliable key to recognise a topup that was already imported, so every topup row is always written and re-importing the same file creates a duplicate topup. As a safety net, when such a topup matches an existing one (same article/extension + balance type + amount), the validation report raises anarticle_balance_topup_potential_duplicatewarning (it does not block). Always review these warnings and verify manually before proceeding.
article_payg_activation
Links an article or extension to a PAYG plan that activates when it is purchased. Reference exactly one of article or extension.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
article_external_id | No* | Reference → article | article_id, artikel_id |
article_extension_external_id | No* | Reference → article_extension | extension_id, erweiterung_id, article_extension_id |
payg_plan_external_id | Yes | Reference → payg_plan | payg_plan_id, plan_id, plan_ext_id |
* Exactly one of article_external_id or article_extension_external_id must be set.
payg_plan
A pay-as-you-go billing plan tied to a balance type.
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
balance_type_external_id | Yes | Reference → balance_type | balance_type_id, kontotyp_id |
name | Yes | Text | bezeichnung, planname, plan_name |
description | No | Text | beschreibung |
monthly_free_amount | No | Number | monatlicher_freibetrag, monthly_free, freibetrag |
limit_payg | No | Number | limit, payg_limit, obergrenze |
unit_scale | No | Whole number (1 - 1000000) | einheitenskala, scale, skalierung |
is_active | No | Yes/No | aktiv, active |
payg_plan_price
A per-country container for a PAYG plan. Holds optional country-level overrides for free allowance and limit. Per-category prices are defined separately in payg_plan_price_item. country_code is resolved against TiruPay configuration (no External ID needed).
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
payg_plan_external_id | Yes | Reference → payg_plan | payg_plan_id, plan_id, plan_ext_id |
country_code | Yes | ISO 2-letter country code | country, land, iso_country, country_iso, laendercode |
monthly_free_amount | No | Number | monatlicher_freibetrag, monthly_free |
limit_payg | No | Number | limit, payg_limit |
monthly_free_units | No | Number | monatliche_freie_einheiten |
Config lookups
country_code must match a country configured in TiruPay. An unresolvable value produces a payg_plan_price_country_not_found error.
payg_plan_price_item
A per-category price entry within a payg_plan_price. tax_category_name is resolved against TiruPay configuration (no External ID needed).
| Field | Required | Type | Also accepted as |
|---|---|---|---|
external_id | Yes | Text | ext_id, id, source_id, src_id, uid |
payg_plan_price_external_id | Yes | Reference → payg_plan_price | payg_plan_price_id, price_id, plan_price_id |
usage_category_external_id | Yes | Reference → balance_usage_category | usage_category_id, category_id, kategorie_id |
price_per_unit | Yes | Number | preis_pro_einheit, preis, price, unit_price |
tax_category_name | Yes | Text (name of a tax category in that country) | tax_category, steuerkategorie, steuerkategorie_name, tax_class |
monthly_free_units | No | Number | monatliche_freie_einheiten |
Config lookups
tax_category_name must match a tax category that exists for the country of the parent payg_plan_price. An unresolvable value produces a payg_plan_price_tax_category_not_found error.
Related Pages
- Data Import overview - concepts and the end-to-end workflow.
- Import Validation - uploading, mapping, and reading the report.