Developer Docs

Developer Docs

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

›Customer and Contract

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

Contract Changed

Sent whenever the state of a contract has changed. There are various reasons why the contract could have changed, e.g.:

  • The trial has ended
  • The contract has ended
  • The contract was up- or downgraded
  • A component subscription was added or removed

Typical Scenario

You want to listen to this hook to make sure your customers gets what he ordered (and only what they paid for). Together with ContractCreated, this is the most important hook. To find out what the current state of the contract is, simply fetch the referenced contract by id and make sure to configure your service to deliver what is configured in the contract.

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

{
    "ContractId" : "51d970c8eb596a1168df119a",
    "CustomerId":"6242991221642365b05d86a9",
    "Event" : "ContractChanged",
    "EntityId":"62148e3c0c14e1609e9ca5c1"
}
Last updated on 6/2/2022 by Przemek Dawidowicz
← Contract CreatedContract Data Changed →
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