Magidoc

CustomerPortal
Object

A brief explanation of the specific customer portal session.

Fields

#

billingInformation

CustomerPortalBillingInformation !
Non-null

The customers billing contact and payment method details.

billingPortalUrl

String

A link to the external billing portal.

canUpgradeSubscription

Boolean !
Non-null

Indicates whether the customer is allowed to upgrade their subscription.

configuration

CustomerPortalConfiguration

Optional configuration object for customizing how the customer portal behaves or appears

entitlements

[ Entitlement !]!
Non-null

All effective entitlements granted through the customers subscription.

promotionalEntitlements

[ CustomerPortalPromotionalEntitlement !]!
Non-null

A list of promotional entitlements granted directly to the customer. These provide bonus or trial access to features.

resource

CustomerResource

The ID of the resource that the portal session is scoped to.

showWatermark

Boolean !
Non-null

Indicates whether to show the Stigg watermark on the checkout widget.

subscriptions

[ CustomerPortalSubscription !]!
Non-null

List of the customers active subscriptions.

Usages

#

References

#

  • Field customerPortal from Query