Skip to content

Commit eaee3a5

Browse files
committed
JE-66194 [Subscriptions: Upgrade] CS Docs update (add events)
1 parent 57c0156 commit eaee3a5

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

docs/creating-manifest/events.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1973,7 +1973,68 @@ onInstall:
19731973
}
19741974
```
19751975
@@!
1976+
1977+
### onBeforeMoveProduct
1978+
The event is executed before switching subscriptions (migrating a subscription item to a different service plan).
1979+
1980+
**Event Placeholders:**
1981+
1982+
- `${event.params.}`:
1983+
- `subscriptionid` - unique identifier of the source subscription
1984+
- `itemid` - unique identifier of the source subscription item
1985+
- `itemresourceid` - unique identifier of the source subscription item resource
1986+
- `itemresourceuniquename` - name of the source subscription item resource
1987+
- `serviceplanid` - unique identifier of the source service plan
1988+
- `productname` - name of the source subscription product
1989+
- `serviceplanname` - name of the source service plan
1990+
- `targetsubscriptionid` - unique identifier of the target subscription
1991+
- `targetitemid` - unique identifier of the target subscription item
1992+
- `targetserviceplanid` - unique identifier of the target service plan
1993+
- `targetproductname` - name of the target subscription product
1994+
- `targetserviceplanname` - name of the target service plan
1995+
- `${event.response.}`:
1996+
- `result` - result code. The successful action result is '0'
1997+
1998+
### onAfterMoveProduct
1999+
The event is executed after switching subscriptions (migrating a subscription item to a different service plan).
2000+
2001+
**Event Placeholders:**
2002+
2003+
- `${event.params.}`:
2004+
- `subscriptionid` - unique identifier of the source subscription
2005+
- `itemid` - unique identifier of the source subscription item
2006+
- `itemresourceid` - unique identifier of the source subscription item resource
2007+
- `itemresourceuniquename` - name of the source subscription item resource
2008+
- `serviceplanid` - unique identifier of the source service plan
2009+
- `productname` - name of the source subscription product
2010+
- `serviceplanname` - name of the source service plan
2011+
- `targetsubscriptionid` - unique identifier of the target subscription
2012+
- `targetitemid` - unique identifier of the target subscription item
2013+
- `targetserviceplanid` - unique identifier of the target service plan
2014+
- `targetproductname` - name of the target subscription product
2015+
- `targetserviceplanname` - name of the target service plan
2016+
- `${event.response.}`:
2017+
- `result` - result code. The successful action result is '0'
2018+
2019+
### onApplySubscriptionSettings
2020+
This event provides a possibility to execute actions required to adjust a subscription item after migration to a different service plan.
19762021

2022+
**Event Placeholders:**
2023+
2024+
- `${event.params.}`:
2025+
- `subscriptionId` - unique identifier of the source subscription
2026+
- `subscriptionItemId` - unique identifier of the source subscription item
2027+
- `subscriptionItemResourceId` - unique identifier of the source subscription item resource
2028+
- `servicePlanId` - unique identifier of the source service plan
2029+
- `appUniqueName` - name of the source subscription item resource
2030+
- `targetAppid` - unique identifier of the target application
2031+
- `settings` - JSON object with custom settings provided for subscription item adjustment
2032+
- `servicePlanData` - JSON object with target service plan data
2033+
- `overrideRegions` - defines whether to configure the service plan's regions differently from the user group's default ones (true) or not (false)
2034+
- `regionPricing` - JSON object with a list of available regions and custom pricing models for them
2035+
- `${event.response.}`:
2036+
- `result` - result code. The successful action result is '0'
2037+
19772038
<br>
19782039

19792040
<h2>What’s next?</h2>

0 commit comments

Comments
 (0)