Skip to main content
POST
/
portal
/
customer-session
/
customer-portal
{
  "accountId": "alguna-id",
  "accountAlias": "ext-39003209203023902",
  "planOverviewSettings": {
    "showSection": true,
    "allowSubscriptionCancel": true
  },
  "invoiceListSettings": {
    "showSection": true
  },
  "billingDetailsSettings": {
    "showSection": true
  }
}

{
  "sessionUrl": "https://openapi.alguna.site/hs/NWyfb389IdjI930..."
}
It’s important to note that a customer portal session requires an account to be created on your Alguna account. The customer portal can reference a given account either by accountId or an alias stored against the account. 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 e.g. your Salesforce ID if you connected your integration with Alguna) stored against the account. It could also be your internal account ID for the given customer that you use in your product. Required if no accountId is provided.
​
planOverviewSettings
object
Settings tied to displaying the Plan Overview section in the Customer Portal.The planOverviewSettings.showSection property allows you to show or hide the entire section for a specific account. Defaults to true.The planOverviewSettings.allowSubscriptionCancel property is used to allow or disallow canceling subscriptions. Defaults to true.
​
invoiceListSettings
object
Settings tied to displaying the Invoice List section in the Customer Portal.The invoiceListSettings.showSection property allows you to show or hide the invoice list section. Defaults to true.
​
billingDetailsSettings
object
Settings tied to displaying the Billing Details section in the Customer Portal.The billingDetailsSettings.showSection property allows you to show or hide the section. Defaults to true.
{
  "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..."
}
​
sessionUrl
string
The URL to which the user should be redirected to access the Customer Portal. A custom domain (e.g. using your own app domain) can be configured to mask the Alguna domain upon request.