@@ -1603,15 +1603,36 @@ interface UserCreatePortalSessionInput extends RequestOptions {
1603
1603
// The portal URL, this is the target URL on the portal site.
1604
1604
//
1605
1605
// If not defined the root URL for the portal will be used.
1606
+ //
1607
+ // This does not need to be the full URL, you have the option
1608
+ // of passing in a path instead (e.g. `/`).
1609
+ //
1610
+ // You also have the option of including the `{accountId}`
1611
+ // string in the path/URL which will be replaced with either the
1612
+ // UserHub user ID (if `organizationId` is not specified)
1613
+ // or the UserHub organization ID (if specified).
1614
+ //
1615
+ // Examples:
1616
+ // * `/{accountId}` - the billing dashboard
1617
+ // * `/{accountId}/plans` - select a plan to checkout
1618
+ // * `/{accountId}/checkout/<some-plan-id>` - checkout specified plan
1619
+ // * `/{accountId}/members` - manage organization members
1620
+ // * `/{accountId}/invite` - invite a user to an organization
1606
1621
portalUrl ?: string ;
1607
1622
// The URL the user should be sent to when they want to return to
1608
1623
// the app (e.g. cancel checkout).
1609
1624
//
1610
1625
// If not defined the app URL will be used.
1611
1626
returnUrl ?: string ;
1612
- // The URl the user should be sent after they successfully complete
1627
+ // The URL the user should be sent after they successfully complete
1613
1628
// an action (e.g. checkout).
1614
1629
//
1615
1630
// If not defined the return URL will be used.
1616
1631
successUrl ?: string ;
1632
+ // The organization ID.
1633
+ //
1634
+ // When specified the `{accountId}` in the `portalUrl` will be
1635
+ // replaced with the organization ID, otherwise the user ID
1636
+ // will be used.
1637
+ organizationId ?: string ;
1617
1638
}
0 commit comments