CustomerPortalSessionDto

Represents a customer portal session

created_atstringRequired

Date and time when the portal session was created

customer_idFlakeIdRequired

expires_atstringRequired

Date and time when the portal session expires

idFlakeIdRequired

store_idFlakeIdRequired

flowCustomerPortalSessionFlowDtoOptional

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

return_urlstringOptional

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

tokenstringOptional

The token used to access the portal session

urlstringOptional

The URL to redirect the customer to for this portal session

Example

{
  "created_at": "2024-01-01T00:00:00Z",
  "customer_id": "411486491630370816",
  "expires_at": "2024-01-01T00:00:00Z",
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "flow": {
    "subscription_cancel": {
      "subscription_id": "411486491630370816"
    },
    "subscription_payment_method_update": {
      "subscription_id": "411486491630370816"
    }
  },
  "token": "string",
  "url": "string",
  "return_url": "string"
}