Kontorion Billing API
The Kontorion Billing API provides a complete platform for subscription and usage-based billing. Manage customers, products, plans, and prices. Create and lifecycle subscriptions with add-ons, groups, and scheduled changes. Generate invoices automatically or manually. Track usage events and meter against committed use plans. Process payments through Stripe and GoCardless. Automate billing with recurring schedules, dunning policies, and promotion campaigns.
Base URL: https://api.kontorion.eu/v1
Authentication: All requests require an Authorization: Bearer ... header. See Authentication for details.
Tags
Customers
A customer represents a person or company that purchases your products and services. Customers are the foundation of your billing relationship - every subscription, invoice, and payment is tied to a customer record.
Each customer has a billing profile including address, preferred currency, tax identifiers, and custom fields. Customers can be tagged for segmentation, merged when duplicates are discovered, and validated through identity verification providers.
Key concepts:
- External ID - your internal identifier for this customer, used for idempotent upserts
- Billing model - controls how charges are calculated (prepaid, postpaid, or hybrid)
- Customer type -
individualorcompany, affects tax treatment and invoice formatting - Metadata - arbitrary key-value pairs for your own bookkeeping
Subscriptions
A subscription is a contract between your business and a customer - it defines which plan they're on, what billing period applies, and how charges are generated over time.
Subscriptions progress through a defined lifecycle:
pending → trialing → active → past_due → canceled or expired. Each transition can trigger invoicing, proration, or dunning actions.
Key concepts:
- Plan - the pricing template attached to this subscription
- Billing period -
month,quarter, oryear- determines invoice frequency - Trial - an optional free period before charges begin
- Auto-renew - whether the subscription renews automatically at period end
- Billing anchor day - the day of month that billing cycles align to (e.g., the 1st or 15th)
- Proration - when a subscription changes mid-cycle, charges are adjusted proportionally
- Items - the specific products and quantities included in this subscription
Invoices
An invoice is a formal request for payment sent to a customer. Invoices are generated automatically at the end of each billing period, or manually for one-off charges, credits, and adjustments.
The invoice lifecycle is:
draft → finalized → sent → paid (or void / uncollectible). Draft invoices can be edited; finalized invoices are immutable and receive a sequential invoice number.
Key concepts:
- Invoice type -
subscription(recurring),one_off(manual), orcredit_note(refund/adjustment) - Line items - individual charges with product, quantity, amount, and tax breakdown
- Credit notes - partial or full reversals of a finalized invoice
- PDF export - generate a formatted PDF for download or email delivery
- XRechnung - EU-compliant electronic invoice format (XML) for B2G billing
- Buyer reference - PO number or reference that appears on the invoice for the customer's records
Plans
A plan is a reusable pricing template that defines what a customer gets and how they're charged. Plans combine one or more products with pricing rules and are attached to subscriptions.
Plans support versioning - when you update a plan's pricing or product lineup, existing subscribers stay on their current version until explicitly migrated. This lets you iterate on pricing without disrupting active subscriptions.
Key concepts:
- Products - the items included in this plan, each with optional included quantities and rollover rules
- Versions - immutable snapshots of the plan configuration at a point in time
- Publishing - makes a draft plan version available for new subscriptions
- Migration - moves existing subscribers from one plan version to another, with configurable proration
Wallets
A wallet is a prepaid credit balance associated with a customer. Wallets allow customers to pre-fund their account, receive credits (promotional or otherwise), and have charges automatically deducted from their balance before falling back to a payment method.
Each customer has a primary wallet created automatically, and can have additional wallets in different currencies.
Key operations:
- Credit - add funds to the wallet (from a payment, promotion, or manual adjustment)
- Debit - remove funds (applied automatically during invoicing, or manually)
- Hold - reserve an amount for a pending charge (released or captured later)
- Transfer - move funds between wallets (e.g., currency conversion)
- Adjust - correct the balance without a formal credit/debit (e.g., migration adjustment)
Credit Notes
Credit notes: drafts, issuing, application against invoices, cash refunds, and PDF/XRechnung artifacts.
Reservations
A reservation places a hold on a customer's wallet, reserving funds for a unit of work that is later captured (settled) or released. This is the reserve → capture → release lifecycle - the authorize/capture pattern applied to wallet balance. Reservations are the primary money-gating surface for prepaid usage.
Products
A product represents a billable item in your catalog - a feature, service, or resource that customers pay for. Products are the building blocks of plans and appear as line items on invoices.
Products can be recurring (charged every billing period), usage-based (metered and charged based on consumption), or one-time (charged once at purchase).
Key concepts:
- Product type -
recurring,usage,one_time, orseat- determines how charges are calculated - External ID - your internal SKU or product code for integration with other systems
- Cost tracking - named COGS entries via
costs[](per-product or org-scoped) for margin analysis - Dependencies -
requires_product_idsenforces that certain products must be purchased together
Prices
A price defines the monetary amount charged for a product within a plan. Prices support multiple currencies, billing periods, and pricing models - from simple flat fees to complex tiered and formula-based calculations.
Pricing models:
- Flat - a fixed amount per billing period (e.g., $49/month)
- Per-unit - a fixed amount multiplied by quantity (e.g., $10/seat)
- Tiered - different rates at different volume thresholds (e.g., $0.10/unit for 0–1,000, $0.08/unit for 1,001–10,000)
- Volume - the tier that contains the total quantity determines the rate for all units
- Graduated - each tier's rate applies only to units within that tier's range
- Formula - a mathematical expression evaluated at billing time (see Price Formulas)
- Effective date - prices can be scheduled to take effect in the future
- Country code - geo-specific pricing for different markets
- Currency - each price is denominated in a single currency; use multiple prices for multi-currency support
Price Formulas
Price formulas let you define dynamic pricing using mathematical expressions that are evaluated at billing time. This is useful for pricing models that depend on runtime variables - usage volume, contract size, exchange rates, or custom metrics.
Formulas support standard arithmetic operators, conditional logic, and named variables. Each variable has a type and optional default value. At billing time, the formula engine resolves all variables and computes the final price.
Example:
base_price * (1 - volume_discount) where volume_discount increases with usage.Rate Tables
Rate tables provide structured lookup pricing - a grid of rates indexed by one or more dimensions. Use rate tables for complex pricing that depends on multiple variables like geography, volume tier, customer segment, or contract term.
Example: A shipping rate table with dimensions for weight range, origin country, and destination country.
Promotions
Promotions allow you to offer discounts, credits, and special pricing to customers through coupon codes, automatic rules, or manual application.
Key concepts:
- Code - the coupon code a customer enters (e.g.,
SAVE20) - Effects - what the promotion does: percentage discount, fixed discount, free trial extension, or credit grant
- Conditions - eligibility rules: minimum spend, specific plans, customer segments, date ranges
- Budget - optional spending cap; the promotion deactivates when the budget is exhausted
- Stackable - whether this promotion can combine with other active promotions
- Simulation - preview the financial impact of a promotion before activating it
Costs
Product and org-scoped cost definitions consumed by pricing formulas.
Key Sets
Key sets: the org-global registries of pricing keys that rate tables and prices resolve against.
Pricing/Resolutions
Transaction-time price resolution for subscription items: the period × currency matrix, reachable keyed prices, tier/formula/FX derivation, and upcoming price changes. Distinct from the change-preview/simulate family.
Usage Query
Query aggregated usage data for a customer's subscription within a time range. Returns the computed metric value (after aggregation) and the underlying event count.
Use this to build usage dashboards, generate real-time consumption alerts, or preview what a customer's next invoice will look like before it's generated.
Meters
Usage meters: definitions, threshold breaches, and consuming products.
Product Meter Bindings
Bindings that attach meters to products and map them to pricing variables.
Payment Gateways
A payment gateway configuration connects Kontorion to an external payment processor (Stripe, GoCardless, or other providers) for collecting payments from customers.
Each organization can have multiple gateway configurations - for example, Stripe for card payments and GoCardless for SEPA direct debits. One gateway is marked as the default.
Key concepts:
- Provider - the payment processor (
stripe,gocardless, etc.) - Mode -
liveortest- determines whether real charges are made - Supported currencies - which currencies this gateway can process
- Supported methods - which payment methods this gateway handles (card, direct_debit, etc.)
Payment Methods
A payment method is a stored instrument (credit card, bank account, direct debit mandate) that a customer uses to pay invoices. Payment methods are tokenized through the configured payment gateway - Kontorion never stores raw card numbers or bank details.
Each customer can have multiple payment methods. One is marked as
is_default and is used automatically when invoices are finalized.Tax Rules
Tax rules define the tax rates applied to charges based on jurisdiction, product category, and customer location. Kontorion evaluates tax rules at invoicing time and adds the appropriate tax line items to each invoice.
Key concepts:
- Jurisdiction - country and optional region the rule applies to
- Tax type -
vat,sales_tax,gst,hst, etc. - Inclusive vs. exclusive - whether the tax is included in the listed price or added on top
- Compound tax - whether this tax is calculated on the pre-tax amount or on the amount including other taxes
- Apply order - controls the sequence when multiple tax rules apply
Tax Compliance
Manage your organization's tax profile and access EU VAT rates. The tax profile stores your legal entity details (VAT ID, tax regime, legal address) used on invoices and for reverse-charge determination.
EU VAT rates are maintained automatically and include standard, reduced, super-reduced, and parking rates for all EU member states.
E-Invoicing
E-invoice artifacts (EN 16931 / XRechnung / Peppol): generation, validation findings, and document downloads.
Subscription Add-Ons
Add-ons are additional products attached to an existing subscription outside of the base plan. Use add-ons for optional features, premium support tiers, or one-time charges that apply to a specific subscription.
Add-ons are billed alongside the subscription's regular charges and appear as separate line items on the invoice.
Scheduled Changes
Scheduled changes allow you to queue modifications to subscriptions, plans, or other entities that take effect at a future date. Common uses include price increases, plan migrations, and feature launches.
Key concepts:
- Release strategy -
immediate(execute now),scheduled(at a specific datetime), ornext_period(at the start of the next billing cycle) - Dependencies - chain changes so one executes only after another completes
- Rollback window - how long after execution the change can be reversed
- Notification - optionally notify the customer before a change takes effect
Dunning
Dunning is the automated process of recovering failed payments. When an invoice payment fails, the dunning policy defines a sequence of escalating actions - retry the payment, send reminder emails, and eventually cancel the subscription if payment isn't recovered.
How it works:
- An invoice payment fails
- The dunning policy's first step activates (e.g., retry after 3 days)
- If the retry fails, the next step activates (e.g., send a reminder email after 7 days)
- Steps escalate until payment succeeds or the final action triggers (e.g., cancel subscription after 30 days)
Webhook Secrets
Webhook secrets are the HMAC signing keys used to authenticate inbound webhook payloads. Each secret is scoped to an entity (e.g., a specific integration endpoint) and can be rotated without downtime by creating a new secret before deactivating the old one.
Organization Settings
Organization-level configuration that applies to all resources within your account. Includes default currency, timezone, invoice numbering format, payment terms, and feature flags.
Custom Fields
Custom field definitions extend the data model of core entities (customers, subscriptions, plans, products) with your own fields. Define the field type, validation rules, and visibility, then set values on individual records.
Supported field types:
text, number, boolean, date, enum, entity_ref
Key concepts:
- Entity types - which resources this field applies to (e.g.,
customer,subscription) - Field group - logical grouping for UI display
- Validation - regex patterns, min/max values, required/optional
- Auditable - whether changes to this field are tracked in the audit log
- Deprecation - soft-disable a field before permanent removal
Verifications
Customer verification tracks identity checks and compliance validations performed through external verification providers. Each verification has a status lifecycle:
pending → verified / failed / expired.
Use verifications for KYC/KYB compliance, age verification, or business entity validation.Invoice Templates
Invoice document templates: authoring, per-document-type org defaults, duplication, and preview rendering.
Currencies
Workspace currency allowlist: which currencies are enabled for billing and catalog use.
FX
Foreign-exchange reference data: ECB snapshots, sync status, and rate overrides.
Tags
Org-defined labels and their assignment to customers, products, plans, subscriptions, invoices, and credit notes.
Accounting
Accounting integrations and export artifacts (DATEV and other providers).
Analytics
Real-time business metrics for your billing operation. Track monthly recurring revenue (MRR), customer churn, revenue breakdown by plan, and other key indicators.
- MRR - the normalized monthly revenue from all active subscriptions
- Churn - the rate at which customers cancel or downgrade
- Revenue - breakdown by product, plan, currency, and time period
Search
Global search across billing entities.
GDPR
GDPR data-subject tooling: full data export and PII erasure.
Audit Log
Organization-wide audit log: the operator-facing event stream across every entity, with full actor and cascade-chain detail.
Audit Events
Customer-scoped audit trail queries.
Audit Retention
Audit-trail retention and redaction (GDPR).
Portal
Customer-portal access links issued by operators.
Scheduling/Products
Scheduled product versions: timeline and lifecycle actions (release, unschedule, cancel, reconfirm).
Scheduling/Plans
Scheduled plan versions: timeline and lifecycle actions (release, unschedule, cancel, reconfirm).
Scheduling/Promotions
Scheduled promotion versions: timeline and lifecycle actions (release, unschedule, cancel, reconfirm).
Scheduling/Rate Tables
Scheduled rate-table versions: timeline and lifecycle actions (release, unschedule, cancel, reconfirm).
AI
API Keys
Account
Authorization
BulkArchive
Checkout Links
Identity Providers
Me
Members
Notifications
Organizations
Payments
Portal Config
Roles
Schedule
Schedule Flows
Transactions
Users
Webhook Endpoints
Workspaces
Schemas
AIFilterParseRequestAPIKeyRevokeResponseActivePromotionActorAddInvoiceLineRequestAddItemRequestAddProductRequestAddRequiredActionRequestAdjustRequestAllowanceRolledOverPayloadAllowanceStateResponseAppliedReserveDiscountAppliesAtApplyCreditNoteRequestApprovalDecisionApprovalRequestApprovalRequestApprovedPayloadApprovalRequestAutoRejectedPayloadApprovalRequestCancelledPayloadApprovalRequestCreatedPayloadApprovalRequestRejectedPayloadApprovalStatusApprovalStepApprovedPayloadApprovalStepAutoApprovedPayloadApprovalStepEscalatedPayloadApprovalStepStartedPayloadAttachIDPRequestAudienceMatchAudiencePreviewRequestAudiencePreviewResponseAuditEventAuditEventRetentionPolicyBatchIngestRequestBatchIngestResultBillingAddressBillingIntervalUnitBillingTimingBindingRoleBrandingBrandingUpsertRequestBreachDailyCountBreakdownBreakdownAdjustmentBudgetBehaviorBulkArchiveRequestBulkArchiveResponseBulkArchiveResultBulkCancelRequestBulkCancelResponseBulkCancelSkipBulkEnrollOutcomeBulkEnrollRequestBulkEnrollResponseBulkUpgradeRequestBulkUpgradeResponseBulkUpgradeSkippedRowBulkUpgradeUpgradedRowCancellationReasonCaptureHoldRequestChangeCustomerModeRequestChangeCustomerTypeRequestChangeQuantityRequestChangeSubscriptionVersionRequestChargeInvoiceResponseChargeKindCheckoutLinkCheckoutLinkCreateRequestCheckoutLinkUpdateRequestChildSetDiffChurnResponseClawbackComponentClawbackResultClonePlanRequestComputePriceRequestComputePriceResponseConditionConditionDetailConditionMetaConditionModeConditionPreviewConditionSetConsentConfigConsentItemConsentLinkCopyAsDraftRequestCopyProductAsDraftRequestCopyPromotionAsDraftRequestCopyTaxRuleAsDraftRequestCorrectiveInvoiceReviewRequiredPayloadCostCostExpressionCostScopeCostSummaryEntryCouponTokenStatusCreateAPIKeyRequestCreateAPIKeyResponseCreateBracketEntryCreateCostRequestCreateCreditNoteLineRequestCreateCreditNoteRequestCreateCustomFieldDefinitionRequestCreateCustomerRequestCreateCustomerResponseCreateDunningPolicyRequestCreateFXOverrideRequestCreateFlowRequestCreateInvitationRequestCreateInvoiceTemplateRequestCreateKeySetRequestCreateLookupEntryCreateManualInvoiceRequestCreateMeterRequestCreateOrganizationRequestCreateOrganizationResponseCreatePaymentGatewayConfigRequestCreatePaymentMethodRequestCreatePhaseInputCreatePhaseRequestCreatePlanRequestCreatePriceFormulaRequestCreatePriceRequestCreatePriceTierRequestCreateProductMeterBindingRequestCreateProductRequestCreatePromotionRequestCreateRateTableRequestCreateRoleRequestCreateScheduledChangeRequestCreateSubscriptionAddOnRequestCreateSubscriptionItemOverrideRequestCreateSubscriptionRequestCreateTagRequestCreateTaxRuleRequestCreateVerificationRequestCreateVersionRequestCreateWalletRequestCreateWebhookEndpointRequestCreateWebhookSecretRequestCreateWebhookSecretResponseCreateWorkspaceCurrencyRequestCreateWorkspaceRequestCreditApplicationsEnvelopeBodyCreditGrantCreditNoteCreditNoteApplicationCreditNoteApplicationForInvoiceCreditNoteAppliedPayloadCreditNoteCreatedPayloadCreditNoteIssuedPayloadCreditNoteLineCreditNotePDFRegenerationQueuedCreditNoteReasonCodeCreditNoteStatusCreditNoteVoidedPayloadCreditRequestCurrencyAmountCurrencyReferencesCustomFieldDefinitionCustomerCustomerAuditEventCustomerAuditRedactionResultCustomerCreatedPayloadCustomerGroupCustomerModeChangedPayloadCustomerOverviewCustomerStatusCustomerTypeCustomerTypeChangedPayloadCustomerVerificationDataEnvelopeAIFilterParseResultDataEnvelopeAPIKeyRevokeResponseDataEnvelopeAllowanceStateResponseDataEnvelopeAnalyticsMRRDataDataEnvelopeAnalyticsRevenueDataDataEnvelopeAudiencePreviewResponseDataEnvelopeAuditEventRetentionPolicyDataEnvelopeBulkArchiveResponseDataEnvelopeBulkCancelResponseDataEnvelopeBulkEnrollResponseDataEnvelopeBulkUpgradeResponseDataEnvelopeChargeInvoiceResponseDataEnvelopeCheckoutLinkDataEnvelopeChurnResponseDataEnvelopeClawbackResultDataEnvelopeComputePriceResponseDataEnvelopeCostDataEnvelopeCreateAPIKeyResponseDataEnvelopeCreateCustomerResponseDataEnvelopeCreateOrganizationResponseDataEnvelopeCreateWebhookSecretResponseDataEnvelopeCreditNoteDataEnvelopeCreditNoteApplicationDataEnvelopeCreditNotePDFRegenerationQueuedDataEnvelopeCustomFieldDefinitionDataEnvelopeCustomerDataEnvelopeCustomerAuditRedactionResultDataEnvelopeCustomerOverviewDataEnvelopeCustomerVerificationDataEnvelopeDunningPolicyDataEnvelopeEInvoiceDocumentDataEnvelopeEInvoiceDocumentCountsDataEnvelopeExportCatalogDataEnvelopeFXOverrideDataEnvelopeFXSnapshotDataEnvelopeFXSyncStatusDataEnvelopeFeedSummaryDataEnvelopeFinalizeInvoiceDataDataEnvelopeGDPRErasureResultDataEnvelopeGDPRExportDocumentDataEnvelopeGatewayUpdateAckDataEnvelopeGenerateEInvoiceResponseDataEnvelopeIDPSummaryDataEnvelopeIngestUsageEventDataDataEnvelopeIntegrationCatalogDataEnvelopeIntegrationConfigDataEnvelopeInvitationDataEnvelopeInvoiceDataEnvelopeInvoiceLineDataEnvelopeInvoiceTemplateDataEnvelopeIssueLinkResponseDataEnvelopeItemResolutionsDataEnvelopeKeySetDataEnvelopeListCheckoutLinkDataEnvelopeListCustomFieldDefinitionDataEnvelopeListEffectiveSettingDataEnvelopeListIDPSummaryDataEnvelopeListInvitationDataEnvelopeListMemberDataEnvelopeListOrganizationDomainDataEnvelopeListPromotionCouponTokenDataEnvelopeListRoleDataEnvelopeListSettingsCatalogItemDataEnvelopeListWorkspaceSettingDataEnvelopeMapStringDecimalDataEnvelopeMeCredentialsResponseDataEnvelopeMePermissionsResponseDataEnvelopeMeResponseDataEnvelopeMergeResultDataEnvelopeMeterDataEnvelopeMigrationPreviewResultDataEnvelopeOrgSecuritySettingsDataEnvelopeOrgTaxProfileDataEnvelopeOrganizationResponseDataEnvelopePaymentDataEnvelopePaymentGatewayConfigDataEnvelopePaymentMethodDataEnvelopePermissionsResponseDataEnvelopePlanDataEnvelopePlanDetailResponseDataEnvelopePlanPricePreviewResponseDataEnvelopePlanProductDataEnvelopePlanVersionDataEnvelopePortalBrandingDataEnvelopePortalSettingsDataEnvelopePreviewTargetResponseDataEnvelopePriceDataEnvelopePriceFormulaDataEnvelopePriceFormulaVersionDataEnvelopePriceResolutionDataEnvelopeProductDataEnvelopeProductMeterBindingDataEnvelopeProductVersionSnapshotDataEnvelopeProformaInvoiceDataEnvelopePromotionDataEnvelopePromotionPreviewResponseDataEnvelopePromotionRedemptionDataEnvelopePromotionVersionSnapshotDataEnvelopePublishImpactDataEnvelopePurgeResultDataEnvelopeRateTableDataEnvelopeRateTableUpdateDataDataEnvelopeRateTableVersionDataEnvelopeRefundInvoiceDataDataEnvelopeRegenerateInvoiceResultDataEnvelopeRepublishPlansResponseDataEnvelopeReserveResponseDataEnvelopeRevokeRedemptionResponseDataEnvelopeRoleDataEnvelopeRotateAPIKeyResponseDataEnvelopeScheduleFlowGraphDataEnvelopeScheduledChangeDataEnvelopeScheduledChangeDiffDataEnvelopeSimulateResponseDataEnvelopeSimulationResultDataEnvelopeSlackTestResponseDataEnvelopeSubscriptionDataEnvelopeSubscriptionAddOnDataEnvelopeSubscriptionDriftDataEnvelopeSubscriptionItemDataEnvelopeSubscriptionPhaseDataEnvelopeTagDataEnvelopeTagListDataEnvelopeTaxRuleDataEnvelopeTopupResponseDataEnvelopeTransferResultDataEnvelopeUpdateSubscriptionItemResponseDataEnvelopeUsageAggregateResponseDataEnvelopeUsageSummaryDataEnvelopeUserPreferencesDataEnvelopeUserProfileResponseDataEnvelopeVATRateListResponseDataEnvelopeValidateResultDataEnvelopeVersionHeaderDataEnvelopeVoidInvoiceResponseDataEnvelopeWalletDataEnvelopeWalletHoldDataEnvelopeWalletTopupResponseDataEnvelopeWalletTransactionDataEnvelopeWebhookDeliveryDataEnvelopeWebhookEndpointDataEnvelopeWorkingDraftDataEnvelopeWorkspaceDataEnvelopeWorkspaceCurrencyDataEnvelopeWorkspaceListResponseDebitRequestDependentPlanDependsOnDerivationFXDerivationTierDerivationTierStepDisputeChangedPayloadDocumentFailedPayloadDocumentGeneratedPayloadDocumentRequestedPayloadDraftDiffDriftCandidateVersionDunningPolicyDunningStageDunningStepDunningStepPayloadDurationUnitEInvoiceDocumentEInvoiceDocumentCountsEInvoiceFindingEInvoicingDocumentGeneratedPayloadEInvoicingDocumentQuarantinedPayloadEUVATRateEdgeSpecEffectEffectMetaEffectScopeEffectiveSettingEligiblePromotionEndKindEnrichedPlanProductEntityRefConfigEntryInputEnumOptionExportAuditRecordExportCatalogItemExportDescriptorExternalVerificationConditionFXOverrideFXSnapshotFXSyncStatusFeedAttentionFeedDayCountFeedEventFeedSummaryFieldChangeFilterNodeFilterTreeFindingFirstPurchaseConditionFixedDiscountEffectFlowFooterFormulaVarTypeFormulaVariableFreePeriodsEffectFreeProductEffectGDPRErasureResultGDPRExportDocumentGatewayUpdateAckGenerateEInvoiceRequestGenerateEInvoiceResponseGenerateInvoiceRequestGenerateTokensRequestGrantHitHoldRequestHoldStatusIDPSummaryIneligiblePromotionIngestEventRequestIntegrationCatalogEntryIntegrationConfigInvitationInvoiceInvoiceCreatedPayloadInvoiceCreditSummaryInvoiceFinalizedPayloadInvoiceGeneratedPayloadInvoiceLineInvoiceLineAddedPayloadInvoiceLineAtomInvoiceLineAtomTaxComponentInvoiceLineAtomTierInvoiceLineDeletedPayloadInvoiceLineFieldChangeInvoiceLineTypeInvoiceLineUpdatedPayloadInvoicePaymentInvoicePaymentAttemptFailedPayloadInvoicePaymentFailedTerminalPayloadInvoicePaymentKindInvoicePaymentRecordedPayloadInvoicePendingApprovalPayloadInvoiceStatusInvoiceTemplateInvoiceTypeInvoiceUpdatedPayloadInvoiceVoidedPayloadIssueLinkResponseIssuePortalLinkRequestItemResolutionsItemTaxKeyCoverageKeyFilterKeySetKeySetEntryKeySetReferenceLateEventPolicyMRRByTypeResponseMRRByTypeSegmentMRRDataPointMRRResponseManualInvoiceHostedLinkRequestedPayloadManualInvoiceLineTypeMeCredentialsResponseMeOrgMembershipMePermissionsResponseMeResponseMeUserMemberMergeConflictMergeCustomerRequestMergeResultMergeStrategyMeterMeterBindingMeterSummaryMeterBreachMeterFormulaMeterFunctionMeterThresholdBreachedPayloadMigrateModeMigrateSubscribersRequestMigratedSubscriberResultMigrationPreviewResultMinimumSpendConditionMoneyMutationRecordedPayloadOSSThresholdStateOrgSecuritySettingsOrgTaxProfileOrganizationDomainOrganizationResponsePageEnvelopeAuditEventPageEnvelopeAuditEventRetentionPolicyPageEnvelopeBreachDailyCountPageEnvelopeCostPageEnvelopeCreditNotePageEnvelopeCreditNoteApplicationPageEnvelopeCustomerPageEnvelopeCustomerAuditEventPageEnvelopeCustomerVerificationPageEnvelopeDependentPlanPageEnvelopeEInvoiceDocumentPageEnvelopeEInvoiceFindingPageEnvelopeExportAuditRecordPageEnvelopeFXOverridePageEnvelopeFXSnapshotPageEnvelopeFeedEventPageEnvelopeFlowPageEnvelopeHitPageEnvelopeInvoicePageEnvelopeInvoiceLinePageEnvelopeInvoicePaymentPageEnvelopeInvoiceTemplatePageEnvelopeItemResolutionsPageEnvelopeKeySetPageEnvelopeKeySetReferencePageEnvelopeMeterPageEnvelopeMeterBreachPageEnvelopePaymentGatewayConfigPageEnvelopePaymentMethodPageEnvelopePlanPageEnvelopePricePageEnvelopePriceFormulaPageEnvelopeProductPageEnvelopeProductConsumerPageEnvelopeProductMeterBindingPageEnvelopePromotionPageEnvelopePromotionCouponTokenPageEnvelopePromotionRedemptionPageEnvelopeProrationLedgerPageEnvelopeRateTablePageEnvelopeReferrerRowPageEnvelopeScheduleFlowStepItemPageEnvelopeScheduleFlowStepTransitionPageEnvelopeScheduledChangeViewPageEnvelopeSubscriptionPageEnvelopeSubscriptionAddOnPageEnvelopeSubscriptionItemPageEnvelopeSubscriptionPhasePageEnvelopeSubscriptionPlanVersionHistoryRowPageEnvelopeSummaryPageEnvelopeTagPageEnvelopeTaxRulePageEnvelopeTransactionPageEnvelopeUsageEventPageEnvelopeVersionHeaderPageEnvelopeVersionRowPageEnvelopeWalletPageEnvelopeWalletHoldPageEnvelopeWalletTransactionPageEnvelopeWebhookDeliveryPageEnvelopeWebhookEndpointPageEnvelopeWebhookSecretPageEnvelopeWorkspaceCurrencyPaginationBlockPaymentPaymentChangedPayloadPaymentGatewayConfigPaymentMethodPaymentProviderPercentageDiscountEffectPermissionPermissionsResponsePhasePhaseKindPhaseStatusPinSubscriptionItemVersionRequestPlanPlanDetailResponsePlanPricePreviewLinePlanPricePreviewRequestPlanPricePreviewResponsePlanProductPlanProductCostSummaryPlanProductMeterBindingSummaryPlanProductPriceSummaryPlanPublishedPayloadPlanSubscribersMigratedPayloadPlanTransitionRequestPlanVersionPlanVersionProductPlanVersionRebasedPayloadPlanVersionSnapshotPortalBrandingPortalSettingsPreviewInvoiceTemplateRequestPreviewTargetRequestPreviewTargetResponsePricePriceBreakdownPriceDerivationPriceFormulaPriceFormulaVersionPriceKindPriceOverrideEffectPriceReferencedCostPriceResolutionPriceTierPricingModelProblemProductProductActivatedPayloadProductAllowanceStateProductArchivedPayloadProductCombinationConditionProductConsumerProductCopiedPayloadProductCreatedPayloadProductDeletedPayloadProductMeterBindingProductRequirementProductSavingProductTaxCategoryProductTrackModeProductUpdatedPayloadProductVersionRebasedPayloadProductVersionSnapshotProformaInvoiceProformaInvoiceLinePromotionPromotionActivatedPayloadPromotionArchetypePromotionArchivedPayloadPromotionAudiencePromotionBudgetExhaustedPayloadPromotionCouponTokenPromotionCreatedPayloadPromotionDistributionPromotionEffectAppliedPayloadPromotionEvaluationScopePromotionExpiredPayloadPromotionGraceAnchorPromotionGraceDirectionPromotionPhaseChangedPayloadPromotionPreviewRequestPromotionPreviewResponsePromotionRedeemedPayloadPromotionRedemptionPromotionRedemptionCapReachedPayloadPromotionRedemptionDormantPayloadPromotionRedemptionFreePeriodsExhaustedPayloadPromotionRedemptionReactivatedPayloadPromotionRedemptionRevokedPayloadPromotionRedemptionStatusPromotionTimingPromotionUpdatedPayloadPromotionVersionSnapshotProrationLedgerProrationRecordPublishImpactPublishImpactPlanPurgeResultQuantitySourceQuantityThresholdConditionRateTableRateTableEntryRateTableImportRequestRateTableVersionReachablePriceRecordManualPaymentRequestRedeemPromotionRequestRedeemWithTokenRequestReferrerRowRefreshUnitRefundInvoiceRequestRefundInvoiceResponseRegenerateInvoiceResultRemoveItemRequestRepublishPlanResultRepublishPlansRequestRepublishPlansResponseRescheduleRequestReserveOutcomeEventPayloadReserveRequestReserveResponseResolutionPeriodResolveFindingRequestResolvePriceRequestResolvedPriceRevenueBreakdownItemRevenueByCustomerTypeItemRevenueByCustomerTypeResponseRevenueResponseRevokeRedemptionRequestRevokeRedemptionResponseRoleRotateAPIKeyResponseScheduleFlowEdgeScheduleFlowGraphScheduleFlowStepScheduleFlowStepItemScheduleFlowStepTransitionScheduledChangeScheduledChangeCancelledPayloadScheduledChangeCreateBodyScheduledChangeCreatedPayloadScheduledChangeDiffScheduledChangeReconfirmedPayloadScheduledChangeReleasedPayloadScheduledChangeRolledBackPayloadScheduledChangeStatusScheduledChangeSupersededPayloadScheduledChangeUpcomingPayloadScheduledChangeViewSeatPolicySeatPolicyInputSetAllowanceRefreshRequestSetProductPoolRequestSetVATManualOverrideRequestSettingsCatalogItemSettingsEnumSettingsFieldSettingsSchemaSettingsUpsertRequestSimulateChangesRequestSimulateInvoiceSimulateInvoiceLineSimulateRequestSimulateResponseSimulateSavingsSimulateVersionChangeSimulationLineItemSimulationResultSlackTestRequestSlackTestResponseSpendScopeStackingModeStartTriggerStateTransitionedPayloadStepSpecSubscriptionSubscriptionActivatedPayloadSubscriptionAddOnSubscriptionCancelledPayloadSubscriptionCreatedPayloadSubscriptionDriftSubscriptionDriftSummarySubscriptionDunningEnteredPayloadSubscriptionDunningStageChangedPayloadSubscriptionItemSubscriptionItemAddedPayloadSubscriptionItemInputSubscriptionItemRemovedPayloadSubscriptionPausedPayloadSubscriptionPaymentFailedPayloadSubscriptionPhaseSubscriptionPlanChangedPayloadSubscriptionPlanConditionSubscriptionPlanVersionHistoryRowSubscriptionQuantityChangedPayloadSubscriptionRecoveredPayloadSubscriptionRefundRequiredPayloadSubscriptionResumedPayloadSubscriptionSettingsSubscriptionStatusSubscriptionTargetSelectorSummarySupplyTypeTagTagIDsRequestTagMatchModeTagRefTaggableEntityTypeTaxCategoryCodeTaxRuleTaxTypeTemplateBlockTemplateDocumentThemeThresholdThresholdActionThresholdActionKindThresholdComparatorTopupRequestTopupResponseTransactionTransferRequestTransferResultTransitionPhaseRequestTranslationFieldsTriggerActionUpcomingPriceUpdateCostRequestUpdateCustomFieldDefinitionRequestUpdateCustomerRequestUpdateFXOverrideRequestUpdateFlowRequestUpdateIDPRequestUpdateInvoiceLineRequestUpdateInvoiceRequestUpdateInvoiceTemplateRequestUpdateKeySetRequestUpdateMemberRolesRequestUpdateMemberStatusRequestUpdateMeterRequestUpdateOrgSecuritySettingsRequestUpdateOrgTaxProfileRequestUpdateOrganizationRequestUpdatePaymentGatewayConfigRequestUpdatePaymentMethodRequestUpdatePhaseRequestUpdatePlanProductRequestUpdatePlanRequestUpdatePriceFormulaRequestUpdatePriceRequestUpdateProductMeterBindingRequestUpdateProductRequestUpdatePromotionRequestUpdateProviderSettingsRequestUpdateRateTableRequestUpdateRoleRequestUpdateScheduledChangeRequestUpdateSubscriptionItemRequestUpdateSubscriptionItemResponseUpdateSubscriptionRequestUpdateTagRequestUpdateTaxRuleRequestUpdateUserPreferencesRequestUpdateVerificationStatusRequestUpdateWalletSettingsRequestUpdateWebhookEndpointRequestUpdateWorkspaceCurrencyRequestUpdateWorkspaceRequestUpsertDomainsRequestUpsertEntriesRequestUpsertIntegrationRequestUpsertRetentionPolicyRequestUpsertSettingsRequestUsageAggregateBucketUsageAggregateResponseUsageCreditsEffectUsageEventUsageEventQueuedResponseUsageSummaryUsageThresholdConditionUserPreferencesUserProfileResponseVATRateListResponseValidatePromotionRequestValidateResultValidationRulesVatValidationStatusVerificationCheckTypeVerificationStatusVersionChangeStrategyVersionHeaderVersionRowVersionStatusVersionTrackModeVersionWarnVersionWarningVoidInvoiceResponseWalletWalletApplyToInvoicePayloadWalletAutoTopupTriggeredPayloadWalletCreditEffectWalletHoldWalletHoldExpiredPayloadWalletModeWalletModeSnapshotWalletPaymentSkippedPayloadWalletTopupRequestWalletTopupResponseWalletTransactionWalletTransactionSourceWalletTransactionTypeWalletTransferredPayloadWebhookDeliveryWebhookEndpointWebhookSecretWindowWorkingDraftWorkspaceWorkspaceCurrencyWorkspaceListResponseWorkspaceSetting
Webhooks
allowance.rolled_over
allowance.rolled_over
POST
approval.request_approved
approval.request_approved
POST
approval.request_auto_rejected
approval.request_auto_rejected
POST
approval.request_cancelled
approval.request_cancelled
POST
approval.request_created
approval.request_created
POST
approval.request_rejected
approval.request_rejected
POST
approval.step_approved
approval.step_approved
POST
approval.step_auto_approved
approval.step_auto_approved
POST
approval.step_escalated
approval.step_escalated
POST
approval.step_started
approval.step_started
POST
credit_note.applied
credit_note.applied
POST
credit_note.created
credit_note.created
POST
credit_note.issued
credit_note.issued
POST
credit_note.voided
credit_note.voided
POST
customer.corrective_invoice_review_required
customer.corrective_invoice_review_required
POST
customer.created
customer.created
POST
customer.mode_changed
customer.mode_changed
POST
customer.type_changed
customer.type_changed
POST
dispute.changed
dispute.changed
POST
document.failed
document.failed
POST
document.generated
document.generated
POST
document.requested
document.requested
POST
dunning.step.cancel
dunning.step.cancel
POST
dunning.step.email
dunning.step.email
POST
dunning.step.grace
dunning.step.grace
POST
dunning.step.suspend
dunning.step.suspend
POST
e_invoicing.document.generated
e_invoicing.document.generated
POST
e_invoicing.document.quarantined
e_invoicing.document.quarantined
POST
invoice.created
invoice.created
POST
invoice.finalized
invoice.finalized
POST
invoice.generated
invoice.generated
POST
invoice.line_added
invoice.line_added
POST
invoice.line_deleted
invoice.line_deleted
POST
invoice.line_updated
invoice.line_updated
POST
invoice.manual_collection_link_requested
invoice.manual_collection_link_requested
POST
invoice.payment_attempt_failed
invoice.payment_attempt_failed
POST
invoice.payment_failed_terminal
invoice.payment_failed_terminal
POST
invoice.payment_recorded
invoice.payment_recorded
POST
invoice.pending_approval
invoice.pending_approval
POST
invoice.updated
invoice.updated
POST
invoice.voided
invoice.voided
POST
meter.threshold_breached
meter.threshold_breached
POST
mutation.recorded
mutation.recorded
POST
payment.changed
payment.changed
POST
plan.published
plan.published
POST
plan.subscribers_migrated
plan.subscribers_migrated
POST
plan.version_rebased
plan.version_rebased
POST
product.activated
product.activated
POST
product.archived
product.archived
POST
product.copied
product.copied
POST
product.created
product.created
POST
product.deleted
product.deleted
POST
product.updated
product.updated
POST
product.version_rebased
product.version_rebased
POST
promotion.activated
promotion.activated
POST
promotion.archived
promotion.archived
POST
promotion.budget_exhausted
promotion.budget_exhausted
POST
promotion.created
promotion.created
POST
promotion.effect_applied
promotion.effect_applied
POST
promotion.expired
promotion.expired
POST
promotion.phase_changed
promotion.phase_changed
POST
promotion.redeemed
promotion.redeemed
POST
promotion.redemption_cap_reached
promotion.redemption_cap_reached
POST
promotion.redemption_dormant
promotion.redemption_dormant
POST
promotion.redemption_free_periods_exhausted
promotion.redemption_free_periods_exhausted
POST
promotion.redemption_reactivated
promotion.redemption_reactivated
POST
promotion.redemption_revoked
promotion.redemption_revoked
POST
promotion.updated
promotion.updated
POST
reserve_outcome.captured
reserve_outcome.captured
POST
reserve_outcome.failed
reserve_outcome.failed
POST
reserve_outcome.queued
reserve_outcome.queued
POST
scheduled_change.cancelled
scheduled_change.cancelled
POST
scheduled_change.created
scheduled_change.created
POST
scheduled_change.reconfirmed
scheduled_change.reconfirmed
POST
scheduled_change.released
scheduled_change.released
POST
scheduled_change.rolled_back
scheduled_change.rolled_back
POST
scheduled_change.superseded
scheduled_change.superseded
POST
scheduled_change.upcoming
scheduled_change.upcoming
POST
state.transitioned
state.transitioned
POST
subscription.activated
subscription.activated
POST
subscription.cancelled
subscription.cancelled
POST
subscription.created
subscription.created
POST
subscription.dunning_entered
subscription.dunning_entered
POST
subscription.dunning_stage_changed
subscription.dunning_stage_changed
POST
subscription.item_added
subscription.item_added
POST
subscription.item_removed
subscription.item_removed
POST
subscription.paused
subscription.paused
POST
subscription.payment_failed
subscription.payment_failed
POST
subscription.plan_changed
subscription.plan_changed
POST
subscription.quantity_changed
subscription.quantity_changed
POST
subscription.recovered
subscription.recovered
POST
subscription.refund_required
subscription.refund_required
POST
subscription.resumed
subscription.resumed
POST
tax.oss_threshold_approaching
tax.oss_threshold_approaching
POST
tax.oss_threshold_exceeded
tax.oss_threshold_exceeded
POST
wallet.apply_to_invoice
wallet.apply_to_invoice
POST
wallet.auto_topup_triggered
wallet.auto_topup_triggered
POST
wallet.hold_expired
wallet.hold_expired
POST
wallet.payment_skipped
wallet.payment_skipped
POST
wallet.transferred
wallet.transferred
POST