Skip to main content

Extension Subscription

Supported Type


Install

Description

Get notified when an extension is installed.

Payload

{
"payload":{
"extension":{
"id":"628db357622e131c981647cf",
"extension_type":"private",
"name":"UnicommerceTest-2",
"base_url":"https://6098-13-126-128-230.ngrok.io",
"organization_id":"60afe92972b7a964de57a1d4"
},
"company":{
"id":1,
"name":"THE MANDHANA RETAIL VENTURES LIMITED ",
"email":"test@gofynd.com"
},
"installed_on":"2022-09-30T08:06:19.794Z"
},
"meta":{
"event":{
"name":"extension",
"type":"install",
"version":"1"
},
"service":{
"name":"skywarp"
},
"company_id":1,
"trace_id":[
"skywarp-panel.33022a2f-6257-4088-95dc-648cec8234ad"
],
"created_timestamp":1664525179805,
"extension_id":"628db357622e131c981647cf"
}
}

Object Properties

KeyTypeDescription
_idStringSubscription ID on platform side
_idStringSubscription id
nameStringName of subscription plan
termStringPlan tagline
price.currency_codeStringSubscription amount currency ISO code
price.amountNumberSubscription amount to be deducted in each billing cycle
capped_amountNumberMax usage allowed under current extension charge
activated_onString/NullISODate string for subscription activation (Null when in pending state)
cancelled_onString/NullISODate string for subscription cancelled state (Null until moved to cancelled state)
is_testBooleanFlag to indicate charges are test charges
pricing_typeStringPricing type for current extension charge (It will be always `recurring` for subscription)
recurring.interval_timeIntegerSubscription each cycle period interval
recurring.intervalStringSubscription cycle type. Possible values: month, year
subscriber_idStringSubscriber id for fynd platform Seller/company owner
statusStringCurrent status of subscription. Possible values: pending, active, declined, no_renew, cancelled, frozen
metaObjectOpen dictionary containing any meta data regarding extension
billing_dateString/NullISODate string for next billing date of subscription (Null when in pending state)
current_period.start_dateString/NullISODate string for start date of current subscription billing cycle (Null when in pending state)
current_period.end_dateString/NullISODate string for end date of current subscription billing cycle (Null when in pending state)
created_atStringISODate subscription creation date
modified_atStringISODate subscription latest updation date
trial_daysIntegerNumber of trial days allowed in current subscription
extension_idStringExtension ID

Uninstall

Payload

{
"payload":{
"extension":{
"id":"628db357622e131c981647cf",
"name":"UnicommerceTest-2",
"base_url":"https://6098-13-126-128-230.ngrok.io",
"organization_id":"60afe92972b7a964de57a1d4",
"extension_type":"private"
},
"company":{
"id":1,
"name":"THE MANDHANA RETAIL VENTURES LIMITED ",
"email":"test@gofynd.com"
},
"uninstall_message":"not useful now",
"uninstalled_on":"2022-09-30T08:05:55.589Z"
},
"meta":{
"event":{
"name":"extension",
"type":"uninstall",
"version":"1"
},
"service":{
"name":"mixmaster"
},
"company_id":1,
"trace_id":[
"mixmaster.7d6f0c4f-1894-422c-85e9-a88702c6ae55"
],
"created_timestamp":1664525155628,
"created_on":"2022-09-30T08:05:55.628Z",
"extension_id":"628db357622e131c981647cf"
}
}

Description

Get notified when an extension is uninstalled.

Object Properties

KeyTypeDescription
_idStringSubscription ID on platform side
_idStringSubscription id
nameStringName of subscription plan
termStringPlan tagline
price.currency_codeStringSubscription amount currency ISO code
price.amountNumberSubscription amount to be deducted in each billing cycle
capped_amountNumberMax usage allowed under current extension charge
activated_onString/NullISODate string for subscription activation (Null when in pending state)
cancelled_onString/NullISODate string for subscription cancelled state (Null until moved to cancelled state)
is_testBooleanFlag to indicate charges are test charges
pricing_typeStringPricing type for current extension charge (It will be always `recurring` for subscription)
recurring.interval_timeIntegerSubscription each cycle period interval
recurring.intervalStringSubscription cycle type. Possible values: month, year
subscriber_idStringSubscriber id for fynd platform Seller/company owner
statusStringCurrent status of subscription. Possible values: pending, active, declined, no_renew, cancelled, frozen
metaObjectOpen dictionary containing any meta data regarding extension
billing_dateString/NullISODate string for next billing date of subscription (Null when in pending state)
current_period.start_dateString/NullISODate string for start date of current subscription billing cycle (Null when in pending state)
current_period.end_dateString/NullISODate string for end date of current subscription billing cycle (Null when in pending state)
created_atStringISODate subscription creation date
modified_atStringISODate subscription latest updation date
trial_daysIntegerNumber of trial days allowed in current subscription
extension_idStringExtension ID