Skip to main content

Instalments Invoiced

Webhook

Type: instalments.invoiced.v1

Occurs when an invoice including one or more instalments is created.

Payload​

The data object in the payload contains IDs that indicate the invoice that has been created and the associated merchant and instalment plan. Also note the following child objects within the payload:

  • tax_subtotals: Contains specific information about the tax subtotals of the invoice.
  • instalments: Contains specific information about the instalments comprising the invoice.

Example​

{
    "specversion": "1.0",
    "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
    "type": "instalments.invoiced.v1",
    "time": "2023-06-21T12:34:56.123456",
    "source": "webhooks.two.inc",
    "subject": "instalment_account/044d6cf0-0f51-11ec-82a8-0242ac130003",
    "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
    "data": {
        "invoice_id": "e39f3206-0f94-4b9d-9f8f-1b2bae1e2bc9",
        "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
        "issue_date": "2023-06-05T12:34:56.123456",
        "due_date": "2023-06-05T12:34:56.123456",
        "invoice_number": "90000001",
        "instalment_account_id": "044d6cf0-0f51-11ec-82a8-0242ac130003",
        "gross_amount": "1000.00",
        "tax_subtotals": [
            {
                "tax_rate": "0.250000",
                "taxable_amount": "500.00",
                "tax_amount": "125.00"
            },
            {
                "tax_rate": "0.000000",
                "taxable_amount": "500.00",
                "tax_amount": "0.00"
            }
        ],
        "instalments": [
            {
                "plan_id": "b6c9de3c-5d51-4a9d-89b1-63e1a9f7c5e5",
                "instalment_id": "a0f4bc40-8c5d-4b80-8c40-7d1f0b5a1f74"
            },
            {
                "plan_id": "ff6b6e3e-5e0e-4d27-bc62-4e5a3a80e7f4",
                "instalment_id": "d2f5f79b-1e5a-4fe3-9e53-0b3a4b2c1c1b"
            }
        ]
    }
}

Request​

Responses​

Successful Response