# Bill Recipient Subscription Status Changed Event

Endpoint: POST Bill Recipient Subscription Status Changed Event
Version: 1.1
Security: X-API-Key

## Request fields (*/*):

  - `id` (integer, required)
    Event ID
    Example: 12345

  - `externalId` (string, required)
    Event ID
    Example: "EVID82A65938766547EBBBA39BA6F7B07F24"

  - `timestamp` (string, required)
    timestamp of the event
    Example: "2015-01-01T10:00Z"

  - `billRecipient` (object, required)

  - `billRecipient.emailAddress` (string)
    email address of the bill recipient
    Example: "peter@muster.ch"

  - `billRecipient.billRecipientId` (string, required)
    ID of the bill recipient
    Example: 41010560425610180

  - `billRecipient.enterpriseIdentificationNumber` (string)
    Swiss enterprise identification number (UID) without dashes, dots or extension. Note that this has to contain the swiss enterprise identification number (UID) from the commercial register (Handelsregister) which may be different from the VAT UID (Mehrwertsteuer UID).
    Example: "CHE123456789"

  - `billRecipient.type` (string, required)
    the type of the bill recipient
    Enum: "PRIVATE", "COMPANY"

  - `billRecipient.name` (string, required)
    last name, if private bill recipient company name, if company bill recipient
    Example: "for private bill recipient: Muster, for company name: Muster AG"

  - `billRecipient.firstName` (string)
    first name, if private bill recipient empty, if company bill recipient
    Example: "Peter"

  - `billRecipient.correspondenceLanguage` (string, required)
    language for correspondence with this bill recipient ISO-639-2/B
    Example: "ger"

  - `billRecipient.address` (object, required)
    The address of a bill recipient.

  - `billRecipient.address.streetName` (string, required)
    street name
    Example: "Neustadtstrasse"

  - `billRecipient.address.postalCode` (string, required)
    postal code
    Example: 6025

  - `billRecipient.address.city` (string, required)
    city name
    Example: "Neudorf"

  - `billRecipient.address.countryCode` (string, required)
    in format ISO 3166-1 alpha 2
    Example: "CH"

  - `accountNumber` (string)
    Account number of the biller (e.g. iban), if provided from the financial institution

  - `referenceStructured` (string)
    QR or creditor reference number, if provided from the financial institution.
    Example: 1.2345612345678902e+26

  - `billRecipientSubscriptionFormFields` (array)

  - `billRecipientSubscriptionFormFields.technicalId` (string, required)
    The identifying token of this subscription form field. Corresponds to the property technicalId of BillerSubscriptionFormField.
    Example: "customerNumber"

  - `billRecipientSubscriptionFormFields.value` (string, required)
    The value of this subscription form field as entered by the user. If a pattern is defined, it has been checked against it.
    Example: "123-abcd-456"

  - `newStatus` (string)
    the new status of the bill recipient subscription, see "Subscriptions and subscription cancellations" for further information
    Enum: "INACTIVE", "REQUESTED", "ACTIVE"