Subscription State Changed Event (v0.1.0)

The state of a subscription has changed.

Event Recently updated! Broker:AWS Eventbridge

Overview

A state change of the subscription might occur when there is no money left in the bucket. State may also change when money is added. Don’t mix up with Credits Low Events or similar. It is possible that both an Credit Alert Event and a Subscription State Change event is raised.

CMS might disable call out in CMS system, but it will still be shown as active in NBS. After some time the state might change again but this time in NBS, without any change in CMS.

Architecture diagram

Payload example

Payload example
{
  "Subscription": {
    "Id": "550e8400-e29b-41d4-a716-446655440000",
    "CustomerId": "550e8400-e29b-41d4-a716-446655440001",
    "Name": "Premium Plan",
    "State": "Active"
  },
  "State": "Suspended",
  "PreviousState": "Active",
  "CustomerDetail": {
    "Id": "550e8400-e29b-41d4-a716-446655440002",
    "User": {
      "Id": "550e8400-e29b-41d4-a716-446655440003"
    },
    "Party": {
      "GovermentId": "123456789",
      "Name": "John Doe",
      "FirstName": "John",
      "LastName": "Doe",
      "CountryCode": "US",
      "MobileNumber": 1234567890,
      "FixedNumber": 9876543210,
      "Email": "john.doe@example.com",
      "IsOrg": false,
      "State": "Active"
    },
    "Account": {
      "Currency": "USD",
      "Name": "John's Account",
      "ExternalAccountNumber": "1234-5678-9012",
      "Email": "account@example.com"
    },
    "Attributes": {
      "customerType": "individual",
      "region": "north-america"
    }
  },
  "Attributes": {
    "eventType": "subscriptionStateChanged",
    "timestamp": "2023-10-01T12:34:56Z"
  }
}

JSON Schema

33 properties
Subscription object
required
State string
required
Allowed values: Unknown Inactive Active Suspended Pending
PreviousState string
Allowed values: Unknown Inactive Active Suspended Pending
CustomerDetail object
Attributes object
required
Edit this page