The Customer Portal Session object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• configurationstringExpandable

  The configuration used by this session, describing the features available.

• createdtimestamp

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

• customerstring

  The ID of the customer for this session.

• flownullable object

  Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows.

  Hide child attributes

  • flow.after_completionobject

    Behavior after the flow is completed.

    Hide child attributes

    • flow.after_completion.hosted_confirmationnullable object

      Configuration when after_completion.type=hosted_confirmation.

      Hide child attributes

      • flow.after_completion.hosted_confirmation.custom_messagenullable string

        A custom message to display to the customer after the flow is completed.

    • flow.after_completion.redirectnullable object

      Configuration when after_completion.type=redirect.

      Hide child attributes

      • flow.after_completion.redirect.return_urlstring

        The URL the customer will be redirected to after the flow is completed.

    • flow.after_completion.typeenum

      The specified type of behavior after the flow is completed.

      Possible enum values

      hosted_confirmation Displays a confirmation message on the hosted surface after the flow is complete

      portal_homepage Redirects to the portal homepage after the flow is complete.

      redirect Redirects the customer to the specified redirect.return_url after the flow is complete.

  • flow.subscription_cancelnullable object

    Configuration when flow.type=subscription_cancel.

    Hide child attributes

    • flow.subscription_cancel.retentionnullable object

      Specify a retention strategy to be used in the cancellation flow.

      Hide child attributes

      • flow.subscription_cancel.retention.coupon_offernullable object

        Configuration when retention.type=coupon_offer.

        Hide child attributes

        • flow.subscription_cancel.retention.coupon_offer.couponstring

          The ID of the coupon to be offered.

      • flow.subscription_cancel.retention.typeenum

        Type of retention strategy that will be used.

        Possible enum values

        coupon_offer Offer customers a coupon as a retention strategy.

    • flow.subscription_cancel.subscriptionstring

      The ID of the subscription to be canceled.

  • flow.subscription_updatenullable object

    Configuration when flow.type=subscription_update.

    Hide child attributes

    • flow.subscription_update.subscriptionstring

      The ID of the subscription to be updated.

  • flow.subscription_update_confirmnullable object

    Configuration when flow.type=subscription_update_confirm.

    Hide child attributes

    • flow.subscription_update_confirm.discountsnullable array of objects

      The coupon or promotion code to apply to this subscription update.

      Hide child attributes

      • flow.subscription_update_confirm.discounts.couponnullable string

        The ID of the coupon to apply to this subscription update.

      • flow.subscription_update_confirm.discounts.promotion_codenullable string

        The ID of a promotion code to apply to this subscription update.

    • flow.subscription_update_confirm.itemsarray of objects

      The subscription item to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.

      Hide child attributes

      • flow.subscription_update_confirm.items.idnullable string

        The ID of the subscription item to be updated.

      • flow.subscription_update_confirm.items.pricenullable string

        The price the customer should subscribe to through this flow. The price must also be included in the configuration’s features.subscription_update.products.

      • flow.subscription_update_confirm.items.quantitynullable integer

        Quantity for this item that the customer should subscribe to through this flow.

    • flow.subscription_update_confirm.subscriptionstring

      The ID of the subscription to be updated.

  • flow.typeenum

    Type of flow that the customer will go through.

    Possible enum values

    payment_method_update Customer will be able to add a new payment method. The payment method will be set as the customer.invoice_settings.default_payment_method.

    subscription_cancel Customer will be able to cancel their subscription.

    subscription_update Customer will be able to select prices to update to based on the configuration’s features.subscription_update.

    subscription_update_confirm Customer will be able to confirm a specified subscription update.

• livemodeboolean

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

• localenullable enum

  The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.

• on_behalf_ofnullable stringConnect only

  The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account’s branding settings, which the portal displays.

• return_urlnullable string

  The URL to redirect customers to when they click on the portal’s link to return to your website.

• urlstring

  The short-lived URL of the session that gives customers access to the customer portal.