---
title: "List portal configurations"
method: GET
path: "/v1/billing_portal/configurations"
---

# List portal configurations

`GET /v1/billing_portal/configurations`

Returns a list of configurations that describe the functionality of the customer portal.

## Query parameters

- `active` boolean
- `ending_before` string
- `expand` string[]
- `is_default` boolean
- `limit` integer
- `starting_after` string

## Response `200`

Successful response.

- object
  - `data` BillingPortalConfiguration[], required
    - `active` boolean, required — Whether the configuration is active and can be used to create portal sessions.
    - `application` union — ID of the Connect Application that created the configuration.
      - string
      - Application
        - `id` string, required — Unique identifier for the object.
        - `name` string, nullable — The name of the application.
        - `object` 'application', required — String representing the object's type. Objects of the same type share the same value.
      - DeletedApplication
        - `deleted` true, required — Always true for a deleted object
        - `id` string, required — Unique identifier for the object.
        - `name` string, nullable — The name of the application.
        - `object` 'application', required — String representing the object's type. Objects of the same type share the same value.
    - `business_profile` PortalBusinessProfile, required
      - `headline` string, nullable — The messaging shown to customers in the portal.
      - `privacy_policy_url` string, nullable — A link to the business’s publicly available privacy policy.
      - `terms_of_service_url` string, nullable — A link to the business’s publicly available terms of service.
    - `created` integer, required — 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/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
    - `features` PortalFeatures, required
      - `customer_update` PortalCustomerUpdate, required
        - `allowed_updates` string[], required — The types of customer updates that are supported. When empty, customers are not updateable.
        - `enabled` boolean, required — Whether the feature is enabled.
      - `invoice_history` PortalInvoiceList, required
        - `enabled` boolean, required — Whether the feature is enabled.
      - `payment_method_update` PortalPaymentMethodUpdate, required
        - `enabled` boolean, required — Whether the feature is enabled.
        - `payment_method_configuration` string, nullable — The [Payment Method Configuration](/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
      - `subscription_cancel` PortalSubscriptionCancel, required
        - `cancellation_reason` PortalSubscriptionCancellationReason, required
          - `enabled` boolean, required — Whether the feature is enabled.
          - `options` string[], required — Which cancellation reasons will be given as options to the customer.
        - `enabled` boolean, required — Whether the feature is enabled.
        - `mode` 'at_period_end' | 'immediately', required — Whether to cancel subscriptions immediately or at the end of the billing period.
        - `proration_behavior` 'always_invoice' | 'create_prorations' | 'none', required — Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.
      - `subscription_update` PortalSubscriptionUpdate, required
        - `billing_cycle_anchor` 'now' | 'unchanged', nullable — Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
        - `default_allowed_updates` string[], required — The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
        - `enabled` boolean, required — Whether the feature is enabled.
        - `products` PortalSubscriptionUpdateProduct[], nullable — The list of up to 10 products that support subscription updates.
          - `adjustable_quantity` PortalSubscriptionUpdateProductAdjustableQuantity, required
            - `enabled` boolean, required — If true, the quantity can be adjusted to any non-negative integer.
            - `maximum` integer, nullable — The maximum quantity that can be set for the product.
            - `minimum` integer, required — The minimum quantity that can be set for the product.
          - `prices` string[], required — The list of price IDs which, when subscribed to, a subscription can be updated.
          - `product` string, required — The product ID.
        - `proration_behavior` 'always_invoice' | 'create_prorations' | 'none', required — 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.
        - `schedule_at_period_end` PortalResourceScheduleUpdateAtPeriodEnd, required
          - `conditions` PortalResourceScheduleUpdateAtPeriodEndCondition[], required — List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
            - `type` 'decreasing_item_amount' | 'shortening_interval', required — The type of condition.
        - `trial_update_behavior` 'continue_trial' | 'end_trial', required — Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation.
    - `id` string, required — Unique identifier for the object.
    - `is_default` boolean, required — 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, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
    - `login_page` PortalLoginPage, required
      - `enabled` boolean, required — 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.
      - `url` string, nullable — A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal.
    - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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.
    - `object` 'billing_portal.configuration', required — String representing the object's type. Objects of the same type share the same value.
    - `updated` integer, required — Time at which the object was last updated. Measured in seconds since the Unix epoch.
  - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched.
  - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
  - `url` string, required — The URL where this list can be accessed.

## Other responses

- `default` — Error response.

---

[API](https://skmtc.net/stripe/apis/stripe-api.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api/versions/707de00b0616/schema)