The Customer portal configuration object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• activeboolean

  Whether the configuration is active and can be used to create portal sessions.

• applicationnullable stringExpandableConnect only

  ID of the Connect Application that created the configuration.

• business_profileobject

  The business information shown to customers in the portal.

  Hide child attributes

  • business_profile.headlinenullable string

    The messaging shown to customers in the portal.

  • business_profile.privacy_policy_urlnullable string

    A link to the business’s publicly available privacy policy.

  • business_profile.terms_of_service_urlnullable string

    A link to the business’s publicly available terms of service.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• default_return_urlnullable string

  The default URL to redirect customers to when they click on the portal’s link to return to your website. This can be overriden when creating the session.

• featuresobject

  Information about the features available in the portal.

  Hide child attributes

  • features.customer_updateobject

    Information about updating customer details in the portal.

    Hide child attributes

    • features.customer_update.allowed_updatesarray of enums

      The types of customer updates that are supported. When empty, customers are not updateable.

      Possible enum values

      address Allow updating billing addresses.

      email Allow updating email addresses.

      name Allow updating names.

      phone Allow updating phone numbers.

      shipping Allow updating shipping addresses.

      tax_id Allow updating tax IDs.

    • features.customer_update.enabledboolean

      Whether the feature is enabled.

  • features.invoice_historyobject

    Information about showing invoice history in the portal.

    Hide child attributes

    • features.invoice_history.enabledboolean

      Whether the feature is enabled.

  • features.payment_method_updateobject

    Information about updating payment methods in the portal. View the list of supported payment methods in the docs.

    Hide child attributes

    • features.payment_method_update.enabledboolean

      Whether the feature is enabled.

  • features.subscription_cancelobject

    Information about canceling subscriptions in the portal.

    Hide child attributes

    • features.subscription_cancel.cancellation_reasonobject

      Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer

      Hide child attributes

      • features.subscription_cancel.cancellation_reason.enabledboolean

        Whether the feature is enabled.

      • features.subscription_cancel.cancellation_reason.optionsarray of enums

        Which cancellation reasons will be given as options to the customer.

        Possible enum values

        customer_service Customer service was less than expected

        low_quality Quality was less than expected

        missing_features Some features are missing

        other Other reason

        switched_service I’m switching to a different service

        too_complex Ease of use was less than expected

        too_expensive It’s too expensive

        unused I don’t use the service enough

    • features.subscription_cancel.enabledboolean

      Whether the feature is enabled.

    • features.subscription_cancel.modeenum

      Whether to cancel subscriptions immediately or at the end of the billing period.

      Possible enum values

      at_period_end After canceling, customers can still renew subscriptions until the billing period ends.

      immediately Cancel subscriptions immediately.

    • features.subscription_cancel.proration_behaviorenum

      Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.

      Possible enum values

      always_invoice

      create_prorations

      none

  • features.subscription_updateobject

    Information about updating subscriptions in the portal.

    Hide child attributes

    • features.subscription_update.default_allowed_updatesarray of enums

      The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.

      Possible enum values

      price Allow switching to a different price.

      promotion_code Allow applying promotion codes to subscriptions.

      quantity Allow updating subscription quantities.

    • features.subscription_update.enabledboolean

      Whether the feature is enabled.

    • features.subscription_update.productsnullable array of objectsExpandable

      The list of up to 10 products that support subscription updates.

      Hide child attributes

      • features.subscription_update.products.pricesarray of strings

        The list of price IDs which, when subscribed to, a subscription can be updated.

      • features.subscription_update.products.productstring

        The product ID.

    • features.subscription_update.proration_behaviorenum

      Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don’t set it during creation.

      Possible enum values

      always_invoice

      create_prorations

      none

• is_defaultboolean

  Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• login_pageobject

  The hosted login page for this configuration. Learn more about the portal login page in our integration docs.

  Hide child attributes

  • login_page.enabledboolean

    If true, a shareable url will be generated that will take your customers to a hosted login page for the customer portal.

    If false, the previously generated url, if any, will be deactivated.

  • login_page.urlnullable string

    A shareable URL to the hosted portal login page. Your customers will be able to log in with their email and receive a link to their customer portal.

• metadatanullable object

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• updatedtimestamp

  Time at which the object was last updated. Measured in seconds since the Unix epoch.