This page provides the list of events and associated payload for the Subscription microservice.
List of Events
| SL.# | Name | Description | Publish Location | Routing Key | Durability | Payload Type |
|---|---|---|---|---|---|---|
| 1 | Create Subscription | This event is triggered when a new subscription is created and a customer has successfully subscribed it via storefront. | Topic:ecomm | subscription.create | true | SubscriptionEventPayload |
| 2 | Update Subscription | This event is triggered when a subscription is modified by the customer via storefront for updating shipping, billing, and/or payment information. | Topic:ecomm | subscription.update | true | SubscriptionEventPayload |
| 3 | Cancel Subscription | This event is triggered when a subscription is canceled by the customer. | Topic:ecomm | subscription.cancel | true | SubscriptionEventPayload |
| 4 | Create Instance | This event is triggered when a subscription instance is created successfully. | Topic:ecomm | subscription.instance.create | true | SubscriptionEventPayload |
| 5 | Scheduled Instance | This event is triggered when a subscription instance is scheduled successfully. | Topic:ecomm | subscription.instance.schedule | true | SubscriptionEventPayload |
| 6 | Frozen Instance | This event is triggered when a subscription instance is frozen. | Topic:ecomm | subscription.instance.frozen | true | SubscriptionEventPayload |
| 7 | Completed Instance | This event is triggered when a subscription instance is completed successfully. | Topic:ecomm | subscription.instance.completed | true | SubscriptionEventPayload |
| 8 | Failed Instance | This event is triggered when a subscription instance is failed; for example, failure while processing the payment. | Topic:ecomm | subscription.instance.failed | true | SubscriptionEventPayload |
| 9 | Add item Subscription | Add new item in subscription event is fired when a new item is added in existing subscription | Topic:ecomm | subscription.item.create | true | SubscriptionEventPayload |
| 10 | Update item Subscription | Update item in subscription event is fired when a item is updated in existing subscription | Topic:ecomm | subscription.item.update | true | SubscriptionEventPayload |
| 11 | Update item Subscription | Update item in subscription event is fired when a item is updated in existing subscription | Topic:ecomm | subscription.item.update | true | SubscriptionEventPayload |
| 12 | Delete item Subscription | Delete item in subscription event is fired when a item is deleted in existing subscription | Topic:ecomm | subscription.item.delete | true | SubscriptionEventPayload |
Payload Model
Below is the payload for the Subscription microservice events:
SubscriptionEventPayload
| Property | Type | Description | Example |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
subscriptionId | long | Indicates the identifier of the subscription, which is created, updated, or deleted. | 123 |
accountId | string | Indicates the unique ID of the account. | 1 |
userId | string | Specifies the identifier of the user, who accesses the subscription. | 123 |
subscriptionStatus | string | Specifies the status of the project, such as CREATED, SCHEDULED, ON-HOLD, CANCELED, DELETE, RESUME, or COMPLETED. | CREATED |
instanceId | long | Indicates the unique ID of the instance. | 1 |
instanceStatus | string | Specifies the status of the project, such as DAILY, WEEKLY, MONTHLY, or YEARLY. | WEEKLY |
Revision History
2019-09-24 | Ananthi – Page created and the content updated.
