Developer Docs

Developer Docs

  • Getting Started
  • SubscriptionJS
  • REST API
  • Webhooks
  • Code Samples
  • UseCases
  • Request a Demo

›Payment

General

  • Introduction
  • Security & Reliability

Customer and Contract

  • Order Succeeded
  • Contract Created
  • Contract Changed
  • Contract Data Changed
  • Contract Deleted
  • Contract Cancelled
  • Customer Created
  • Customer Changed
  • Customer Deleted
  • Customer Locked
  • Customer Unlocked
  • Dunning Created
  • Invoice Created
  • Invoice Corrected
  • Recurring Billing Approaching
  • Trial End Approaching
  • AccountCreated (deprecated)

Payment

  • Payment Bearer Expiring
  • Payment Bearer Expired
  • Debit Auth Cancelled
  • Payment Data Changed
  • Payment Escalated
  • Payment Escalation Reset
  • Payment Succeeded
  • Payment Failed
  • Payment Process Status Changed
  • Payment Registered

Plan

  • Plan Created
  • Plan Changed
  • Plan Deleted

Planvariant

  • Planvariant Created
  • Planvariant Changed
  • Planvariant Deleted

Components

  • Component Created
  • Component Changed
  • Component Deleted

Reporting

  • Report Succeeded
  • Report Failed
  • Accounting Export File Created

Payment Escalated

This webhook is triggered based on your payment escalation settings.

Typical Scenario

You can use this hook to react to your customers non-payment, for example by sending a notification email or by suspending the account. The value of TriggerDays is the number of days since the payments due date. This is based on the oldest unpaid receivable, so it's possible that you receive a five-day-hook, then a ten-day-hook and a five-day-hook again.

HTTP/1.1
POST /billwerk-hook
Host: example.com
Content-Type: application/json

{
    "ContractId": "6298a006e636b694d807080f",
    "CustomerId": "6298a006e636b694d8070809",
    "TriggerDays": 5,
    "DueDate": "2022-06-09T00:00:00.0000000Z",
    "PaymentEscalationProcessId": "623812c0426dc88abe51b23a",
    "Event": "PaymentEscalated",
    "EntityId": "62148e3c0c14e1609e9ca5c1"
}
Last updated on 6/14/2022 by Przemek Dawidowicz
← Payment Data ChangedPayment Escalation Reset →
Docs
Getting StartedAPI Reference
Resource
Help CenterSupportBlogTutorials
Start with billwerk
Test for free
Request a Demo
Already started?
billwerk Sandboxbillwerk Production
billwerk GmbH
© Made with ❤ in Germany for Europe by billwerk GmbH | 2022
Imprint
|
Data Privacy Rules
|
Disclaimer