CreateCustomerPortalSessionRequestDto

Request to create a new customer portal session from your back-end server using the management API

flowCustomerPortalSessionFlowDtoRequired

The flow a customer portal session is scoped to. At most one of the flows is set.

subscription_cancelSubscriptionCancelFlowDtoOptional

Portal flow for cancelling a specific subscription

subscription_idFlakeIdRequired

subscription_payment_method_updateSubscriptionPaymentMethodUpdateFlowDtoOptional

Portal flow for updating the payment method of a specific subscription

subscription_idFlakeIdRequired

expires_in_secondsintegerOptional

How long the portal session stays valid, in seconds. When unset, a default expiry is used.

return_urlstringOptional

URL to redirect the customer back to after completing the portal flow

Example

{
  "flow": {
    "subscription_cancel": {
      "subscription_id": "411486491630370816"
    },
    "subscription_payment_method_update": {
      "subscription_id": "411486491630370816"
    }
  },
  "expires_in_seconds": 0,
  "return_url": "string"
}