# The Customer portal configuration object

### The Customer portal configuration object

```json
{
  "id": "bpc_1MrnZsLkdIwHu7ixNiQL1xPM",
  "object": "billing_portal.configuration",
  "active": true,
  "application": null,
  "business_profile": {
    "headline": null,
    "privacy_policy_url": null,
    "terms_of_service_url": null
  },
  "created": 1680290736,
  "default_return_url": null,
  "features": {
    "customer_update": {
      "allowed_updates": [
        "email",
        "tax_id"
      ],
      "enabled": true
    },
    "invoice_history": {
      "enabled": true
    },
    "payment_method_update": {
      "enabled": false
    },
    "subscription_cancel": {
      "cancellation_reason": {
        "enabled": false,
        "options": [
          "too_expensive",
          "missing_features",
          "switched_service",
          "unused",
          "other"
        ]
      },
      "enabled": false,
      "mode": "at_period_end",
      "proration_behavior": "none"
    },
    "subscription_update": {
      "default_allowed_updates": [],
      "enabled": false,
      "proration_behavior": "none"
    }
  },
  "is_default": false,
  "livemode": false,
  "login_page": {
    "enabled": false,
    "url": null
  },
  "metadata": {},
  "updated": 1680290736
}
```

## Attributes

- `id` (string)
  Unique identifier for the object.

- `object` (string)
  String representing the object’s type. Objects of the same type share the same value.

- `active` (boolean)
  Whether the configuration is active and can be used to create portal sessions.

- `application` (string, nullable, expandable (can be expanded into an object with the `expand` request parameter))
  ID of the Connect Application that created the configuration.

- [`business_profile`](https://docs.stripe.com/api/customer_portal/configurations/object.md?query=business_profile) (object)
  The business information shown to customers in the portal.

- `created` (timestamp)
  Time at which the object was created. Measured in seconds since the Unix epoch.

- `default_return_url` (string, nullable)
  The default URL to redirect customers to when they click on the portal’s link to return to your website. This can be [overridden](https://docs.stripe.com/docs/api/customer_portal/sessions/create.md#create_portal_session-return_url) when creating the session.

- [`features`](https://docs.stripe.com/api/customer_portal/configurations/object.md?query=features) (object)
  Information about the features available in the portal.

- `is_default` (boolean)
  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.

- `livemode` (boolean)
  If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.

- [`login_page`](https://docs.stripe.com/api/customer_portal/configurations/object.md?query=login_page) (object)
  The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://docs.stripe.com/billing/subscriptions/integrating-customer-portal.md#share).

- `metadata` (map, nullable)
  Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata.md) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

- `name` (string, nullable)
  The name of the configuration.

- `updated` (timestamp)
  Time at which the object was last updated. Measured in seconds since the Unix epoch.