POST
/
accounts
/
{id}
/
portal-session
{
  "accountId": "alguna-id",
  "accountAlias": "ext-39003209203023902",
  "planOverviewSettings": {
    "showSection": true,
    "allowSubscriptionCancel": true
  },
  "invoiceListSettings": {
    "showSection": true
  },
  "billingDetailsSettings": {
    "showSection": true
  }
}

{
  "sessionUrl": "https://openapi.alguna.site/hs/NWyfb389IdjI930..."
}
The request body must include at least one of accountId or accountAlias. Additionally, you can optionally provide settings for displaying various sections in the Customer Portal.
​
accountId
string
The account id as seen in your Alguna dashboard. Required if no accountAlias is provided.
​
accountAlias
string
The alias (external id) stored against the account. It could be your internal account ID. Required if no accountId is provided.
​
planOverviewSettings
object
Settings tied to displaying the Plan Overview section in the Customer Portal. The planOverviewSettings object allows you to show or hide the entire section for a specific account by passing the planOverviewSettings.showSection property.
​
allowSubscriptionCancel
boolean
Settings tied to allowing the Subscriptions Cancellations section in the Customer Portal.
​
invoiceListSettings
object
Settings tied to displaying the Invoice List section in the Customer Portal. This section is visible by default.
​
billingDetailsSettings
object
Settings tied to displaying the Billing Details section in the Customer Portal. This section is visible by default.
{
  "accountId": "alguna-id",
  "accountAlias": "ext-39003209203023902",
  "planOverviewSettings": {
    "showSection": true,
    "allowSubscriptionCancel": true
  },
  "invoiceListSettings": {
    "showSection": true
  },
  "billingDetailsSettings": {
    "showSection": true
  }
}

​
Response

{
  "sessionUrl": "https://openapi.alguna.site/hs/NWyfb389IdjI930..."
}
Upon a successful request, you will receive a response containing a sessionUrl which is the URL to which the user should be redirected to access the Customer Portal.