BillingCustomerStripeCreateCustomerPortalSessionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingCustomerStripeCreateCustomerPortalSessionRequest",
  "title": "BillingCustomerStripeCreateCustomerPortalSessionRequest",
  "description": "Request to create a Stripe Customer Portal Session for the customer.\n\nUseful to redirect the customer to the Stripe Customer Portal to manage their payment methods,\nchange their billing address and access their invoice history.\nOnly returns URL if the customer billing profile is linked to a stripe app and customer.",
  "type": "object",
  "properties": {
    "stripe_options": {
      "description": "Options for configuring the Stripe Customer Portal Session.",
      "type": "object",
      "properties": {
        "configuration_id": {
          "description": "The ID of an existing [Stripe configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session,\ndescribing its functionality and features.\nIf not specified, the session uses the default configuration.",
          "type": "string"
        },
        "locale": {
          "description": "The IETF [language tag](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-locale) of the locale customer portal is displayed in.\nIf blank or `auto`, the customer's preferred_locales or browser's locale is used.",
          "type": "string"
        },
        "return_url": {
          "description": "The [URL to redirect](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) the customer to after they have completed\ntheir requested actions.",
          "type": "string"
        }
      }
    }
  },
  "required": [
    "stripe_options"
  ]
}