Extension

Events categorised under extension level will be triggered when any action performed on extension. e.g. If extension is installed.

Extension subscription

This event will be generated where there is any action done on extension-subscription

Events

extension/extension-subscription/create/v1

# this event is triggered when extension-subscription is created

extension/extension-subscription/update/v1

# this event is triggered when extension-subscription is updated

Extension Subscription/extension-subscription/create/v1

this event is triggered when extension-subscription is created

Payload

Hide

company_id

integer

Required

Company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "_id",
70        "name",
71        "price",
72        "capped_amount",
73        "activated_on",
74        "cancelled_on",
75        "is_test",
76        "pricing_type",
77        "subscriber_id",
78        "status",
79        "created_at",
80        "modified_at",
81        "trial_days"
82      ],
83      "properties": {
84        "_id": {
85          "type": "string",
86          "description": "Subscription id"
87        },
88        "meta": {
89          "type": "object",
90          "required": [
91            "name"
92          ],
93          "properties": {
94            "name": {
95              "type": "string"
96            }
97          },
98          "description": "Open dictionary containing any meta data regarding extension"
99        },
100        "name": {
101          "type": "string",
102          "description": "Name of subscription plan"
103        },
104        "term": {
105          "type": "string",
106          "description": "Plan tagline"
107        },
108        "price": {
109          "type": "object",
110          "required": [
111            "currency_code",
112            "amount"
113          ],
114          "properties": {
115            "amount": {
116              "type": "integer",
117              "description": "Subscription amount to be deducted in each billing cycle"
118            },
119            "currency_code": {
120              "type": "string",
121              "description": "Subscription amount currency ISO code"
122            }
123          }
124        },
125        "status": {
126          "type": "string",
127          "description": "Current status of subscription. Possible values: pending, active, declined, no_renew, cancelled, frozen"
128        },
129        "is_test": {
130          "type": "boolean",
131          "description": "Flag to indicate charges are test charges"
132        },
133        "recurring": {
134          "type": "object",
135          "required": [
136            "interval_time",
137            "interval"
138          ],
139          "properties": {
140            "interval": {
141              "type": "string",
142              "description": "Specifies the duration of the plan"
143            },
144            "interval_time": {
145              "type": "integer",
146              "description": "Signifies recurring time periods"
147            }
148          }
149        },
150        "created_at": {
151          "type": "string",
152          "description": "ISODate subscription creation date"
153        },
154        "trial_days": {
155          "type": "integer",
156          "description": "Number of trial days allowed in current subscription"
157        },
158        "modified_at": {
159          "type": "string",
160          "description": "ISODate subscription latest updation date"
161        },
162        "activated_on": {
163          "type": [
164            "string",
165            "null"
166          ],
167          "description": "ISODate string for subscription activation (Null when in pending state)"
168        },
169        "cancelled_on": {
170          "type": [
171            "string",
172            "null"
173          ],
174          "description": "ISODate string for subscription cancelled state (Null until moved to cancelled state)"
175        },
176        "extension_id": {
177          "type": "string",
178          "description": "Extension ID"
179        },
180        "pricing_type": {
181          "type": "string",
182          "description": "Pricing type for current extension charge (It will be always `recurring` for subscription)"
183        },
184        "capped_amount": {
185          "type": "integer",
186          "description": "Max usage allowed under current extension charge"
187        },
188        "subscriber_id": {
189          "type": "string",
190          "description": "Subscriber id for fynd platform Seller/company owner"
191        },
192        "current_period": {
193          "type": "object",
194          "description": "Current time period of subscription"
195        }
196      }
197    }
198  }
199}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "unicron-platform.0a9275f1-5ece-4e29-a8b6-dfb972b197fa"
5    ],
6    "name": "extension-subscription",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711438127195,
10    "id": "uyXO/k+tTpIM7VCzXAxL1Z5Y56Pk/YsNnIO+SpC9eg4=",
11    "category": "extension"
12  },
13  "company_id": 4783,
14  "contains": [
15    "_id",
16    "name",
17    "term",
18    "price",
19    "capped_amount",
20    "activated_on",
21    "cancelled_on",
22    "is_test",
23    "pricing_type",
24    "recurring",
25    "subscriber_id",
26    "status",
27    "meta",
28    "billing_date",
29    "current_period",
30    "created_at",
31    "modified_at",
32    "trial_days",
33    "extension_id"
34  ],
35  "payload": {
36    "_id": "6602792fec4fff74b1ddca19",
37    "name": "Standard",
38    "term": "Will be charged on every month",
39    "price": {
40      "currency_code": "INR",
41      "amount": 99
42    },
43    "capped_amount": 0,
44    "activated_on": null,
45    "cancelled_on": null,
46    "is_test": false,
47    "pricing_type": "recurring",
48    "recurring": {
49      "interval_time": 1,
50      "interval": "month"
51    },
52    "subscriber_id": "646874e32f39458c2fb163e8",
53    "status": "pending",
54    "meta": {
55      "name": "Google Tag Manager"
56    },
57    "billing_date": null,
58    "current_period": {},
59    "created_at": "2024-03-26T07:28:47.188Z",
60    "modified_at": "2024-03-26T07:28:47.188Z",
61    "trial_days": 0,
62    "extension_id": "61384111bee79ce4ac848a57"
63  }
64}

Extension Subscription/extension-subscription/update/v1

this event is triggered when extension-subscription is updated

Payload

Hide

company_id

integer

Required

Company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "_id",
70        "name",
71        "price",
72        "capped_amount",
73        "activated_on",
74        "cancelled_on",
75        "is_test",
76        "pricing_type",
77        "subscriber_id",
78        "status",
79        "created_at",
80        "modified_at",
81        "trial_days"
82      ],
83      "properties": {
84        "_id": {
85          "type": "string",
86          "description": "Subscription id"
87        },
88        "meta": {
89          "type": "object",
90          "required": [
91            "name"
92          ],
93          "properties": {
94            "name": {
95              "type": "string"
96            }
97          },
98          "description": "Open dictionary containing any meta data regarding extension"
99        },
100        "name": {
101          "type": "string",
102          "description": "Name of subscription plan"
103        },
104        "term": {
105          "type": "string",
106          "description": "Plan tagline"
107        },
108        "price": {
109          "type": "object",
110          "required": [
111            "currency_code",
112            "amount"
113          ],
114          "properties": {
115            "amount": {
116              "type": "integer",
117              "description": "Subscription amount to be deducted in each billing cycle"
118            },
119            "currency_code": {
120              "type": "string",
121              "description": "Subscription amount currency ISO code"
122            }
123          }
124        },
125        "status": {
126          "type": "string",
127          "description": "Current status of subscription. Possible values: pending, active, declined, no_renew, cancelled, frozen"
128        },
129        "is_test": {
130          "type": "boolean",
131          "description": "Flag to indicate charges are test charges"
132        },
133        "recurring": {
134          "type": "object",
135          "required": [
136            "interval_time",
137            "interval"
138          ],
139          "properties": {
140            "interval": {
141              "type": "string",
142              "description": "Specifies the duration of the plan"
143            },
144            "interval_time": {
145              "type": "integer",
146              "description": "Signifies recurring time periods"
147            }
148          }
149        },
150        "created_at": {
151          "type": "string",
152          "description": "ISODate subscription creation date"
153        },
154        "trial_days": {
155          "type": "integer",
156          "description": "Number of trial days allowed in current subscription"
157        },
158        "modified_at": {
159          "type": "string",
160          "description": "ISODate subscription latest updation date"
161        },
162        "activated_on": {
163          "type": [
164            "string",
165            "null"
166          ],
167          "description": "ISODate string for subscription activation (Null when in pending state)"
168        },
169        "cancelled_on": {
170          "type": [
171            "string",
172            "null"
173          ],
174          "description": "ISODate string for subscription cancelled state (Null until moved to cancelled state)"
175        },
176        "extension_id": {
177          "type": "string",
178          "description": "Extension ID"
179        },
180        "pricing_type": {
181          "type": "string",
182          "description": "Pricing type for current extension charge (It will be always `recurring` for subscription)"
183        },
184        "capped_amount": {
185          "type": "integer",
186          "description": "Max usage allowed under current extension charge"
187        },
188        "subscriber_id": {
189          "type": "string",
190          "description": "Subscriber id for fynd platform Seller/company owner"
191        },
192        "current_period": {
193          "type": "object"
194        }
195      }
196    }
197  }
198}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "unicron-internal.61b3c121-588c-46ae-8a62-d1dc15d6b4fc"
5    ],
6    "name": "extension-subscription",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711625158694,
10    "id": "amwPZr7RqNZgnFsQgQGHNeH70Mgllkwow1B/UEDkUv0=",
11    "category": "extension"
12  },
13  "company_id": 7019,
14  "contains": [
15    "_id",
16    "name",
17    "term",
18    "price",
19    "capped_amount",
20    "activated_on",
21    "cancelled_on",
22    "is_test",
23    "pricing_type",
24    "recurring",
25    "subscriber_id",
26    "status",
27    "meta",
28    "billing_date",
29    "current_period",
30    "created_at",
31    "modified_at",
32    "trial_days",
33    "extension_id"
34  ],
35  "payload": {
36    "_id": "660553bb0b77a83be66f7150",
37    "name": "BASIC",
38    "term": "Elevate Your Shopping Experience with Personalized Products",
39    "price": {
40      "currency_code": "INR",
41      "amount": 199
42    },
43    "capped_amount": 0,
44    "activated_on": "2024-03-28T11:25:58.673Z",
45    "cancelled_on": null,
46    "is_test": false,
47    "pricing_type": "recurring",
48    "recurring": {
49      "interval_time": 1,
50      "interval": "month"
51    },
52    "subscriber_id": "65eaf2677eb29250fb703a28",
53    "status": "active",
54    "meta": {
55      "name": "Product Customisation"
56    },
57    "billing_date": "2024-03-28T11:25:58.666Z",
58    "current_period": {
59      "start_date": "2024-03-28T11:25:58.666Z",
60      "end_date": "2024-04-28T11:25:58.666Z"
61    },
62    "created_at": "2024-03-28T11:25:47.927Z",
63    "modified_at": "2024-03-28T11:25:58.681Z",
64    "trial_days": 0,
65    "extension_id": "64f02dae38ae0620b70c2969"
66  }
67}

« extension/install/v1