Schemas

internal.accounting.IntegrationConfig

config

object

created_at

string

display_name

string

id

string

is_enabled

boolean

organization_id

string

provider

string

updated_at

string

internal.accounting.UpsertIntegrationRequest

config

object

display_name

string

is_enabled

boolean

dto.ActivePromotionDTO

discount_value

string

effect_type

string

expires_at

string

name

string

promotion_id

string

dto.AddInvoiceLineRequestDTO

amount

number

description

string

line_type

string · enum

Enum values:

PLAN_BASE

SEAT

USAGE

PRORATION_CREDIT

PRORATION_CHARGE

ADD_ON

EXPENSE_PASSTHROUGH

MILESTONE

markup_percent

number

object

period_end

string

period_start

string

product_id

string

quantity

number

tax_rate

number

unit_price

number

dto.BillingMilestoneDTO

created_at

string

description

string

id

string

invoice_id

string

is_overdue

boolean

object

name

string

organization_id

string

percentage

number

product_id

string

status

string · enum

Enum values:

PENDING

TRIGGERED

INVOICED

subscription_id

string

trigger_date

string

trigger_type

string · enum

Enum values:

MANUAL

DATE

EVENT

triggered_at

string

updated_at

string

dto.ConditionMeta

applies_at

string

summary

string

type

string

dto.CreateManualInvoiceRequestDTO

billing_period_end

string

billing_period_start

string

buyer_reference

string

currency

string

customer_id

string

delivery_date

string

due_date

string

object[]

locale

string

object

dto.CreditNoteApplicationDTO

amount

number

applied_at

string

created_at

string

credit_note_id

string

id

string

invoice_id

string

organization_id

string

dto.CreditNoteDTO

object

created_at

string

credit_note_number

string

currency

string

customer_id

string

deleted_at

string

id

string

invoice_id

string

issued_at

string

object[]

object

organization_id

string

reason

string

reason_code

string · enum

Enum values:

VOID

REFUND

PROMOTIONAL_CREDIT

CANCELLATION

WITHDRAWAL

DOWNGRADE

ITEM_REMOVAL

OVERPAYMENT

status

string · enum

Enum values:

draft

issued

partially_applied

applied

void

object

object[]

object

updated_at

string

voided_at

string

dto.CreditNoteLineDTO

created_at

string

credit_note_id

string

description

string

id

string

invoice_line_id

string

line_type

string

object

organization_id

string

period_end

string

period_start

string

product_id

string

quantity

number

object

tax_category_code

string

tax_exemption_reason

string

tax_rate

number

tax_type

string

object

dto.EffectMeta

applies_at

string

summary

string

type

string

dto.InvoiceDTO

object

billing_period_end

string

billing_period_start

string

buyer_reference

string

created_at

string

currency

string

customer_id

string

deleted_at

string

delivery_date

string

due_date

string

id

string

invoice_number

string

invoice_type

string · enum

Enum values:

INVOICE

CREDIT_NOTE

CORRECTIVE

issued_at

string

last_dunning_step_at

string

last_dunning_step_index

integer

object[]

locale

string

object

organization_id

string

paid_at

string

status

string · enum

Enum values:

draft

finalized

paid

void

overdue

pending_approval

error

subscription_id

string

object

supplier_tax_number

string

supplier_vat_id

string

supply_type

string · enum

Enum values:

DOMESTIC

INTRA_EU_B2B

INTRA_EU_B2C

EXPORT

object[]

tax_category_code

string · enum

Enum values:

tax_exemption_reason

string

tax_point_date

string

object

updated_at

string

dto.InvoiceLineAtomDTO

atom_index

integer

exchange_rate_id

string

fx_policy_applied

string

id

string

period_end

string

period_start

string

price_key

string

price_key_display_name

string

price_version_id

string

quantity

number

subtotal

number

tax_amount

number

object[]

tax_rate

number

tax_rule_id

string

object[]

unit_price

number

dto.InvoiceLineDTO

object[]

object

created_at

string

currency

string

description

string

id

string

invoice_id

string

line_type

string

object

organization_id

string

period_end

string

period_start

string

price_key

string

price_key_display_name

string

product_id

string

quantity

number

object

tax_category_code

string · enum

Enum values:

tax_exemption_reason

string

tax_rate

number

tax_type

string

object

dto.MeterBindingMeterSummary

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

id

string

key

string

name

string

unit_label

string

dto.MeterDTO

object

created_at

string

dedup_key_path

string

dimensions

string[]

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

id

string

key

string

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

metric_key

string

name

string

negative_allowed

boolean

organization_id

string

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

updated_at

string

value_field

string

object

workspace_id

string

dto.ProductMeterBindingDTO

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

dto.PromotionDTO

application_timing

string · enum

Enum values:

NEXT_CYCLE

RETROACTIVE

IMMEDIATE

archetype

string · enum

Enum values:

generic

coupon_discount

bundle_discount

volume_rebate

first_purchase_credit

free_trial

cross_sell_free

loyalty_ladder

archived_at

string

budget_behavior

string · enum

Enum values:

SKIP

PARTIAL

code

string

condition_mode

string · enum

Enum values:

ALL

ANY

object

object[]

created_at

string

current_budget_used

number

current_redemptions

integer

deleted_at

string

derived_status

string

description

string

object

head_version_id

string

id

string

is_phased

boolean

max_budget

number

max_redemptions

integer

max_redemptions_per_customer

integer

name

string

organization_id

string

object[]

populated when is_phased=true; single Default phase otherwise

priority

integer

public_description

string

published_at

string

published_by

string

remaining_budget

number

remaining_redemptions

integer

requires_continuous_coverage

boolean

stackable

boolean

status

string · enum

Enum values:

draft

scheduled

active

archived

object

updated_at

string

valid_from

string

valid_to

string

version

integer

visibility

string · enum

Enum values:

INTERNAL

PUBLIC

COUPON

dto.ProrationLedgerDTO

object

applied

boolean

change_date

string

currency

string

description

string

id

string

invoice_line_id

string

period_end

string

period_start

string

proration_type

string

dto.ProrationRecordDTO

object

applied

boolean

change_date

string

created_at

string

currency

string

days_remaining

integer

id

string

invoice_id

string

new_quantity

integer

old_quantity

integer

organization_id

string

period_end

string

period_start

string

proration_type

string · enum

Enum values:

CREDIT

CHARGE

subscription_id

string

subscription_item_id

string

object

dto.RefundInvoiceRequest

amount

integer

dto.SubscriptionDTO

object[]

allowed_transitions

string[]

object

auto_renew

boolean

billing_anchor_day

integer

billing_interval_count

integer

billing_interval_unit

string

billing_timing

string

cancellation_reason

string

cancelled_at

string

created_at

string

current_period_end

string

current_period_start

string

object

customer_id

string

deleted_at

string

description

string

object

Drift is populated only when the operator passes ?include=drift on the List endpoint (versioning-ux workstream 05). Computed per-row from plan_versions / product_versions — no storage cost, no schema change.

id

string

object[]

object

name

string

next_billing_date

string

organization_id

string

payment_terms_days

integer

object[]

plan_id

string

plan_version

integer

public_description

string

object

started_at

string

status

string

object

updated_at

string

dto.SubscriptionDriftSummary

latest_version

integer

versions_behind

integer

dto.SubscriptionItemDTO

created_at

string

current_term_end

string

current_term_start

string

id

string

organization_id

string

override_applied

boolean

override_id

string

override_source

string

OverrideSource: "PHASE" when the resolved CUSTOMER_OVERRIDE had phase_id set; "CUSTOMER" when it didn't; empty when no override.

pricing_model

string

product_id

string

product_name

string

product_type

string

product_version_id

string

ProductVersionID surfaces version pinning. nil = follow head.

quantity

integer

renewal_anchor_at

string

subscription_id

string

term_auto_renew

boolean

term_count

integer

term_unit

string

Per-item commitment term (R2/R4). All nil ⇒ the item follows the subscription's cadence (no explicit term). Surfaced read-side so the items tab can show "committed N units · auto-renews · renews <current_term_end>" instead of the term being write-only.

object

updated_at

string

dto.SubscriptionPhaseDTO

auto_transition

boolean

completed_at

string

dunning_stage

string

dunning_stage_at

string

duration_unit

string · enum

Enum values:

day

week

month

billing_cycle

duration_value

integer

end_at

string

end_kind

string · enum

Enum values:

manual

duration

date

ends_at

string

id

string

organization_id

string

phase_kind

string

phase_order

integer

started_at

string

status

string

subscription_id

string

dto.VoidInvoiceResponseDTO

object

dto.WalletDTO

object

auto_topup_enabled

boolean

object

created_at

string

object

currency

string

customer_id

string

object

id

string

is_primary

boolean

object

mode

string · enum

Enum values:

PREPAID

POSTPAID

organization_id

string

object

promotional_balance_expires_at

string

updated_at

string

internal.approval.ApprovalDecision

approval_request_id

string

comment

string

decided_at

string

decided_by

string

decision

string · enum

Enum values:

APPROVED

REJECTED

id

string

step_number

integer

internal.approval.ApprovalDecisionValue

string · enum

Enum values:

APPROVED

REJECTED

internal.approval.ApprovalRequest

created_at

string

current_step

integer

object[]

entity_id

string

entity_type

string

id

string

initiated_by

string

organization_id

string

payload

object

previous_state

object

resolved_at

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

step_started_at

string

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

workflow_template_id

string

internal.approval.ApprovalStatus

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

internal.approval.ApprovalStep

approver_roles

string[]

approver_user_ids

string[]

min_approvals

integer

name

string

notify_on_start

boolean

step_number

integer

timeout_hours

integer

internal.approval.ApprovalWorkflowTemplate

created_at

string

description

string

entity_type

string

id

string

is_active

boolean

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

organization_id

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

object[]

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

internal.approval.ApproveRejectRequest

comment

string

internal.approval.CreateWorkflowTemplateRequest

description

string

entity_type

string

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

object[]

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

internal.approval.RejectionAction

string · enum

Enum values:

REVERT

HOLD

internal.approval.TimeoutAction

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

internal.approval.TriggerAction

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

internal.approval.UpdateWorkflowTemplateRequest

description

string

is_active

boolean

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

object[]

internal.audit.AuditEventRetentionPolicy

created_at

string

event_type

string

id

string

organization_id

string

retention_days

integer

updated_at

string

internal.audit_dto.Actor

email

string

key_id

string

key_prefix

string

label

string

name

string

picture

string

type

string

user_id

string

internal.audit_dto.AuditEvent

object

actor_email

string

actor_key_id

string

actor_key_prefix

string

actor_label

string

actor_name

string

actor_picture

string

actor_type

string

Legacy flat actor fields — duplicated from Actor so FE consumers that still read actor_email / actor_type keep working through Phase 1. Removed in Phase 5 once the renderer-registry rewrite (Phase 2) migrates them onto the nested actor object.

actor_user_id

string

causation_id

string

correlation_id

string

Cascade chain. correlation_id ties together every event in one top-level operation; causation_id points at the immediate parent. Both nil for legacy rows and standalone operations.

customer_id

string

diff

integer[]

domain

string

Catalog metadata. Denormed onto every response so the FE renderer registry doesn't have to ship a parallel descriptor table. When the EventType is unregistered (legacy / forward-compat) these are omitted and the FE falls back to a generic row.

entity

string

entity_id

string

entity_type

string

Subject — the entity the event is "about", plus parent refs the recorder denormalised so the parent-scoped Audit tab surfaces it.

event_type

string

EventType is the canonical wire name (e.g. "subscription.phase.added").

id

string

occurred_at

string

organization_id

string

payload

integer[]

plan_id

string

product_id

string

request_id

string

severity

string

subscription_id

string

summary

string

Content. Summary is the human one-liner shown verbatim in the table; Payload is event-type-specific JSON the per-event renderer parses; Diff is the typed change-set jsonb for mutation events.

trace_id

string

verb

string

visibility

string

internal.audit_dto.CustomerAuditEvent

domain

string

entity

string

entity_id

string

entity_type

string

event_type

string

id

string

occurred_at

string

payload

integer[]

verb

string

internal.credit_note.ApplyCreditNoteRequest

amount

number

invoice_id

string

internal.credit_note.CreateCreditNoteLineRequest

description

string

invoice_line_id

string

line_type

string

object

period_end

string

period_start

string

product_id

string

quantity

number

tax_rate

number

tax_type

string

unit_price

number

internal.credit_note.CreateCreditNoteRequest

currency

string

customer_id

string

invoice_id

string

object[]

object

reason

string

reason_code

string · enum

Enum values:

VOID

REFUND

PROMOTIONAL_CREDIT

CANCELLATION

WITHDRAWAL

DOWNGRADE

ITEM_REMOVAL

OVERPAYMENT

template_id

string

internal.credit_note.CreditNoteReasonCode

string · enum

Enum values:

VOID

REFUND

PROMOTIONAL_CREDIT

CANCELLATION

WITHDRAWAL

DOWNGRADE

ITEM_REMOVAL

OVERPAYMENT

internal.credit_note.CreditNoteStatus

string · enum

Enum values:

draft

issued

partially_applied

applied

void

domain.AddInvoiceLineRequest

amount

number

description

string

line_type

string · enum

Enum values:

PLAN_BASE

SEAT

USAGE

PRORATION_CREDIT

PRORATION_CHARGE

ADD_ON

EXPENSE_PASSTHROUGH

MILESTONE

markup_percent

number

object

period_end

string

period_start

string

product_id

string

quantity

number

tax_rate

number

unit_price

number

domain.AddItemRequest

auto_renew

boolean

effective_at

string

EffectiveAt (Pass B) — when the new item starts being billed. nil → now (immediate add). Future timestamp queues the row for activation at that boundary; the segmenter splits the period at T so [T, periodEnd) includes the new item. Past timestamps are rejected.

price_key

string

product_id

string

proration_mode

string

quantity

integer

term_count

integer

term_unit

string · enum

Optional per-item term (R2/R4). When set, the item bills the whole term upfront on the invoice covering term start and emits no line on subsequent invoices inside the term. See SubscriptionItemInput for the field semantics.

Enum values:

week

month

year

domain.AddProductRequest

included_quantity

number

object

product_id

string

rollover_enabled

boolean

rollover_expiry_periods

integer

rollover_max

number

domain.AdjustRequest

amount

number

positive or negative

reason

string

reference

string

source

string · enum

Enum values:

PAYMENT

REFUND

PROMOTION

INVOICE

CHARGE

FEE

MANUAL

TRANSFER

domain.AdjustmentType

string · enum

Enum values:

override

tier

formula

promotion

conversion

domain.AdvanceTestClockRequest

frozen_at

string

domain.AllowanceStateResponse

current_period_end

string

current_period_start

string

object[]

subscription_id

string

domain.AppliedPromotion

adjustment_kind

string

adjustment_value

number

AdjustmentValue is kind-dependent: rate for percentage_discount, amount for fixed_discount / price_override, periods for free_periods, quantity for free_product. The cents impact is in AppliedAmountMinor and is the only field the replay path reads.

applied_amount_minor

integer

AppliedAmountMinor is the cents removed from the line subtotal. Positive = discount. The replay path applies this directly to the rebuilt line, bypassing the live simulator entirely.

created_at

string

id

string

invoice_id

string

invoice_line_id

string

organization_id

string

promotion_id

string

promotion_version_id

string

domain.AppliesAt

string · enum

Enum values:

REDEEM_TIME

INVOICE_TIME

BOTH

domain.BillingAddress

city

string

country

string

ISO 3166-1 alpha-2

line1

string

line2

string

postal_code

string

state

string

domain.BillingIntervalUnit

string · enum

Enum values:

week

month

year

domain.BillingModel

string · enum

Enum values:

INVOICE

SETTLEMENT

domain.BillingTiming

string · enum

Enum values:

in_advance

in_arrears

domain.BindingRole

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

domain.BreakdownAdjustment

object

label

string

type

string · enum

Enum values:

override

tier

formula

promotion

conversion

domain.BudgetBehavior

string · enum

Enum values:

SKIP

PARTIAL

domain.CancellationReason

string · enum

Enum values:

USER_REQUEST

AUTO_NON_RENEWAL

DUNNING_TERMINAL

domain.CaptureHoldRequest

amount

number

nil = capture full hold amount

reference

string

optional capture reference

domain.ChangeCustomerModeRequest

mode

string · enum

Enum values:

PREPAID

POSTPAID

reason

string

domain.ChangeCustomerTypeRequest

customer_type

string · enum

Enum values:

BUSINESS

CONSUMER

UNKNOWN

reason

string

domain.ChangeQuantityPreviewRequest

effective_at

string

new_quantity

integer

subscription_item_id

string

domain.ChangeQuantityPreviewResult

object

currency

string

days_remaining

integer

object

new_quantity

integer

old_quantity

integer

period_end

string

period_start

string

domain.ChangeQuantityRequest

effective_at

string

new_quantity

integer

subscription_item_id

string

domain.ChangeSubscriptionVersionRequest

strategy

string · enum

Enum values:

immediate_prorate

next_period

at_phase_change

target_latest

boolean

true → resolve to head version

target_version

integer

nil → use TargetLatest

update_track_mode

string · enum

optional — flip pinned↔latest as part of the change

Enum values:

pinned

latest

domain.ChargeKind

string · enum

Enum values:

RECURRING

USAGE

SETUP

domain.ChildVersionPins

object

domain.ComputePriceRequest

debug

boolean

expression

string

formula_id

string

object

domain.ComputePriceResponse

debug_trace

expression

string

formula_id

string

formula_version

integer

result

string

object

domain.ConditionMode

string · enum

Enum values:

ALL

ANY

domain.ConditionPreview

applies_at

string · enum

Enum values:

REDEEM_TIME

INVOICE_TIME

BOTH

passed

boolean

summary

string

type

string

domain.CopyAsDraftRequest

effective_from

string

effective_to

string

note

string

domain.CopyCostRequest

key

string

domain.CopyPriceAsDraftRequest

effective_from

string

effective_to

string

price_key

string

domain.CopyPromotionAsDraftRequest

code

string

name

string

valid_from

string

valid_to

string

domain.CopyTaxRuleAsDraftRequest

object

valid_from

string

valid_to

string

domain.Cost

object

archived_at

string

created_at

string

description

string

object

head_version_id

string

id

string

key

string

object

organization_id

string

product_id

string

requires_continuous_coverage

boolean

scope

string · enum

Enum values:

PRODUCT

ORG

status

string

object

updated_at

string

version

integer

domain.CostExpression

currency

string

source

string

domain.CostScope

string · enum

Enum values:

PRODUCT

ORG

domain.CostVersion

object

cost_id

string

description

string

object

id

string

object

organization_id

string

published_at

string

published_by

string

object

version

integer

domain.CreateBracketEntry

range_max

number

range_min

number

value

number

domain.CreateCostRequest

object

description

string

object

key

string

object

product_id

string

object

domain.CreateCustomFieldDefinitionRequest

auditable

boolean

default_value

object

description

string

display_name

string

object

entity_types

string[]

Enum values:

CUSTOMER

PRODUCT

PLAN

SUBSCRIPTION

object[]

field_group

string

field_type

string · enum

Enum values:

STRING

NUMBER

BOOLEAN

DATE

DATETIME

ENUM

URL

key

string

show_in_table

boolean

sort_order

integer

object

visibility

string · enum

Enum values:

PUBLIC

INTERNAL

write_access

string · enum

Enum values:

ALL

ADMIN_ONLY

SYSTEM_ONLY

domain.CreateCustomerRequest

auto_validate_vat

boolean

AutoValidateVAT is a per-request hint controlling whether the handler kicks off an async VAT validation after creation. nil = default behavior (auto-validate when otherwise eligible). false = skip the auto-trigger even if eligible (useful for bulk imports / automation). Workspace-level verification.vat.enabled and per-customer VatValidationDisabled both still take precedence - this flag only suppresses the optional handler-side dispatch.

object

billing_model

string · enum

Enum values:

INVOICE

SETTLEMENT

object

customer_type

string · enum

Enum values:

BUSINESS

CONSUMER

UNKNOWN

default_auto_topup_amount

number

default_auto_topup_enabled

boolean

default_credit_limit

number

default_low_balance_threshold

number

default_max_balance

number

default_max_single_credit

number

disabled_providers

string[]

Enum values:

stripe

gocardless

einvoice_email

string

email

string

external_id

string

locale

string

object

mode

string · enum

Enum values:

PREPAID

POSTPAID

name

string

payment_terms_days

integer

peppol_id

string

prefer_einvoice

boolean

preferred_currency

string

preferred_provider

string · enum

Enum values:

stripe

gocardless

object

vat_validation_disabled

boolean

vat_validation_disabled_reason

string

domain.CreateFXOverrideRequest

reason

string

snapshot_date

string

source_currency

string

target_currency

string

valid_from

string

nil → now()

valid_to

string

nil → open-ended

domain.CreateLookupEntry

key

string

value

number

domain.CreateMeterRequest

object

dedup_key_path

string

dimensions

string[]

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

key

string

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

metric_key

string

name

string

negative_allowed

boolean

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

value_field

string

object

nil → DefaultWindow()

domain.CreatePaymentMethodRequest

customer_id

string

is_default

boolean

object

provider

string

provider_id

string

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

domain.CreatePhaseRequest

auto_transition

boolean

duration_unit

string · enum

Enum values:

day

week

month

billing_cycle

duration_value

integer

end_at

string

end_kind

string · enum

End policy (M103+).

Enum values:

manual

duration

date

phase_kind

string · enum

Phases are billing-mode markers (M118 trim) — they carry just phase_kind + an end policy + auto_transition. Operator-facing metadata (name / description / translations) and per-phase setting overrides used to ride this struct; they've been removed in favour of subscription-level fields.

Enum values:

setup

trial

standard

paused

dunning

start_at

string

domain.CreatePlanRequest

object

description

string

external_id

string

object

name

string

public_description

string

object

domain.CreatePriceFormulaRequest

expression

string

name

string

object[]

domain.CreatePriceRequest

country_code

string

currency

string

object

customer_id

string

display_name

string

M186 - customer-facing label

effective_from

string

effective_to

string

kind

string · enum

Enum values:

BASE

PLAN_OVERRIDE

CUSTOMER_OVERRIDE

list_price

number

object

plan_id

string

plan_version

integer

price_key

string

product_id

string

object[]

valid_from

string

ValidFrom / ValidTo are the customer-facing time bounds for an override ("this negotiated price applies until 2026-12-31"). Distinct from EffectiveFrom/EffectiveTo which are price-version publish/archive timestamps.

valid_to

string

domain.CreatePriceTierRequest

flat_amount

number

static flat fee

object

formula_id

string

FormulaID + FormulaDefaults are the structured alternative to RateExpression — see PriceTier docs above. When both are set, FormulaID wins; the runtime evaluator looks up the formula and merges defaults at eval time rather than baking everything into a string at create time.

rate_expression

string

ad-hoc expression; overrides unit_amount when present

unit_amount

number

static rate

up_to

number

nil means infinity

domain.CreateProductMeterBindingRequest

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

meter_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

domain.CreateProductRequest

object

description

string

external_id

string

invoiceable_standalone

boolean

InvoiceableStandalone opts the product into the manual-invoice picker on create. Defaults to false (subscription-only).

object

name

string

pricing_model

string · enum

Enum values:

VOLUME

STAIRCASE

PACKAGE

public_description

string

requires_product_ids

string[]

tax_category

string · enum

DEFAULT, REDUCED, ZERO, EXEMPT (defaults to DEFAULT)

Enum values:

DEFAULT

REDUCED

ZERO

EXEMPT

object

type

string · enum

Enum values:

FIXED_CHARGE

SEAT

USAGE

domain.CreatePromotionPhase

object

allow_regression

boolean

defaults to true

object

is_terminal

boolean

defaults to false

min_dwell_days

integer

name

string

phase_transition_timing

string · enum

Enum values:

immediate

next_cycle

prorate

object

domain.CreatePromotionRequest

application_timing

string · enum

Enum values:

NEXT_CYCLE

RETROACTIVE

IMMEDIATE

archetype

string · enum

Enum values:

generic

coupon_discount

bundle_discount

volume_rebate

first_purchase_credit

free_trial

cross_sell_free

loyalty_ladder

budget_behavior

string · enum

Enum values:

SKIP

PARTIAL

code

string

condition_mode

string · enum

Enum values:

ALL

ANY

object

description

string

object

is_phased

boolean

max_budget

number

max_redemptions

integer

max_redemptions_per_customer

integer

name

string

object[]

required when archetype is loyalty_ladder / growth_ladder

priority

integer

public_description

string

stackable

boolean

object

valid_from

string

valid_to

string

visibility

string · enum

Enum values:

INTERNAL

PUBLIC

COUPON

domain.CreateRateTableRequest

default_value

string

description

string

name

string

on_missing_key

string

requires_continuous_coverage

boolean

slug

string

table_type

string

domain.CreateSubscriptionAddOnRequest

product_id

string

quantity

integer

domain.CreateSubscriptionRequest

auto_renew

boolean

billing_anchor_day

integer

billing_interval_count

integer

billing_interval_unit

string · enum

Enum values:

week

month

year

billing_timing

string · enum

BillingTiming defaults to in_arrears when unset - matches the effective behavior every legacy / public-checkout subscription has today (no first invoice on activation; renewal tick picks up the closed period at period_end).

Enum values:

in_advance

in_arrears

currency

string

object

customer_id

string

description

string

object[]

Items defines the products/quantities/prices billed by this subscription (M116+). When omitted and the subscription is plan-based, items default from the plan-version snapshot.

object

name

string

payment_terms_days

integer

object[]

Phases must contain at least one entry. The first entry is the initial ACTIVE phase; subsequent entries are pre-planned PENDING phases. M116+: phases are pure billing-mode markers — items live on the subscription, not the phase.

plan_id

string

Plan-or-product XOR (M102+). When PlanID is set the plan template drives initial phase config; when ProductID is set the subscription is a single-product setup. Exactly one of these may be non-null. PlanID may also be inferred from Phases[0].PlanID for backward- compat — the service prefers the top-level field if set.

product_id

string

product_version

integer

public_description

string

object

start_at

string

start_trigger

string · enum

StartTrigger picks the activation path. Defaults to "immediate". "start_date" requires StartAt to be set.

Enum values:

immediate

on_checkout_complete

manual

start_date

object

version_change_strategy

string · enum

Enum values:

immediate_prorate

next_period

at_phase_change

version_track_mode

string · enum

Version pin/track and change strategy. Defaults: pinned + null strategy (no auto upgrades).

Enum values:

pinned

latest

domain.CreateTagRequest

color

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

name

string

domain.CreateTaxRuleRequest

applies_to_customer_types

string[]

Enum values:

BUSINESS

CONSUMER

UNKNOWN

applies_to_product_categories

string[]

Enum values:

DEFAULT

REDUCED

ZERO

EXEMPT

applies_to_supply_types

string[]

Enum values:

DOMESTIC

INTRA_EU_B2B

INTRA_EU_B2C

EXPORT

apply_order

integer

inclusive

boolean

is_compound

boolean

jurisdiction_country

string

jurisdiction_region

string

object

rate

number

requires_continuous_coverage

boolean

tax_type

string · enum

Enum values:

VAT

SALES_TAX

GST

CUSTOM

valid_from

string

valid_to

string

domain.CreateTestClockRequest

frozen_at

string

name

string

domain.CreateTestPaymentSimulationRequest

outcome

string · enum

Enum values:

success

decline

insufficient_funds

expired_card

fraud

processing_error

network_error

payment_method_id

string

domain.CreateVerificationRequest

check_type

string · enum

Enum values:

VAT

IDENTITY

KYC

SANCTIONS

customer_id

string

provider

string

verification_type

string

domain.CreateVersionRequest

object[]

clone_from_version_id

string

effective_from

string

effective_to

string

object[]

note

string

domain.CreateWalletRequest

auto_topup_amount

number

auto_topup_enabled

boolean

credit_limit

number

currency

string

customer_id

string

low_balance_threshold

number

max_balance

number

max_single_credit

number

domain.CreateWorkspaceCurrencyRequest

billing_enabled

boolean

catalog_enabled

boolean

currency_code

string

domain.CreateWorkspaceRequest

mode

string · enum

Enum values:

live

sandbox

name

string

slug

string

domain.CreditRequest

amount

number

expires_at

string

reason

string

reference

string

source

string · enum

Enum values:

PAYMENT

REFUND

PROMOTION

INVOICE

CHARGE

FEE

MANUAL

TRANSFER

domain.CurrencyReferences

costs

integer

credit_notes

integer

customers

integer

invoices

integer

prices

integer

subscriptions

integer

total

integer

wallets

integer

domain.CustomFieldDefinition

auditable

boolean

created_at

string

default_value

object

deleted_at

string

object

deprecated_at

string

description

string

display_name

string

object

entity_types

string[]

Enum values:

CUSTOMER

PRODUCT

PLAN

SUBSCRIPTION

object[]

field_group

string

field_type

string · enum

Enum values:

STRING

NUMBER

BOOLEAN

DATE

DATETIME

ENUM

URL

id

string

key

string

organization_id

string

show_in_table

boolean

sort_order

integer

status

string · enum

Enum values:

draft

scheduled

active

deprecated

archived

updated_at

string

object

version

integer

visibility

string · enum

Enum values:

PUBLIC

INTERNAL

write_access

string · enum

Enum values:

ALL

ADMIN_ONLY

SYSTEM_ONLY

domain.CustomFieldEntityType

string · enum

Enum values:

CUSTOMER

PRODUCT

PLAN

SUBSCRIPTION

domain.CustomFields

No data returned

domain.Customer

object

billing_model

string · enum

Enum values:

INVOICE

SETTLEMENT

created_at

string

object

customer_type

string · enum

Enum values:

BUSINESS

CONSUMER

UNKNOWN

default_auto_topup_amount

number

default_auto_topup_enabled

boolean

default_credit_limit

number

default_low_balance_threshold

number

default_max_balance

number

default_max_single_credit

number

deleted_at

string

disabled_providers

string[]

Enum values:

stripe

gocardless

einvoice_email

string

email

string

external_id

string

id

string

locale

string

object

mode

string · enum

Enum values:

PREPAID

POSTPAID

name

string

organization_id

string

payment_terms_days

integer

peppol_id

string

prefer_einvoice

boolean

preferred_currency

string

preferred_provider

string · enum

Enum values:

stripe

gocardless

status

string · enum

Enum values:

active

suspended

churned

object[]

object

updated_at

string

vat_validation_disabled

boolean

vat_validation_disabled_reason

string

vat_validation_status

string · enum

Enum values:

UNVALIDATED

PENDING

VALID

INVALID

ERROR

MANUAL

MAINTENANCE

domain.CustomerAttributeCondition

object

tag_ids

string[]

domain.CustomerStatus

string · enum

Enum values:

active

suspended

churned

domain.CustomerType

string · enum

Enum values:

BUSINESS

CONSUMER

UNKNOWN

domain.CustomerVerification

actor_id

string

check_type

string · enum

Enum values:

VAT

IDENTITY

KYC

SANCTIONS

created_at

string

customer_id

string

expires_at

string

id

string

last_checked_at

string

organization_id

string

provider

string

provider_reference

string

reason

string

result_payload

integer[]

status

string · enum

Enum values:

pending

verified

expired

failed

manual

maintenance

updated_at

string

verification_type

string

verified_at

string

domain.DebitRequest

amount

number

reason

string

reference

string

source

string · enum

Enum values:

PAYMENT

REFUND

PROMOTION

INVOICE

CHARGE

FEE

MANUAL

TRANSFER

domain.DependsOn

condition

string

equals, not_equals, is_set, is_not_set

effect

string

required, hidden

field_key

string

value

string

domain.DimensionVars

string

domain.DurationUnit

string · enum

Enum values:

day

week

month

billing_cycle

domain.EUVATRate

country_code

string

ISO 3166-1 alpha-2

country_name

string

effective_from

string

effective_to

string

parking_rate

number

parking rate (0 if none)

reduced_rate

number

primary reduced rate

reduced_rate_2

number

second reduced rate (0 if none)

standard_rate

number

e.g. 0.19 for 19%

super_reduced

number

super-reduced rate (0 if none)

domain.EffectScope

charge_kinds

string[]

Enum values:

RECURRING

USAGE

SETUP

excluded_product_ids

string[]

product_types

string[]

Enum values:

FIXED_CHARGE

SEAT

USAGE

target_product_ids

string[]

domain.EndKind

string · enum

Enum values:

manual

duration

date

domain.EnrichedPlanProduct

object[]

Costs + MeterBindings are HEAD-state summaries (no pin table exists for either today), letting the FE plan-details sheet show what the operator currently has configured per product without an extra round-trip per row. Empty slices when the product has nothing attached, so the FE can render conditionally on length > 0 without nil checks.

created_at

string

id

string

included_quantity

number

object

object[]

organization_id

string

plan_id

string

object[]

pricing_model

string · enum

Enum values:

VOLUME

STAIRCASE

PACKAGE

product_head_version_id

string

ProductHeadVersionID is the product's CURRENT live head (products.head_version_id). Surfaced alongside ProductVersionID so the FE plan-stage UI can compute drift / "use latest" without an extra per-row fetch: when ProductHeadVersionID !== ProductVersionID the plan's pin trails the product's live head. Always present once the product is loaded; nullable only for defensive serialization.

product_id

string

product_name

string

product_type

string · enum

Enum values:

FIXED_CHARGE

SEAT

USAGE

product_version_id

string

ProductVersionID is the product_version_id pinned for THIS product by the plan's current head plan_version. Phase 2.E surfaces this on the wire so the FE can show, per row, "v3 is what the live plan version uses for this product" — without it every chip falls back to the product's own live head, defeating the operator's "see what the plan pins" intent. Nullable: an unpinned row (legacy data, in-progress draft) renders the chip in its plain head-fallback state.

rollover_enabled

boolean

rollover_expiry_periods

integer

rollover_max

number

domain.EntityRefConfig

display_field

string

target_entity_type

string

domain.EnumOption

label

string

value

string

domain.ExternalVerificationCondition

verification_type

string

domain.FXOverride

created_at

string

deleted_at

string

id

string

organization_id

string

reason

string

snapshot_date

string

SnapshotDate pins the override to a specific calendar day's rate snapshot — plain-date semantic, mirrors FXSnapshot.SnapshotDate. ValidFrom / ValidTo are TIMESTAMPTZ instants (the activation window of the override itself, which legitimately has wall-clock semantics — "this override kicks in at 09:00 Friday Berlin").

source_currency

string

target_currency

string

updated_at

string

valid_from

string

valid_to

string

workspace_id

string

domain.FXPolicy

string · enum

Enum values:

invoice_issue

period_start

per_segment

daily_snapshot

invoice_issue

period_start

domain.FXSnapshot

created_at

string

id

string

rate

string

decimal string for precision

snapshot_date

string

SnapshotDate is the calendar day this rate snapshot represents. One snapshot per (date, source, target) — the rate is what the configured source (ECB, etc.) published for that day. Plain-date semantic: no clock, no zone. Postgres column type is DATE.

source

string

source_currency

string

target_currency

string

domain.FieldStatus

string · enum

Enum values:

draft

scheduled

active

deprecated

archived

domain.FieldType

string · enum

Enum values:

STRING

NUMBER

BOOLEAN

DATE

DATETIME

ENUM

URL

domain.FilterNode

object[]

field

string

Leaf-only: Field is a dotted JSON path into the event's metadata jsonb, e.g. "tier" or "request.region". Empty for group nodes.

op

string · enum

Enum values:

AND

neq

gte

lte

value

Value is the comparison RHS. For "in" / "not_in" it must be a JSON array; for "exists" / "not_exists" it is unused; for the other ops it is a scalar.

domain.FilterOperator

string · enum

Enum values:

AND

neq

gte

lte

domain.FilterTree

object

domain.FirstPurchaseCondition

domain.FixedDiscountEffect

amount

number

apply_per_line

boolean

cap_per_invoice

number

cap_per_period

number

object

domain.FormulaBindings

No data returned

domain.FormulaVarType

string · enum

Enum values:

number

string

boolean

domain.FormulaVariable

default

number

name

string

type

string · enum

Enum values:

number

string

boolean

domain.FreePeriodsEffect

periods

integer

object

domain.FreeProductEffect

product_id

string

quantity

number

object

domain.GenerateInvoiceRequest

billing_period_end

string

billing_period_start

string

locale

string

subscription_id

string

domain.HoldRequest

amount

number

currency

string

Currency is optional on the public hold API: when empty the wallet's currency is used. Reserve and other internal callers always pass it explicitly so a mismatch with the wallet's currency fails loudly.

expires_at

string

metric_key

string

reason

string

reference_id

string

reference_type

string

reverse_charge

boolean

subscription_id

string

SubscriptionID and MetricKey are populated by the reserve service so the (subscription_id, metric_key) pair becomes queryable. The public hold API leaves them nil - those holds are not subject to the ingest-overlap check.

tax_rate

number

tax_rule_id

string

domain.HoldStatus

string · enum

Enum values:

PENDING

CAPTURED

VOIDED

EXPIRED

domain.IncludedQuantitySource

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

domain.IngestEventRequest

customer_id

string

object

external_cost_amount

number

external_cost_currency

string

hold_id

string

idempotency_key

string

object

metric_key

string

price_key

string

M186 - required for keyed products

object

product_id

string

quantity

number

subscription_id

string

timestamp

string

Timestamp is the moment the event occurred (when the customer consumed the unit). Optional — when absent or zero, the server stamps it from time.Now() at ingest. Backfill / historical imports set this explicitly to whatever the source recorded. Distinct from UsageEvent.IngestedAt, which is always the server-side ingestion instant.

wallet_currency

string

WalletCurrency optionally pins the event to a specific wallet. Shape parity with /reserve's wallet_currency. Validated at ingest: the wallet must exist for (customer_id, wallet_currency). NULL falls back to the customer's preferred-currency cascade at finalize — the pre-040 single-wallet path.

domain.Invoice

amount_due

number

amount_paid

number

billing_period_end

string

billing_period_start

string

buyer_reference

string

Leitweg-ID / PO number

created_at

string

currency

string

customer_id

string

customer_profile_at_issue

string

CustomerProfileAtIssue pins the buyer's CustomerType profile (BUSINESS / CONSUMER / UNKNOWN) at finalize time. Regenerate uses this snapshot (NOT live customer.CustomerType) so a later profile flip cannot retroactively re-classify a closed invoice's supply type or reverse-charge gating. Audit-layer addition for ADR-0004 Decision 4 (billing-audit workstream 11).

Nil for legacy invoices written before migration 007.

deleted_at

string

delivery_date

string

Leistungsdatum (§14 Abs. 4 Nr. 6)

due_date

string

id

string

invoice_number

string

invoice_type

string · enum

INVOICE, CREDIT_NOTE, CORRECTIVE

Enum values:

INVOICE

CREDIT_NOTE

CORRECTIVE

issue_exchange_rate_id

string

issued_at

string

last_dunning_step_at

string

last_dunning_step_index

integer

object[]

locale

string

object

organization_id

string

paid_at

string

period_start_exchange_rate_id

string

plan_id

string

PlanID / PlanVersion stamp the plan-version snapshot pinned at finalize. Regenerate uses these (NOT live sub.PlanID/PlanVersion) to reproduce historical invoices byte-for-byte, satisfying ADR-0004 rule 4: "plan-version snapshot is immutable post-publish."

Sourced from the active subscription_plan_version_history row at the invoice's billing_period_start (or first segment's start - see pipeline_finalize.stampPlanSnapshot for the chosen anchor).

Nil for plan-less subscriptions (item-only billing).

plan_version

integer

status

string · enum

Enum values:

draft

finalized

paid

void

overdue

pending_approval

error

subscription_id

string

subtotal

number

supplier_tax_number

string

Denormalized for rendering

supplier_vat_id

string

Denormalized for rendering

supply_type

string · enum

DOMESTIC, INTRA_EU_B2B, etc.

Enum values:

DOMESTIC

INTRA_EU_B2B

INTRA_EU_B2C

EXPORT

object[]

tax_category_code

string · enum

EN 16931 BT-151

Enum values:

tax_exemption_reason

string

"Reverse Charge §13b UStG" etc.

tax_point_date

string

Steuerentstehung

tax_total

number

total

number

updated_at

string

domain.InvoiceLine

object[]

AppliedPromotions holds the audit-layer snapshot of every promotion that touched this line's subtotal at finalize. Regenerate reads these (NOT the live promotion catalog) and replays the cents verbatim. Per ADR-0004 Decision 4 and billing-audit workstream 10: voiding or editing a promotion does not change historical totals.

object[]

object

charge_ledger_id

string

ChargeLedgerID back-references the single charge_ledger row that produced this line when no collapse happened. Nil for lines built by the resolver-at-invoice-time path (still the default for SEAT / USAGE / ADD_ON / proration as of PR 2), for lines that merged multiple ledger rows, or for manually edited lines. Persisted in invoice_lines.charge_ledger_id; the authoritative reverse mapping is charge_ledger.invoice_line_id (set inside the same tx as the invoice insert).

created_at

string

description

string

fx_policy_applied

string · enum

Enum values:

invoice_issue

period_start

per_segment

daily_snapshot

invoice_issue

period_start

id

string

invoice_id

string

line_type

string · enum

Enum values:

PLAN_BASE

SEAT

USAGE

PRORATION_CREDIT

PRORATION_CHARGE

ADD_ON

EXPENSE_PASSTHROUGH

MILESTONE

object

organization_id

string

period_end

string

period_start

string

price_key

string

price_key_display_name

string

price_version_id

string

product_id

string

quantity

number

segment_exchange_rate_id

string

subtotal

number

tax_amount

number

tax_category_code

string · enum

EN 16931 BT-151: S, Z, E, AE, K, G, O

Enum values:

tax_exemption_reason

string

BT-120: per-line reason text

tax_rate

number

tax_rule_id

string

tax_type

string

unit_price

number

domain.InvoiceLineAtom

atom_index

integer

binding_version_id

string

created_at

string

exchange_rate_id

string

fx_policy_applied

string · enum

Enum values:

invoice_issue

period_start

per_segment

daily_snapshot

invoice_issue

period_start

id

string

invoice_line_id

string

meter_version_id

string

MeterVersionID + BindingVersionID pin the meter and product-meter binding shapes (function, filter_tree, window_spec, pricing_var_name, overlay_filters) used at finalize time. On Regenerate the BindingResolver short-circuits to these versions so a later mutation of the meter or binding cannot retroactively reinterpret historical usage. Nil for non-usage atoms. See ADR-0004 Decision 4 and billing-audit workstream 02.

organization_id

string

period_end

string

period_start

string

price_key

string

price_key_display_name

string

price_version_id

string

quantity

number

subtotal

number

tax_amount

number

object[]

tax_rate

number

tax_rule_id

string

object[]

unit_price

number

domain.InvoiceLineAtomTaxComponent

amount

number

atom_id

string

base

number

component_index

integer

id

string

is_compound

boolean

organization_id

string

rate

number

tax_rule_id

string

tax_type

string

domain.InvoiceLineAtomTier

amount

number

atom_id

string

id

string

lower_bound

number

organization_id

string

quantity

number

tier_index

integer

tier_label

string

unit_price

number

upper_bound

number

domain.InvoiceLineType

string · enum

Enum values:

PLAN_BASE

SEAT

USAGE

PRORATION_CREDIT

PRORATION_CHARGE

ADD_ON

EXPENSE_PASSTHROUGH

MILESTONE

domain.InvoiceStatus

string · enum

Enum values:

draft

finalized

paid

void

overdue

pending_approval

error

domain.InvoiceType

string · enum

Enum values:

INVOICE

CREDIT_NOTE

CORRECTIVE

domain.LateEventPolicy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

domain.MergeConflict

plan_id

string

source_subscription_id

string

target_subscription_id

string

domain.MergeCustomerRequest

source_customer_id

string

strategy

string · enum

Enum values:

PREVIEW

MOVE_ALL

target_customer_id

string

domain.MergeResult

object[]

customer_scoped_prices_count

integer

invoices_count

integer

payment_methods_count

integer

promotion_redemptions_count

integer

source_customer_id

string

subscriptions_count

integer

object

target_customer_id

string

usage_events_count

integer

wallets_merged_count

integer

wallets_moved_count

integer

domain.MergeStrategy

string · enum

Enum values:

PREVIEW

MOVE_ALL

domain.Metadata

No data returned

domain.MeterBreach

action_event_type

string

action_kind

string

action_target

string

comparator

string

delivered_at

string

id

string

meter_id

string

meter_key

string

observed_value

string

occurred_at

string

organization_id

string

product_id

string

subscription_id

string

threshold_name

string

threshold_value

string

window_end

string

window_start

string

domain.MeterFormula

expression

string

e.g. "max(0, calls - free)"

object

var name → source meter id

domain.MeterFunction

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

domain.MigrateMode

string · enum

Enum values:

PREVIEW

IMMEDIATE

SCHEDULED

domain.MigrateSubscribersRequest

mode

string · enum

Enum values:

PREVIEW

IMMEDIATE

SCHEDULED

proration_strategy

string

scheduled_at

string

target_version

integer

domain.MinimumSpendCondition

amount

number

max_amount

number

scope

string · enum

Enum values:

per_invoice

period

lifetime

domain.OrgTaxProfile

object

Registered office address

legal_name

string

Full registered company name

oss_country

string

ISO 3166-1 alpha-2 of OSS registration

tax_number

string

Steuernummer (DE: XXX/XXX/XXXXX)

tax_regime

string · enum

STANDARD, KLEINUNTERNEHMER, OSS, NON_EU

Enum values:

STANDARD

KLEINUNTERNEHMER

OSS

NON_EU

vat_id

string

USt-IdNr (DE: DE123456789)

domain.PaymentMethod

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

Display fields populated by the provider sync (card brand / last4 / expiry for card methods, bank name / account_last4 for DD methods). All optional - cards leave bank_* nil and vice versa. Carried as pointers so the JSON omits the key entirely when the column is NULL.

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string

domain.PaymentMethodStatus

string · enum

Enum values:

active

expired

removed

domain.PaymentMethodType

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

domain.PaymentOutcome

string · enum

Enum values:

success

decline

insufficient_funds

expired_card

fraud

processing_error

network_error

domain.PercentageDiscountEffect

apply_per_line

boolean

cap_per_invoice

number

cap_per_period

number

max_discount

number

rate

number

object

domain.PhaseKind

string · enum

Enum values:

setup

trial

standard

paused

dunning

domain.PhaseStatus

string · enum

Enum values:

PENDING

ACTIVE

COMPLETED

SKIPPED

domain.PhaseTransitionTiming

string · enum

Enum values:

immediate

next_cycle

prorate

domain.Plan

archived_at

string

created_at

string

object

deleted_at

string

deprecated_at

string

description

string

external_id

string

head_version_id

string

id

string

object

name

string

organization_id

string

public_description

string

published_at

string

published_by

string

requires_continuous_coverage

boolean

status

string · enum

Enum values:

draft

scheduled

active

archived

object[]

object

updated_at

string

version

integer

domain.PlanPricePreviewLine

currency

string

error

string

included_quantity

integer

IncludedQuantity is the operator-configured floor that's bundled into the base subscription price. Non-zero only for SEAT products with included_quantity set. The line displays the TOTAL quantity (Quantity above) but TotalAmount is computed from (Quantity - IncludedQuantity) so the customer doesn't pay for seats they already get with the base price.

pricing_model

string

product_id

string

product_name

string

product_type

string

quantity

integer

object

tax_rate

number

object

domain.PlanPricePreviewRequest

billing_interval_unit

string · enum

Enum values:

week

month

year

currency

string

Currency forces price resolution into a specific currency when the plan exposes prices in multiple ones. Nil falls back to the resolver's implicit pick (customer preferred currency → first available). When set, the field flows verbatim into the per-line ResolvePriceRequest the preview service builds.

customer_id

string

object[]

plan_id

string

domain.PlanPricePreviewResponse

currency

string

object[]

object

domain.PlanProduct

created_at

string

id

string

included_quantity

number

object

organization_id

string

plan_id

string

product_id

string

rollover_enabled

boolean

rollover_expiry_periods

integer

rollover_max

number

domain.PlanProductCostSummary

object

cost_id

string

description

string

object

key

string

requires_continuous_coverage

boolean

scope

string · enum

Enum values:

PRODUCT

ORG

domain.PlanProductMeterBindingSummary

binding_id

string

meter_id

string

meter_key

string

meter_name

string

pricing_var_name

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

domain.PlanProductPriceSummary

country_code

string

currency

string

display_name

string

M186 - customer-facing label for the price_key

list_price

number

price_id

string

price_key

string

price_version_id

string

PriceVersionID pins this summary entry to the exact PriceVersion row that was active when the plan was published. Without this pin the plan's "snapshot" only captured price values (list_price etc.) — a later head-version change on the same price would invalidate the snapshot's intent silently. Nullable for back-compat with pre-Step-8 plan_version_products rows.

domain.PlanStatus

string · enum

Enum values:

draft

scheduled

active

archived

domain.PlanTransitionRequest

new_plan_id

string

object

proration_mode

string

domain.PlanVersion

id

string

organization_id

string

plan_id

string

published_at

string

object

version

integer

domain.PlanVersionProduct

included_quantity

number

object

object[]

pricing_model

string · enum

Enum values:

VOLUME

STAIRCASE

PACKAGE

product_id

string

product_name

string

product_type

string · enum

Enum values:

FIXED_CHARGE

SEAT

USAGE

product_version_id

string

ProductVersionID pins the ProductVersion row in force when the plan was published — closes the "plans pin products" invariant. Nullable for back-compat with rows written before Step 8.

rollover_enabled

boolean

rollover_expiry_periods

integer

rollover_max

number

object

domain.PlanVersionSnapshot

description

string

object

plan_name

string

object[]

domain.Price

archived_at

string

country_code

string

created_at

string

currency

string

object

customer_id

string

deleted_at

string

display_name

string

effective_from

string

effective_to

string

head_version_id

string

id

string

kind

string · enum

Enum values:

BASE

PLAN_OVERRIDE

CUSTOMER_OVERRIDE

list_price

number

object

organization_id

string

plan_id

string

plan_version

integer

price_key

string

product_id

string

requires_continuous_coverage

boolean

status

string · enum

Enum values:

draft

scheduled

active

archived

object[]

updated_at

string

valid_from

string

valid_to

string

version

integer

domain.PriceBreakdown

object[]

object

domain.PriceFormula

created_at

string

expression

string

head_version_id

string

HeadVersionID points at the currently-active row in price_formula_versions. Nil only during a brief window between INSERT INTO price_formulas and the auto-publish of v1.

id

string

is_system

boolean

name

string

organization_id

string

updated_at

string

object[]

version

integer

domain.PriceKind

string · enum

Enum values:

BASE

PLAN_OVERRIDE

CUSTOMER_OVERRIDE

domain.PriceOverrideEffect

override_amount

number

object

domain.PriceStatus

string · enum

Enum values:

draft

scheduled

active

archived

domain.PriceTier

created_at

string

flat_amount

number

flat fee (STAIRCASE)

object

FormulaDefaults supplies per-tier overrides of the formula's declared variable defaults. Numeric values; the JSON column is {} by default. Empty map ⇒ "use formula defaults / require at runtime" — the evaluator never silently substitutes 0 here.

formula_id

string

FormulaID points to a price_formulas row. When set, the runtime evaluator uses formula.expression and merges variables from (transaction context > FormulaDefaults > formula declared defaults), erroring with MissingFormulaVariablesError if any variable lands unresolved. Either FormulaID or RateExpression drives the tier rate; UnitAmount is the fallback when both are nil.

id

string

price_id

string

rate_expression

string

simple arithmetic: "cost * 1.15 + 200"

tier_order

integer

unit_amount

number

per-unit rate (TIERED, VOLUME)

up_to

number

nil means infinity (last tier)

updated_at

string

domain.PriceVersion

object

CostVersionPins maps each cost. referenced by this price's tier expressions to the cost_version_id that was active when this price-version was published. Replays use these pins to evaluate the formula against historically-correct cost values, decoupled from any later cost edits.

country_code

string

currency

string

object

customer_id

string

display_name

string

snapshot of prices.display_name at publish (M186)

effective_from

string

effective_to

string

object

FormulaVersionPins maps each tier.FormulaID referenced by this price-version's tiers to the price_formula_version_id active at publish time. Phase 2 of formula versioning (Phase 1 deref'd FormulaID to the current head; this lets replay use the historical formula version instead). Map key is formula_id stringified — same shape as cost_version_pins. Empty when no tier references a formula.

id

string

kind

string · enum

Enum values:

BASE

PLAN_OVERRIDE

CUSTOMER_OVERRIDE

list_price

number

object

organization_id

string

plan_id

string

price_id

string

price_key

string

product_id

string

published_at

string

published_by

string

object[]

version

integer

domain.PricingModel

string · enum

Enum values:

VOLUME

STAIRCASE

PACKAGE

domain.PricingVars

number

domain.Product

archived_at

string

object[]

named cost variants (eager-loaded)

created_at

string

object

deleted_at

string

deprecated_at

string

description

string

external_id

string

head_version_id

string

id

string

invoiceable_standalone

boolean

InvoiceableStandalone is the Phase 2.5 curation flag. When true, the product is eligible to appear in the manual-invoice product picker and the Phase 2 line resolver accepts it. When false (the default), the product is subscription-only / off-catalog and the resolver rejects attempts to put it on a manual invoice line. Edited live on the parent (Bucket-A); no version bump.

object

name

string

organization_id

string

pricing_model

string · enum

Enum values:

VOLUME

STAIRCASE

PACKAGE

public_description

string

published_at

string

published_by

string

requires_continuous_coverage

boolean

requires_product_ids

string[]

status

string · enum

Enum values:

draft

scheduled

active

archived

object[]

tax_category

string · enum

DEFAULT, REDUCED, ZERO, EXEMPT

Enum values:

DEFAULT

REDUCED

ZERO

EXEMPT

object

type

string · enum

Enum values:

FIXED_CHARGE

SEAT

USAGE

updated_at

string

version

integer

domain.ProductAllowanceState

billable_usage

number

consumed_allowance

number

credit_allowance

number

plan_allowance

number

product_id

string

product_name

string

remaining_allowance

number

rollover_allowance

number

total_allowance

number

total_usage

number

domain.ProductCombinationCondition

grace_period_days

integer

nil/0 = strict; N = allow N-day window

product_ids

string[]

domain.ProductSaving

object

product_id

string

product_name

string

domain.ProductStatus

string · enum

Enum values:

draft

scheduled

active

archived

domain.ProductTaxCategory

string · enum

Enum values:

DEFAULT

REDUCED

ZERO

EXEMPT

domain.ProductType

string · enum

Enum values:

FIXED_CHARGE

SEAT

USAGE

domain.ProformaInvoice

billing_period_end

string

billing_period_start

string

currency

string

customer_id

string

object[]

subscription_id

string

subtotal

number

tax_total

number

total

number

domain.ProformaInvoiceLine

object

description

string

line_type

string

object

period_end

string

period_start

string

product_id

string

quantity

number

subtotal

number

tax_amount

number

tax_rate

number

tax_type

string

unit_price

number

domain.Promotion

application_timing

string · enum

Enum values:

NEXT_CYCLE

RETROACTIVE

IMMEDIATE

archetype

string · enum

Enum values:

generic

coupon_discount

bundle_discount

volume_rebate

first_purchase_credit

free_trial

cross_sell_free

loyalty_ladder

archived_at

string

budget_behavior

string · enum

Enum values:

SKIP

PARTIAL

code

string

condition_mode

string · enum

Enum values:

ALL

ANY

object

created_at

string

current_budget_used

number

current_redemptions

integer

deleted_at

string

description

string

object

head_version_id

string

id

string

is_phased

boolean

max_budget

number

max_redemptions

integer

max_redemptions_per_customer

integer

name

string

organization_id

string

object[]

populated when is_phased=true; single Default phase otherwise

priority

integer

public_description

string

published_at

string

published_by

string

requires_continuous_coverage

boolean

stackable

boolean

status

string · enum

Enum values:

draft

scheduled

active

archived

object

updated_at

string

valid_from

string

valid_to

string

version

integer

visibility

string · enum

Enum values:

INTERNAL

PUBLIC

COUPON

domain.PromotionArchetype

string · enum

Enum values:

generic

coupon_discount

bundle_discount

volume_rebate

first_purchase_credit

free_trial

cross_sell_free

loyalty_ladder

domain.PromotionConditions

object

first_purchase

object

domain.PromotionEffects

object

domain.PromotionPhase

object

allow_regression

boolean

created_at

string

object

id

string

is_terminal

boolean

min_dwell_days

integer

name

string

organization_id

string

phase_order

integer

phase_transition_timing

string · enum

Enum values:

immediate

next_cycle

prorate

promotion_id

string

object

updated_at

string

domain.PromotionPreviewRequest

customer_id

string

subscription_id

string

domain.PromotionPreviewResponse

object[]

object

effect_summary

string

eligible

boolean

promotion_id

string

promotion_name

string

reason

string

domain.PromotionRedemption

applied_at

string

archetype

string · enum

Enum values:

generic

coupon_discount

bundle_discount

volume_rebate

first_purchase_credit

free_trial

cross_sell_free

loyalty_ladder

object

created_at

string

current_phase_id

string

Welle 4: which phase the redemption is in

customer_id

string

dormant_reason

string

brief reason text, e.g. "eligibility_lost"

dormant_since

string

populated when status=dormant

object

expires_at

string

free_periods_remaining

number

nil = unused; DECIMAL so mid-cycle pro-rated invoices consume fractional amounts (e.g. 0.5 for a half-period line)

grace_period_expires_at

string

for pending redemptions

id

string

organization_id

string

phase_entered_at

string

when the current phase was entered

promotion_id

string

promotion_name

string

promotion_version

integer

status

string · enum

Enum values:

active

dormant

expired

revoked

pending

subscription_id

string

updated_at

string

domain.PromotionRedemptionStatus

string · enum

Enum values:

active

dormant

expired

revoked

pending

domain.PromotionStatus

string · enum

Enum values:

draft

scheduled

active

archived

domain.PromotionTiming

string · enum

Enum values:

NEXT_CYCLE

RETROACTIVE

IMMEDIATE

domain.PromotionVisibility

string · enum

Enum values:

INTERNAL

PUBLIC

COUPON

domain.ProrationType

string · enum

Enum values:

CREDIT

CHARGE

domain.ProviderID

string · enum

Enum values:

stripe

gocardless

domain.QuantityThresholdCondition

max_quantity

integer

min_quantity

integer

product_id

string

domain.RateTable

created_at

string

default_value

string

deleted_at

string

description

string

head_version_id

string

id

string

lifecycle_status

string

draft | active | archived

name

string

on_missing_key

string

error | zero | default_value

organization_id

string

requires_continuous_coverage

boolean

slug

string

table_type

string

lookup | bracket

updated_at

string

domain.RateTableEntry

id

string

lookup_key

string

range_max

number

range_min

number

value

number

domain.RateTableVersion

archived_at

string

created_at

string

effective_from

string

effective_to

string

object[]

id

string

note

string

published_at

string

published_by

string

rate_table_id

string

status

string

draft | active | archived

version

integer

domain.RedeemPromotionRequest

coupon_code

string

customer_id

string

subscription_id

string

domain.RegenerateInvoiceResult

missing_product_ids

string[]

new_product_ids

string[]

original_invoice_id

string

object

subtotal_delta

number

tax_delta

number

total_delta

number

domain.RemoveItemRequest

effective_at

string

EffectiveAt (Pass B) — when this item stops being billed. nil → now (immediate close). Future timestamp queues a clean effective_to set at that boundary; segmenter excludes the row from [T, periodEnd) but keeps it for [periodStart, T). Past timestamps are rejected.

proration_mode

string

subscription_item_id

string

domain.ResolvePriceRequest

at_price_version_id

string

at_time

string

country_code

string

currency

string

customer_id

string

object

plan_id

string

plan_version

integer

PlanVersion narrows PLAN_OVERRIDE matching to overrides created for this exact plan version. Required when PlanID is set — the resolver returns an error otherwise. Sub-scoped callers pass sub.PlanVersion; catalog callers passing PlanID also pass the plan's current head version.

price_key

string

object

product_id

string

quantity

number

subscription_id

string

domain.SetVATManualOverrideRequest

expires_at

string

reason

string

status

string

domain.SetVersionTrackRequest

mode

string · enum

Enum values:

pinned

latest

strategy

string · enum

Enum values:

immediate_prorate

next_period

at_phase_change

domain.SimulateChangesRequest

object[]

new_plan_id

string

object[]

domain.SimulateInvoice

object[]

object

domain.SimulateInvoiceLine

object

description

string

product_id

string

object

domain.SimulateRequest

billing_period_end

string

billing_period_start

string

customer_id

string

promotion_ids

string[]

subscription_id

string

domain.SimulateResponse

object

domain.SimulateSavings

object[]

object

domain.SimulationLineItem

object

description

string

object

tax_rate

number

type

string

domain.SimulationResult

object

currency

string

object[]

object

domain.SpendScope

string · enum

Enum values:

per_invoice

period

lifetime

domain.StartTrigger

string · enum

Enum values:

immediate

on_checkout_complete

manual

start_date

domain.Subscription

auto_renew

boolean

billing_anchor_day

integer

billing_interval_count

integer

billing_interval_unit

string · enum

Enum values:

week

month

year

billing_timing

string · enum

Enum values:

in_advance

in_arrears

cancellation_reason

string · enum

Discriminates how the subscription reached CANCELLED. Nil unless status == CANCELLED. See CancellationReason constants.

Enum values:

USER_REQUEST

AUTO_NON_RENEWAL

DUNNING_TERMINAL

cancelled_at

string

created_at

string

currency

string

current_period_end

string

current_period_start

string

current_phase_id

string

CurrentPhaseID is the cached pointer to the ACTIVE phase row; derivable but kept hot for the invoice path. Set during ActivatePhase, cleared during Cancel.

object

customer_id

string

deleted_at

string

description

string

id

string

object[]

Items is the canonical product list for this subscription. Populated by GetByID / List from subscription_items (M116+).

object

name

string

organization_id

string

payment_terms_days

integer

object[]

Phases is the chain of phase records (M116+: pure billing-mode markers — items don't live on phases anymore).

plan_id

string

Plan-or-product XOR (M102+). Exactly one of PlanID/ProductID set (or both null while DRAFT and undecided). PlanVersion/ProductVersion pin the snapshot; VersionTrackMode/VersionChangeStrategy govern auto upgrades when a new version of the plan or product is published.

plan_version

integer

product_id

string

product_version

integer

public_description

string

object

Settings overrides - NULL = inherit from the next layer (customer → org → default). See subscription_settings.go for the resolver.

start_at

string

StartAt is required when StartTrigger == start_date; null otherwise.

start_trigger

string · enum

StartTrigger says what activates a DRAFT subscription. See StartTrigger constants. Default for legacy rows is "immediate".

Enum values:

immediate

on_checkout_complete

manual

start_date

started_at

string

StartedAt is the zero time while in DRAFT; populated on first transition into ACTIVE. Use !StartedAt.IsZero() to test "started".

status

string · enum

Enum values:

DRAFT

ACTIVE

CANCELLED

EXPIRED

object[]

object

updated_at

string

version_change_strategy

string · enum

Enum values:

immediate_prorate

next_period

at_phase_change

version_track_mode

string · enum

Enum values:

pinned

latest

domain.SubscriptionAddOn

added_at

string

created_at

string

id

string

organization_id

string

product_id

string

quantity

integer

removed_at

string

subscription_id

string

updated_at

string

domain.SubscriptionItem

auto_renew

boolean

created_at

string

current_term_end

string

current_term_start

string

effective_from

string

EffectiveFrom / EffectiveTo: the temporal window this row is billable for (Pass B). EffectiveTo NULL = open-ended / currently billable. Quantity changes and item add/remove are append-only — the prior row gets EffectiveTo=T, a new row covers [T, NULL).

effective_to

string

id

string

organization_id

string

price_key

string

product_id

string

product_version_id

string

ProductVersionID pins the item to a specific product version. nil = follow products.head_version_id (default).

quantity

integer

renewal_anchor_at

string

subscription_id

string

term_count

integer

term_unit

string · enum

Term* fields make item-level commitment first-class. All optional; NULL means "follows the subscription's cadence" (the pre-R2 default). When set, the invoice pipeline amortizes the item's charges over the term instead of treating it as a normal per-period recurring line.

Enum values:

week

month

year

updated_at

string

domain.SubscriptionItemInput

auto_renew

boolean

AutoRenew is only meaningful when term_* is set. nil = inherit the BillingIntervalUnit default ("auto-renew at term_end"). false = one-shot purchase (domain registration, perpetual licence).

price_key

string

product_id

string

product_version_id

string

ProductVersionID pins the item to a specific product version. nil = follow product head version (default).

quantity

integer

term_count

integer

term_unit

string · enum

Optional per-item term. When set, the invoice pipeline bills the term upfront (R4) and the segmenter splits at term edges (R2's subscriptionItemTermBoundarySource). Leave nil for items that follow the subscription's invoice cadence — today's default.

term_unit + term_count are an XOR: both set or both nil. The constraint subscription_items_term_pair_check enforces the same at the DB layer.

Enum values:

week

month

year

domain.SubscriptionPhase

auto_transition

boolean

completed_at

string

created_at

string

dunning_stage

string

Dunning stage tracking (M115+). Populated only when phase_kind = 'dunning'; the WARNED → GRACED → SUSPENDED progression doesn't re-enter the lifecycle FSM, it just advances on the phase row.

dunning_stage_at

string

duration_unit

string · enum

Enum values:

day

week

month

billing_cycle

duration_value

integer

end_at

string

end_kind

string · enum

End policy (M103+). When the phase reaches this boundary the AutoTransition flag (above) decides whether the next pending phase starts automatically.

Enum values:

manual

duration

date

ends_at

string

derived; mirrors EndAt for end_kind=date or computed from duration

id

string

organization_id

string

phase_kind

string · enum

A phase is purely a billing-mode marker: which condition is the subscription operating under right now (trial / standard / paused / dunning / setup) + when does it end. Operator-facing chrome (name, translations, descriptions), per-phase setting overrides, arbitrary metadata, and the legacy duration_days / phase_type fields all lived here once and have been dropped — phases handle conditions and nothing else (M118 trim).

Enum values:

setup

trial

standard

paused

dunning

phase_order

integer

started_at

string

status

string · enum

Enum values:

PENDING

ACTIVE

COMPLETED

SKIPPED

subscription_id

string

domain.SubscriptionPlanCondition

plan_ids

string[]

domain.SubscriptionSettings

auto_finalize_invoices

boolean

default_proration_mode

string

line_grouping

string

price_resolution_policy

string

send_payment_reminders

boolean

tax_inclusive

boolean

domain.SubscriptionStatus

string · enum

Enum values:

DRAFT

ACTIVE

CANCELLED

EXPIRED

domain.SupplyType

string · enum

Enum values:

DOMESTIC

INTRA_EU_B2B

INTRA_EU_B2C

EXPORT

domain.Tag

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

domain.TaggableEntityType

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

domain.TaxCategoryCode

string · enum

Enum values:

domain.TaxRegime

string · enum

Enum values:

STANDARD

KLEINUNTERNEHMER

OSS

NON_EU

domain.TaxRule

applies_to_customer_types

string[]

Optional discriminators. Empty/nil means "applies to all" - wildcard semantics let EU VAT rules (which leave these unset) keep working while non-EU sales-tax rules can scope themselves to specific buyer types, product categories, or supply types.

Enum values:

BUSINESS

CONSUMER

UNKNOWN

applies_to_product_categories

string[]

Enum values:

DEFAULT

REDUCED

ZERO

EXEMPT

applies_to_supply_types

string[]

Enum values:

DOMESTIC

INTRA_EU_B2B

INTRA_EU_B2C

EXPORT

apply_order

integer

archived_at

string

created_at

string

id

string

inclusive

boolean

is_compound

boolean

jurisdiction_country

string

jurisdiction_region

string

object

organization_id

string

published_at

string

published_by

string

rate

number

requires_continuous_coverage

boolean

status

string · enum

Enum values:

draft

scheduled

active

archived

tax_type

string · enum

Enum values:

VAT

SALES_TAX

GST

CUSTOM

updated_at

string

valid_from

string

ValidFrom / ValidTo are plain dates (no clock, no zone). Tax law boundaries land on calendar days in the relevant jurisdiction; attaching a time-of-day to "this rate applies from 2024-06-15" silently shifts the day in non-UTC zones (Unified Date/Time plan, Layer 10). Postgres column type is DATE.

valid_to

string

version

integer

domain.TaxRuleStatus

string · enum

Enum values:

draft

scheduled

active

archived

domain.TaxType

string · enum

Enum values:

VAT

SALES_TAX

GST

CUSTOM

domain.TestClock

created_at

string

frozen_at

string

id

string

name

string

status

string · enum

Enum values:

active

advancing

completed

updated_at

string

workspace_id

string

domain.TestClockStatus

string · enum

Enum values:

active

advancing

completed

domain.TestPaymentSimulation

created_at

string

id

string

outcome

string · enum

Enum values:

success

decline

insufficient_funds

expired_card

fraud

processing_error

network_error

payment_method_id

string

workspace_id

string

domain.Threshold

object

comparator

string · enum

Enum values:

gte

lte

name

string

value

number

domain.ThresholdAction

event_type

string

for emit_event

kind

string · enum

Enum values:

webhook

slack

emit_event

target

string

URL or channel

domain.ThresholdActionKind

string · enum

Enum values:

webhook

slack

emit_event

domain.ThresholdComparator

string · enum

Enum values:

gte

lte

domain.TopupRequest

description

string

product_id

string

quantity

number

domain.Transaction

object

customer_id

string

direction

string · enum

Enum values:

out

internal

id

string

invoice_id

string

kind

string · enum

Enum values:

manual_payment

payment_attempt

wallet_transaction

wallet_hold

credit_note

occurred_at

string

raw_id

string

reference

string

source

string

status

string · enum

Enum values:

succeeded

pending

failed

refunded

voided

applied

draft

subscription_id

string

summary

string

wallet_id

string

domain.TransactionDirection

string · enum

Enum values:

out

internal

domain.TransactionKind

string · enum

Enum values:

manual_payment

payment_attempt

wallet_transaction

wallet_hold

credit_note

domain.TransactionStatus

string · enum

Enum values:

succeeded

pending

failed

refunded

voided

applied

draft

domain.TransferRequest

amount

number

reason

string

target_wallet_id

string

domain.TransitionPhaseRequest

force

boolean

domain.TranslationFields

description

string

name

string

public_description

string

domain.Translations

description

string

name

string

public_description

string

domain.UpdateCostRequest

object

description

string

effective_at

string

ADR-0006 edit-as-publish controls.

object

requires_continuous_coverage

boolean

Bucket-A: policy flag stored on the parent costs row. Edits propagate live; no cost_versions row is created. Pointer so we can distinguish "not provided" from "set to false".

save_as_draft

boolean

object

domain.UpdateCustomFieldDefinitionRequest

auditable

boolean

default_value

integer[]

object

description

string

display_name

string

object[]

expected_version

integer

field_group

string

show_in_table

boolean

sort_order

integer

status

string · enum

Enum values:

draft

scheduled

active

deprecated

archived

object

visibility

string · enum

Enum values:

PUBLIC

INTERNAL

write_access

string · enum

Enum values:

ALL

ADMIN_ONLY

SYSTEM_ONLY

domain.UpdateCustomerRequest

auto_validate_vat

boolean

AutoValidateVAT - see CreateCustomerRequest.AutoValidateVAT. Same semantics on update: nil = default behavior, false = skip the auto-trigger after update, true = request it (still gated by org and per-customer disable flags).

object

billing_model

string · enum

Enum values:

INVOICE

SETTLEMENT

object

customer_type

string · enum

Enum values:

BUSINESS

CONSUMER

UNKNOWN

default_auto_topup_amount

number

default_auto_topup_enabled

boolean

default_credit_limit

number

default_low_balance_threshold

number

default_max_balance

number

default_max_single_credit

number

disabled_providers

string[]

Enum values:

stripe

gocardless

einvoice_email

string

email

string

external_id

string

locale

string

object

name

string

payment_terms_days

integer

peppol_id

string

prefer_einvoice

boolean

preferred_currency

string

preferred_provider

string · enum

Enum values:

stripe

gocardless

status

string · enum

Enum values:

active

suspended

churned

object

vat_validation_disabled

boolean

vat_validation_disabled_reason

string

domain.UpdateFXOverrideRequest

reason

string

snapshot_date

string

valid_from

string

valid_to

string

domain.UpdateInvoiceLineRequest

description

string

object

period_end

string

period_start

string

quantity

number

tax_rate

number

unit_price

number

domain.UpdateInvoiceRequest

billing_period_end

string

billing_period_start

string

due_date

string

locale

string

object

domain.UpdateMeterRequest

object

dedup_key_path

string

dimensions

string[]

effective_at

string

ADR-0006 edit-as-publish controls.

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

name

string

negative_allowed

boolean

save_as_draft

boolean

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

value_field

string

object

domain.UpdateOrgTaxProfileRequest

object

legal_name

string

oss_country

string

tax_number

string

tax_regime

string · enum

Enum values:

STANDARD

KLEINUNTERNEHMER

OSS

NON_EU

vat_id

string

domain.UpdatePaymentMethodRequest

is_default

boolean

object

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

domain.UpdatePhaseRequest

auto_transition

boolean

duration_unit

string · enum

Enum values:

day

week

month

billing_cycle

duration_value

integer

end_at

string

end_kind

string · enum

Enum values:

manual

duration

date

domain.UpdatePlanRequest

object

description

string

effective_at

string

ADR-0006 edit-as-publish controls.

expected_version

integer

external_id

string

object

name

string

object

ProductVersionPins lets the operator override which product version each attached product is pinned to when this publish snapshots the plan. Map shape: product_id → product_version_id. Missing products (i.e. attached but not in the map) snap at the product's current head as before — so this field is purely additive: nil ≡ today's behaviour, non-nil applies the override per entry. Mirrors the products-page ChildVersionPins payload. The publish path validates every entry against the plan's attached products and the referenced product_versions row.

public_description

string

save_as_draft

boolean

status

string · enum

Enum values:

draft

scheduled

active

archived

object

domain.UpdatePriceFormulaRequest

expression

string

name

string

object[]

domain.UpdatePriceRequest

country_code

string

currency

string

object

display_name

string

M186 - customer-facing label

effective_at

string

ADR-0006 edit-as-publish controls. effective_at and save_as_draft are mutually exclusive (400 on both).

effective_from

string

EffectiveFrom, when set, lands as the new price version's effective_from (and the prior head's effective_to). The scheduler injects scheduled_at here on release so a future-dated change produces a future-effective version row. Unset = now().

ADR-0006: EffectiveAt is the unified API name across all versioned entities. For the price entity it aliases EffectiveFrom — handlers fold EffectiveAt into EffectiveFrom before calling repo.Update so the scheduler-internal hot path keeps a single source of truth.

expected_version

integer

list_price

number

object

save_as_draft

boolean

object[]

Tiers, when non-nil, replaces the tier set on the new price version. nil means "carry the previous version's tiers forward"; an empty slice means "this version has no tiers".

domain.UpdateProductMeterBindingRequest

effective_at

string

ADR-0006 edit-as-publish controls.

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

save_as_draft

boolean

domain.UpdateProductRequest

object

ChildVersionPins, when non-nil, requests a new product_versions row whose pin maps embed the supplied child-version selections. Phase 2.D stage-mode publish path: the operator reviews drift in stage mode, picks a version per child (or accepts head), and the FE ships the resulting map here. Treated as a Bucket-B trigger by the repo — any non-nil value bumps products.version and inserts a fresh product_versions row. Missing children fall back to their heads via insertProductVersionTxWithPins's merge.

object

description

string

effective_at

string

ADR-0006 edit-as-publish controls. effective_at and save_as_draft are mutually exclusive (400 on both). When both are nil/false, a versioned change publishes ACTIVE immediately; a bookkeeping-only change updates the header in-place.

expected_version

integer

external_id

string

invoiceable_standalone

boolean

InvoiceableStandalone is the Phase 2.5 curation flag. Pointer so nil means "leave unchanged"; a non-nil bool flips the flag.

object

name

string

pricing_model

string · enum

Enum values:

VOLUME

STAIRCASE

PACKAGE

public_description

string

requires_product_ids

string[]

save_as_draft

boolean

status

string · enum

Enum values:

draft

scheduled

active

archived

tax_category

string · enum

Enum values:

DEFAULT

REDUCED

ZERO

EXEMPT

object

domain.UpdatePromotionRequest

application_timing

string · enum

Enum values:

NEXT_CYCLE

RETROACTIVE

IMMEDIATE

archetype

string · enum

Enum values:

generic

coupon_discount

bundle_discount

volume_rebate

first_purchase_credit

free_trial

cross_sell_free

loyalty_ladder

budget_behavior

string · enum

Enum values:

SKIP

PARTIAL

code

string

condition_mode

string · enum

Enum values:

ALL

ANY

object

description

string

object

effective_at

string

ADR-0006 edit-as-publish controls.

expected_version

integer

is_phased

boolean

max_budget

number

max_redemptions

integer

max_redemptions_per_customer

integer

name

string

object[]

full replacement when non-nil; draft-only

priority

integer

public_description

string

save_as_draft

boolean

stackable

boolean

object

valid_from

string

valid_to

string

visibility

string · enum

Enum values:

INTERNAL

PUBLIC

COUPON

domain.UpdateRateTableRequest

default_value

string

description

string

effective_at

string

ADR-0006 edit-as-publish controls.

name

string

on_missing_key

string

requires_continuous_coverage

boolean

save_as_draft

boolean

domain.UpdateSubscriptionRequest

object

description

string

object

name

string

public_description

string

object

domain.UpdateTagRequest

archived

boolean

color

string

description

string

name

string

domain.UpdateTaxRuleRequest

applies_to_customer_types

string[]

nil means "no change". Empty slice means "clear filter / wildcard".

Enum values:

BUSINESS

CONSUMER

UNKNOWN

applies_to_product_categories

string[]

Enum values:

DEFAULT

REDUCED

ZERO

EXEMPT

applies_to_supply_types

string[]

Enum values:

DOMESTIC

INTRA_EU_B2B

INTRA_EU_B2C

EXPORT

apply_order

integer

effective_at

string

ADR-0006 edit-as-publish controls.

inclusive

boolean

is_compound

boolean

jurisdiction_country

string

jurisdiction_region

string

object

rate

number

requires_continuous_coverage

boolean

save_as_draft

boolean

status

string · enum

Enum values:

draft

scheduled

active

archived

tax_type

string · enum

Enum values:

VAT

SALES_TAX

GST

CUSTOM

valid_from

string

valid_to

string

domain.UpdateVerificationStatusRequest

status

string · enum

Enum values:

pending

verified

expired

failed

manual

maintenance

domain.UpdateWalletSettingsRequest

auto_topup_amount

number

auto_topup_enabled

boolean

auto_topup_payment_method_id

string

credit_limit

number

low_balance_threshold

number

max_balance

number

max_single_credit

number

domain.UpdateWorkspaceCurrencyRequest

billing_enabled

boolean

catalog_enabled

boolean

domain.UpdateWorkspaceRequest

name

string

status

string · enum

Enum values:

active

suspended

archived

domain.UpsertSettingsRequest

object

domain.UsageAggregateBucket

bucket

string

object

SumQuantity totals are decimal; we send them as strings so a 20,8 numeric round-trips without f64 loss.

object

domain.UsageAggregateBucketSize

string · enum

Enum values:

hour

day

week

domain.UsageAggregateMetric

string · enum

Enum values:

count

sum_quantity

domain.UsageAggregateResponse

bucket

string · enum

Enum values:

hour

day

week

group_by

string

metric

string · enum

Enum values:

count

sum_quantity

object[]

series

string[]

since

string

until

string

domain.UsageCreditsEffect

product_id

string

quantity

number

domain.UsageEvent

customer_id

string

object

external_cost_amount

number

external_cost_currency

string

id

string

idempotency_key

string

ingested_at

string

object

metric_key

string

organization_id

string

price_key

string

object

product_id

string

quantity

number

subscription_id

string

timestamp

string

wallet_currency

string

WalletCurrency, when non-nil, pins the event to a specific wallet at finalize time: the meter evaluator groups by this column and the resulting invoice routes to wallet (customer_id, *WalletCurrency). NULL falls back to the customer's preferred-currency cascade — identical to pre-040 behaviour, so legacy events keep working.

domain.UsageThresholdCondition

max_usage

number

min_usage

number

product_id

string

domain.ValidatePromotionRequest

coupon_code

string

customer_id

string

invoice_subtotal

string

subscription_id

string

domain.ValidationRules

max_length

integer

max_value

number

min_length

integer

min_value

number

regex_message

string

regex_pattern

string

required

boolean

unique_per_org

boolean

domain.VatValidationStatus

string · enum

Enum values:

UNVALIDATED

PENDING

VALID

INVALID

ERROR

MANUAL

MAINTENANCE

domain.VerificationCheckType

string · enum

Enum values:

VAT

IDENTITY

KYC

SANCTIONS

domain.VerificationStatus

string · enum

Enum values:

pending

verified

expired

failed

manual

maintenance

domain.VersionChangeStrategy

string · enum

Enum values:

immediate_prorate

next_period

at_phase_change

domain.VersionTrackMode

string · enum

Enum values:

pinned

latest

domain.Visibility

string · enum

Enum values:

PUBLIC

INTERNAL

domain.Wallet

object

auto_topup_enabled

boolean

object

created_at

string

object

currency

string

customer_id

string

object

id

string

is_primary

boolean

object

mode

string · enum

Enum values:

PREPAID

POSTPAID

organization_id

string

object

promotional_balance_expires_at

string

updated_at

string

domain.WalletCreditEffect

amount

number

currency

string

domain.WalletHold

object

captured_at

string

created_at

string

currency

string

expires_at

string

id

string

metric_key

string

organization_id

string

reason

string

reference_id

string

reference_type

string

resolved_at

string

reverse_charge

boolean

status

string · enum

Enum values:

PENDING

CAPTURED

VOIDED

EXPIRED

subscription_id

string

SubscriptionID and MetricKey identify the usage stream this hold reserves capacity for. Set by the reserve service so the usage event ingest path can detect overlap (Phase D dedup); nil for non-subscription holds like deposits.

tax_rate

number

tax_rule_id

string

voided_at

string

wallet_id

string

domain.WalletMode

string · enum

Enum values:

PREPAID

POSTPAID

domain.WalletTransaction

object

created_at

string

created_by

string

id

string

organization_id

string

reason

string

reference

string

reverse_charge

boolean

source

string · enum

Enum values:

PAYMENT

REFUND

PROMOTION

INVOICE

CHARGE

FEE

MANUAL

TRANSFER

object

tax_rate

number

tax_rule_id

string

type

string · enum

Enum values:

CREDIT

DEBIT

ADJUSTMENT

wallet_id

string

domain.WalletTransactionSource

string · enum

Enum values:

PAYMENT

REFUND

PROMOTION

INVOICE

CHARGE

FEE

MANUAL

TRANSFER

domain.WalletTransactionType

string · enum

Enum values:

CREDIT

DEBIT

ADJUSTMENT

domain.Window

duration

integer · enum · int64

SLIDING / TUMBLING

Enum values:

-9223372036854776000

9223372036854776000

1000

1000000

1000000000

60000000000

3600000000000

kind

string · enum

Enum values:

CALENDAR_HOURLY

CALENDAR_DAILY

CALENDAR_PERIOD

SLIDING

TUMBLING

SESSION

session_gap

integer · enum · int64

SESSION

Enum values:

-9223372036854776000

9223372036854776000

1000

1000000

1000000000

60000000000

3600000000000

domain.WindowKind

string · enum

Enum values:

CALENDAR_HOURLY

CALENDAR_DAILY

CALENDAR_PERIOD

SLIDING

TUMBLING

SESSION

domain.Workspace

active_test_clock_id

string

created_at

string

id

string

mode

string · enum

Enum values:

live

sandbox

name

string

organization_id

string

slug

string

status

string · enum

Enum values:

active

suspended

archived

updated_at

string

domain.WorkspaceCurrency

billing_enabled

boolean

catalog_enabled

boolean

created_at

string

currency_code

string

object

updated_at

string

workspace_id

string

domain.WorkspaceMode

string · enum

Enum values:

live

sandbox

domain.WorkspaceStatus

string · enum

Enum values:

active

suspended

archived

domain.WriteAccess

string · enum

Enum values:

ALL

ADMIN_ONLY

SYSTEM_ONLY

internal.dunning.CreateDunningPolicyRequest

name

string

object[]

internal.dunning.DunningAction

string · enum

Enum values:

send_email

grace

suspend

cancel

internal.dunning.DunningPolicy

created_at

string

deleted_at

string

id

string

is_active

boolean

name

string

organization_id

string

plan_id

string

object[]

updated_at

string

internal.dunning.DunningStep

action

string · enum

Enum values:

send_email

grace

suspend

cancel

days_after_due

integer

email_event

string

event name for send_email action

einvoicing.Finding

message

string

rule_id

string

severity

string · enum

Enum values:

INFO

WARNING

ERROR

xpath

string

einvoicing.Severity

string · enum

Enum values:

INFO

WARNING

ERROR

keycloak.OrganizationDomain

name

string

verified

boolean

internal.invoice_template.Branding

company_name

string

logo_height

number

logo_url

string

logo_width

number

internal.invoice_template.CreateInvoiceTemplateRequest

description

string

document_types

string[]

name

string

object

internal.invoice_template.Footer

show_page_numbers

boolean

text

string

internal.invoice_template.InvoiceTemplate

created_at

string

deleted_at

string

description

string

document_types

string[]

id

string

is_default

boolean

is_system

boolean

name

string

organization_id

string

status

string

object

updated_at

string

version

integer

internal.invoice_template.TemplateBlock

id

string

properties

object

show_on

string

type

string

visible

boolean

internal.invoice_template.TemplateDocument

object[]

object

object[]

schema_version

integer

object

internal.invoice_template.Theme

accent_color

string

hex

background_color

string

currency_code

string

font_family

string

font_size

number

line_height

number

locale

string

margin_bottom

number

margin_left

number

margin_right

number

margin_top

number

monochrome_on_print

boolean

page_orientation

string

page_size

string

primary_color

string

hex

secondary_color

string

hex

text_color

string

hex

internal.invoice_template.UpdateInvoiceTemplateRequest

description

string

document_types

string[]

expected_version

integer

name

string

status

string

object

internal.meter.BreachDailyCount

bucket

string

count

integer

internal.milestone.BillingMilestone

created_at

string

description

string

id

string

invoice_id

string

object

name

string

organization_id

string

percentage

number

product_id

string

status

string · enum

Enum values:

PENDING

TRIGGERED

INVOICED

subscription_id

string

trigger_date

string

trigger_type

string · enum

Enum values:

MANUAL

DATE

EVENT

triggered_at

string

updated_at

string

internal.milestone.BillingMilestoneStatus

string · enum

Enum values:

PENDING

TRIGGERED

INVOICED

internal.milestone.BillingMilestoneTriggerType

string · enum

Enum values:

MANUAL

DATE

EVENT

internal.milestone.CreateBillingMilestoneRequest

description

string

object

name

string

percentage

number

product_id

string

subscription_id

string

trigger_date

string

trigger_type

string · enum

Enum values:

MANUAL

DATE

EVENT

internal.milestone.CreateBillingMilestoneResponse

object

internal.organization.CreateOrganizationRequest

billing_email

string

default_currency

string

default_locale

string

name

string

slug

string

internal.organization.Invitation

created_at

string

email

string

id

string

invited_by

string

organization_id

string

role_names

string[]

workspace_id

string

internal.organization.UpdateOrganizationRequest

billing_email

string

business_address

string

default_country

string

DefaultCountry: ISO 3166-1 alpha-2 (two uppercase letters) or empty string to clear. Mirrors the public-checkout cascade described on Organization.DefaultCountry.

default_currency

string

default_date_format

string

default_first_day_of_week

string

default_language

string

Locale & formatting cascade defaults — feed the per-field cascade users see in the dashboard. Each nullable; empty payload leaves the stored value untouched (COALESCE in UPDATE below).

default_locale

string

default_number_format

string

default_timezone

string

legal_name

string

name

string

phone

string

support_email

string

tax_inclusive

boolean

TaxInclusive: tenant default for the public checkout page's tax-display toggle. Same nullable-pointer convention as the rest of this struct; pass NULL on the wire (i.e. omit the field) to leave the stored value unchanged.

tax_registration_number

string

internal.organization_security.IDPSummary

alias

string

object

display_name

string

enabled

boolean

hide_on_login

boolean

provider_id

string

internal.organization_security.OrgSecuritySettings

allowed_email_domains

string[]

allowed_idps

string[]

created_at

string

jit_default_role

string

jit_enabled

boolean

organization_id

string

require_mfa

boolean

session_timeout_seconds

integer

updated_at

string

internal.organization_security.UpdateOrgSecuritySettingsRequest

allowed_email_domains

string[]

allowed_idps

string[]

jit_default_role

string

jit_enabled

boolean

require_mfa

boolean

session_timeout_seconds

integer

internal.organization_team.Member

email

string

name

string

roles

string[]

status

string

organization_members.status: "active", "invited", ...

user_id

string

internal.organization_team.Role

assigned_count

integer

description

string

id

string

is_default_for_new_joiners

boolean

is_system

boolean

name

string

permissions

string[]

internal.payment.CreatePaymentGatewayConfigRequest

config

object

{ "api_key": "sk_...", "webhook_secret": "whsec_..." }

display_name

string

mode

string

provider

string

supported_currencies

string[]

supported_methods

string[]

internal.payment.PaymentGatewayConfig

config

object

encrypted provider config

created_at

string

display_name

string

id

string

is_default

boolean

is_enabled

boolean

object

mode

string

test, live

organization_id

string

provider

string

stripe, gocardless, mollie, adyen

supported_currencies

string[]

supported_methods

string[]

updated_at

string

internal.payment.UpdatePaymentGatewayConfigRequest

config

object

display_name

string

is_default

boolean

is_enabled

boolean

mode

string

supported_currencies

string[]

supported_methods

string[]

internal.payment_manual.ManualPaymentSource

string · enum

Enum values:

BANK_TRANSFER

CASH

CHECK

WIRE

WRITE_OFF

EXTERNAL_PROCESSOR

internal.payment_manual.RecordManualPaymentRequest

amount

number

note

string

received_at

string

reference

string

source

string · enum

Enum values:

BANK_TRANSFER

CASH

CHECK

WIRE

WRITE_OFF

EXTERNAL_PROCESSOR

internal.payment_settlement.GenerateSettlementLine

amount

number

description

string

line_type

string · enum

Enum values:

EARNING

TRANSACTION_FEE

SUBSCRIPTION_FEE

ADVERTISING_FEE

OTHER_FEE

object

reference_id

string

internal.payment_settlement.GenerateSettlementRequest

currency

string

customer_id

string

object[]

object

period_end

string

period_start

string

internal.payment_settlement.Settlement

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

internal.payment_settlement.SettlementLine

amount

number

created_at

string

description

string

id

string

line_type

string · enum

Enum values:

EARNING

TRANSACTION_FEE

SUBSCRIPTION_FEE

ADVERTISING_FEE

OTHER_FEE

object

organization_id

string

reference_id

string

reverse_charge

boolean

settlement_id

string

tax_amount

number

tax_category_code

string · enum

Enum values:

tax_rate

number

tax_rule_id

string

internal.payment_settlement.SettlementLineType

string · enum

Enum values:

EARNING

TRANSACTION_FEE

SUBSCRIPTION_FEE

ADVERTISING_FEE

OTHER_FEE

internal.payment_settlement.SettlementStatus

string · enum

Enum values:

draft

finalized

paid

internal.preferences.DateFormat

string · enum

Enum values:

iso

internal.preferences.FirstDayOfWeek

string · enum

Enum values:

monday

sunday

saturday

internal.preferences.NumberFormat

string · enum

Enum values:

1,234.56

1.234,56

1 234,56

internal.preferences.UpdateUserPreferencesRequest

currency

string

date_format

string · enum

Enum values:

iso

first_day_of_week

string · enum

Enum values:

monday

sunday

saturday

language

string

locale

string

object

number_format

string · enum

Enum values:

1,234.56

1.234,56

1 234,56

theme

string · enum

Enum values:

light

dark

system

timezone

string

internal.preferences.UserPreferences

created_at

string

currency

string

Currency: per-user override of the org's default_currency. ISO 4217 code, e.g. "EUR". Drives defaulting when a document doesn't specify its own currency.

date_format

string · enum

Enum values:

iso

first_day_of_week

string · enum

Enum values:

monday

sunday

saturday

language

string

Language: UI translation key (e.g. "de", "en"). Distinct from Locale, which drives number/date format grammar — a user may legitimately want German UI with Swiss number formatting.

locale

string

object

number_format

string · enum

Enum values:

1,234.56

1.234,56

1 234,56

theme

string · enum

Enum values:

light

dark

system

timezone

string

updated_at

string

user_id

string

internal.preferences.UserTheme

string · enum

Enum values:

light

dark

system

internal.reserve.ReserveRequest

customer_id

string

object

external_cost_amount

number

ExternalCostAmount + ExternalCostCurrency feed the resolver's cost.* formula-variable namespace. Required when the resolved price's tier expression references cost. and the caller owns the actual cost value (telco wholesale pass-through, per-call carrier fees, etc.). Both fields go together or neither — the validator enforces the pair.

external_cost_currency

string

hold_expires_at

string

HoldExpiresAt is the TTL of the hold the reserve creates. If the caller doesn't capture the hold by this instant the wallet auto-releases it. Renamed from expires_at in the shape cleanup — the old name was ambiguous about what expires.

idempotency_key

string

object

metric_key

string

price_key

string

object

product_id

string

quantity

number

subscription_id

string

wallet_currency

string

WalletCurrency optionally pins the hold to the customer's wallet in this currency. The one-wallet-per-(customer, currency) invariant (idx_wallets_customer_currency) makes the lookup unambiguous. When unset the reserve falls back to the customer's primary wallet (the row with is_primary=true). Either lookup fails with a clear DomainError when the wallet doesn't exist — no auto-routing across currencies.

internal.reserve.ReserveResponse

blocked_reasons

string[]

can_proceed

boolean

expires_at

string

fx_rate_id

string

hold_id

string

object

resolved_currency

string

object

tax_rate

number

tax_rule_id

string

wallet_id

string

Phase F: cross-flow reconciliation handles. Callers persist these alongside their internal record so preview/reserve/invoice numbers can be tied back to the same tax rule and FX rate snapshot.

internal.scheduler.CreateScheduledChangeRequest

change_payload

object

change_type

string

created_by

string

depends_on_change_id

string

entity_id

string

entity_type

string · enum

Enum values:

PRICE

PROMOTION

PLAN

TAX_RULE

SUBSCRIPTION

PRODUCT

COST

entity_version_at_schedule

integer

immediate

boolean

object

notification_config

object

release_strategy

string · enum

Enum values:

AUTOMATIC

MANUAL

CANARY

rollback_window

string

scheduled_at

string

internal.scheduler.ReleaseStrategy

string · enum

Enum values:

AUTOMATIC

MANUAL

CANARY

internal.scheduler.ScheduledChange

change_payload

object

change_type

string

created_at

string

created_by

string

depends_on_change_id

string

entity_id

string

entity_type

string · enum

Enum values:

PRICE

PROMOTION

PLAN

TAX_RULE

SUBSCRIPTION

PRODUCT

COST

entity_version_at_schedule

integer

id

string

object

notification_config

object

organization_id

string

previous_state

object

release_strategy

string · enum

Enum values:

AUTOMATIC

MANUAL

CANARY

released_at

string

rollback_window

string

rolled_back_at

string

scheduled_at

string

status

string · enum

Enum values:

pending

upcoming

releasing

released

rolled_back

cancelled

updated_at

string

internal.scheduler.ScheduledChangeDiff

after

before

changed_fields

string[]

entity_id

string

entity_type

string · enum

Enum values:

PRICE

PROMOTION

PLAN

TAX_RULE

SUBSCRIPTION

PRODUCT

COST

internal.scheduler.ScheduledChangeStatus

string · enum

Enum values:

pending

upcoming

releasing

released

rolled_back

cancelled

internal.scheduler.ScheduledEntityType

string · enum

Enum values:

PRICE

PROMOTION

PLAN

TAX_RULE

SUBSCRIPTION

PRODUCT

COST

internal.scheduler.UpdateScheduledChangeRequest

change_payload

object

notification_config

object

release_strategy

string · enum

Enum values:

AUTOMATIC

MANUAL

CANARY

rollback_window

string

scheduled_at

string

internal.segmentation.CreateSegmentRuleRequest

applied_tag_id

string

evaluation_schedule

string

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

value

number

internal.segmentation.Metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

internal.segmentation.Operator

string · enum

Enum values:

gte

lte

internal.segmentation.SegmentRule

applied_tag_id

string

created_at

string

deleted_at

string

evaluation_schedule

string

id

string

is_active

boolean

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

organization_id

string

updated_at

string

value

number

internal.subscription.DriftCandidateVersion

effective_from

string

effective_to

string

lifecycle

string

version

integer

internal.subscription.SubscriptionDrift

current_version

integer

latest_published_at

string

latest_scheduled_at

string

latest_version

integer

plan_id

string

product_id

string

sub_id

string

track_mode

string

object[]

versions_behind

integer

internal.webhook.CreateWebhookEndpointRequest

description

string

event_types

string[]

secret_id

string

url

string

internal.webhook.CreateWebhookSecretRequest

description

string

entity_id

string

entity_type

string

signing_method

string

internal.webhook.UpdateWebhookEndpointRequest

clear_secret

boolean

description

string

event_types

string[]

secret_id

string

status

string

url

string

money.Money

currency

string

value

string

pagination.PageResponse

object

cursor

string

has_more

boolean

total_count

integer

handler.AddRequiredActionRequest

action

string

handler.AttachIDPRequest

alias

string

object

display_name

string

enabled

boolean

hide_on_login

boolean

provider_id

string

handler.BindingVersionSnapshot

binding_id

string

created_at

string

effective_from

string

effective_to

string

id

string

organization_id

string

overlay_filters

pricing_var_name

string

version

integer

workspace_id

string

handler.BulkUpgradeRequest

force

boolean

scheduled_at

string

strategy

string

subscription_ids

string[]

target_plan_version

integer

target_product_version

integer

handler.BulkUpgradeResponse

object[]

handler.BulkUpgradeSkippedRow

reason

string

sub_id

string

handler.BulkUpgradeUpgradedRow

new_version

integer

sub_id

string

handler.CreateInvitationRequest

email

string

role_names

string[]

handler.CreateOrganizationResponse

api_key

string

object

object[]

handler.CreateRoleRequest

description

string

name

string

permissions

string[]

handler.KeycloakEvent

clientId

string

object

error

string

ipAddress

string

organizationId

string

realmId

string

sessionId

string

time

integer

type

string

userId

string

handler.MeOrgMembership

alias

string

id

string

name

string

roles

string[]

handler.MeResponse

active_org

string

active_workspace

string

object[]

realm_roles

string[]

object

object[]

handler.MeUser

email

string

id

string

locale

string

name

string

picture

string

timezone

string

handler.MeterVersionSnapshot

created_at

string

effective_from

string

effective_to

string

filter_tree

function

string

id

string

meter_id

string

organization_id

string

value_field

string

version

integer

window

workspace_id

string

handler.OrganizationResponse

billing_email

string

business_address

string

created_at

string

default_currency

string

default_date_format

string

default_first_day_of_week

string

default_language

string

default_locale

string

default_number_format

string

default_timezone

string

id

string

legal_name

string

name

string

phone

string

slug

string

status

string

support_email

string

tax_registration_number

string

handler.ProductVersionSnapshot

object

description

string

effective_from

string

effective_to

string

external_id

string

id

string

metadata

integer[]

object

name

string

object

product_id

string

product_status

string

product_type

string

published_at

string

published_by

string

release_strategy

string

status

string

version

integer

handler.PromotionVersionSnapshot

application_timing

string

budget_behavior

string

code

string

description

string

effective_from

string

effective_to

string

id

string

max_budget

number

max_redemptions

integer

name

string

priority

integer

promotion_id

string

promotion_status

string

published_at

string

published_by

string

release_strategy

string

stackable

boolean

status

string

valid_from

string

valid_to

string

version

integer

visibility

string

handler.SCIMEmail

primary

boolean

type

string

value

string

handler.SCIMListResponse

object[]

itemsPerPage

integer

schemas

string[]

startIndex

integer

totalResults

integer

handler.SCIMMeta

created

string

lastModified

string

location

string

resourceType

string

handler.SCIMName

familyName

string

formatted

string

givenName

string

handler.SCIMUser

active

boolean

displayName

string

object[]

id

string

object

schemas

string[]

userName

string

handler.SubscriptionPlanVersionHistoryRow

change_reason

string

created_at

string

effective_from

string

effective_to

string

id

string

plan_id

string

plan_version

integer

product_id

string

product_version

integer

subscription_id

string

handler.UpdateIDPRequest

object

display_name

string

enabled

boolean

hide_on_login

boolean

provider_id

string

handler.UpdateMemberRolesRequest

assign

string[]

unassign

string[]

handler.UpdateRoleRequest

description

string

name

string

permissions

string[]

handler.UpsertDomainsRequest

domains

string[]

handler.UserProfileResponse

email

string

id

string

name

string

picture

string

role

string

Role is the comma-joined list of org-scoped role names the user holds in the caller's active org (bc.OrganizationID). Empty when the target user has no active membership there.

status

string

handler.VersionRow

archived_reason

string

created_at

string

created_by

string

effective_from

string

effective_to

string

id

string

ID is the *_versions.id UUID. Phase 2.D needs it so the FE stage-mode chip can wire selection→pin map without a separate number→ID lookup; older clients can ignore the field.

published_at

string

status

string

usage_count

integer

version

integer

object[]

handler.billingMilestoneListResponse

object[]

object

handler.bulkArchiveRequest

deprecated_before

string

entity_ids

string[]

entity_type

string

handler.bulkArchiveResponse

archived_count

integer

blocked_count

integer

object[]

handler.bulkArchiveResult

entity_id

string

error

string

status

string

handler.bulkCancelRequest

ids

string[]

handler.bulkCancelResponse

cancelled

string[]

object[]

handler.bulkCancelSkip

id

string

reason

string

handler.changeQuantityResponse

object[]

object

handler.chargeInvoiceResponse

attempt_id

string

attempt_number

integer

checkout_url

string

CheckoutURL is the provider's hosted-checkout URL the frontend must redirect the customer to in order to complete the payment. Empty for providers that don't support a hosted flow (callers should branch on this and surface a different "add payment method first" UX instead).

invoice_id

string

provider

string

scheduled_for

string

handler.clonePlanRequest

name

string

handler.createAPIKeyRequest

allowed_ips

string[]

nil/empty = unrestricted

expires_at

string

nil = non-expiring

key_type

string

sk_live | sk_test; defaults to mode

name

string

scopes

string[]

nil/empty = all-access

handler.createAPIKeyResponse

allowed_ips

string[]

created_at

string

expires_at

string

id

string

key

string

key_prefix

string

key_type

string

name

string

scopes

string[]

handler.createCustomerResponse

object

handler.documentCountsResponse

object

handler.documentResponse

byte_size

integer

content_hash

string

content_type

string

created_at

string

credit_note_id

string

id

string

invoice_id

string

jurisdiction

string

profile

string

quarantine_reason

string

signed

boolean

syntax

string

handler.documentsListResponse

object[]

next_cursor

string

handler.findingResponse

found_at

string

id

string

message

string

resolution_notes

string

resolved_at

string

rule_id

string

rule_set

string

severity

string

xpath

string

handler.gatewayCreateResponse

object

handler.gatewayListResponse

object[]

handler.gatewayUpdateAck

id

string

updated

boolean

handler.gatewayUpdateResponse

object

handler.generateRequest

credit_note_id

string

invoice_id

string

jurisdiction

string

profile

string

handler.generateResponse

byte_size

integer

content_hash

string

created_at

string

document_id

string

object[]

profile

string

quarantined

boolean

storage_bucket

string

storage_key

string

syntax

string

handler.generateTokensRequest

count

integer

emails

string[]

handler.issueLinkResponse

expires_at

string

token

string

url

string

handler.meCredentialsResponse

types

string[]

handler.mePermissionsResponse

is_system_admin

boolean

permissions

string[]

handler.permissionDTO

description

string

group

string

label

string

permission

string

system

boolean

handler.permissionsResponse

assignable_permissions

string[]

object[]

handler.planDetailResponse

object

object[]

handler.redeemWithTokenRequest

customer_id

string

subscription_id

string

token

string

handler.rescheduleRequest

scheduled_at

string

handler.resolveFindingRequest

notes

string

handler.tagIDsRequest

tag_ids

string[]

handler.testClockListResponse

count

integer

object[]

handler.testPaymentSimulationListResponse

count

integer

object[]

handler.topupResponse

object

handler.updateProviderSettingsRequest

disabled_providers

string[]

Enum values:

stripe

gocardless

preferred_provider

string · enum

Enum values:

stripe

gocardless

handler.upsertPolicyRequest

event_type

string

retention_days

integer

handler.vatRateListResponse

count

integer

object[]

handler.versionWarnDTO

field

string

type

string

handler.walletTopupMode

string · enum

Enum values:

hosted_checkout

off_session

handler.walletTopupRequest

object

mode

string · enum

Enum values:

hosted_checkout

off_session

payment_method_id

string

handler.walletTopupResponse

client_secret

string

decline_code

string

failure_code

string

failure_message

string

mode

string · enum

Enum values:

hosted_checkout

off_session

next_action

integer[]

payment_intent_id

string

Off-session fields - populated when Mode == off_session.

session_id

string

Hosted Checkout fields - populated when Mode == hosted_checkout.

state

string

url

string

handler.workspaceListResponse

count

integer

object[]

time.Duration

integer · enum · int64

Enum values:

-9223372036854776000

9223372036854776000

1000

1000000

1000000000

60000000000

3600000000000