Kong · Schema

BillingAppStripeCreateCustomerPortalSessionResult

Result of creating a [Stripe Customer Portal Session](https://docs.stripe.com/api/customer_portal/sessions/object). Contains all the information needed to redirect the customer to the Stripe Customer Portal.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name	Type	Description
id	string	The ID of the customer portal session. See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id
stripe_customer_id	string	The ID of the stripe customer.
configuration_id	string	Configuration used to customize the customer portal. See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration
livemode	boolean	Livemode. See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode
created_at	string	Created at. See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-created
return_url	string	Return URL. See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url
locale	string	The IETF language tag of the locale customer portal is displayed in. See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale
url	string	The URL to redirect the customer to after they have completed their requested actions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingAppStripeCreateCustomerPortalSessionResult",
  "title": "BillingAppStripeCreateCustomerPortalSessionResult",
  "description": "Result of creating a [Stripe Customer Portal Session](https://docs.stripe.com/api/customer_portal/sessions/object).\n\nContains all the information needed to redirect the customer to the Stripe Customer Portal.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The ID of the customer portal session.\n\nSee: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id",
      "type": "string"
    },
    "stripe_customer_id": {
      "description": "The ID of the stripe customer.",
      "type": "string"
    },
    "configuration_id": {
      "description": "Configuration used to customize the customer portal.\n\nSee: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration",
      "type": "string"
    },
    "livemode": {
      "description": "Livemode.\n\nSee: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode",
      "type": "boolean"
    },
    "created_at": {
      "description": "Created at.\n\nSee: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-created",
      "type": "string",
      "format": "date-time",
      "example": "2023-01-01T01:01:01.001Z",
      "title": "RFC3339 Date-Time"
    },
    "return_url": {
      "description": "Return URL.\n\nSee: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url",
      "type": "string"
    },
    "locale": {
      "description": "The IETF language tag of the locale customer portal is displayed in.\n\nSee: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale",
      "type": "string"
    },
    "url": {
      "description": "The URL to redirect the customer to after they have completed\ntheir requested actions.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "stripe_customer_id",
    "configuration_id",
    "livemode",
    "created_at",
    "return_url",
    "locale",
    "url"
  ]
}