Skip to content
Revenue operations

invoice_payment_completed event schema

A payment outcome event that keeps provider identifiers pseudonymous and separates billed amount from recurring-revenue definitions.

Reviewed by the Telemetry product team on . We checked what each event represents, which service sends it, field types, sensitive data, the example, and validation steps. Who reviews this page

Question this event answers

Which billed amounts succeed, fail, or recover?

Fields
9
Required
8
Send and check an event

Record and query invoice_payment_completed

Document what each invoice_payment_completed row represents and which service sends it. Send test events to check the fields, then verify that the query answers your question.

  1. 1

    Outcome becomes final

    Billing webhook handler after idempotent processing emits only after the provider event is verified and persisted.

  2. 2

    Choose the fields

    8 required fields preserve the declared grain: One terminal payment attempt.

  3. 3

    Check the test event

    Check types, UTC time, alternate outcomes, idempotency, and every pseudonymous or review-classified field.

  4. 4

    Query the result

    Which billed amounts succeed, fail, or recover?

Grain

One terminal payment attempt.

Owner

Billing webhook handler after idempotent processing

Emit when

After the provider event is verified and persisted.

Field contract

Field types and data to exclude

Keep field names and types stable once production queries depend on them. Document optional fields and add them only when they answer a specific question.

FieldTypeRequiredPrivacyMeaning
timestamp_utctimestampyesnon-sensitiveUTC time when the operation finishes.
event_idstringyesnon-sensitiveStable unique identifier used for deduplication.
releasestringyesnon-sensitiveApplication or service version that emitted the event.
account_idstringyespseudonymousStable internal account identifier, never an email or name.
invoice_idstringyespseudonymousInternal or hashed provider invoice identifier.
amount_usdnumberyesnon-sensitiveNormalized amount with currency rules documented.
attempt_countnumberyesnon-sensitivePayment attempt sequence number.
statusstringyesnon-sensitivePaid, failed, or recovered outcome.
failure_categorystringnoreviewCoarse provider-safe category, never card or bank details.

Synthetic JSON event

{
  "timestamp_utc": "2026-07-28T14:24:51Z",
  "event_id": "evt_payment_01",
  "account_id": "acct_8f31",
  "release": "2026.07.2",
  "invoice_id": "invoice_67ad",
  "amount_usd": 2400,
  "attempt_count": 1,
  "status": "paid"
}

Privacy review

Review identifiers before ingestion

This example uses synthetic identifiers. Pseudonymous values can still be personal data, and review fields can expose business or provider context. Apply your own consent, retention, access, residency, and deletion requirements.

  • account_id: pseudonymous
  • invoice_id: pseudonymous
  • failure_category: review

Validation checklist

Test the schema before building a dashboard

  • Send one known invoice_payment_completed fixture after the documented outcome boundary.
  • Verify all 8 required fields arrive with the documented types.
  • Retry the same event identifier and confirm the chosen deduplication behavior.
  • Send a controlled failure or alternate outcome when the workflow supports one.
  • Run the related SQL over a fixed window and reconcile the result to the fixture.

Common mistakes

Record one result per row

  • Emitting invoice_payment_completed before billing webhook handler after idempotent processing knows the final outcome.
  • Mixing different kinds of results in one table, which makes counts and rates ambiguous.
  • Replacing controlled categories with raw URLs, payloads, prompts, or error text.
  • Changing a field type in place after saved queries and dashboards depend on it.
  • Adding identifiers without a documented investigation, access, and retention need.

Use the contract

Query the event and set up monitoring

Related contracts

Send a test event before production traffic

Create a free API key, send the synthetic event, and inspect the inferred table before connecting a live workflow.

Test this schema