CustomerPortal

A Stripe customer portal session.

  • createdAt
    Type: stringFormat: date-time
    required

    When the session was created.

  • customerId
    Type: string
    required

    The customer (cus_…).

  • expiresAt
    Type: stringFormat: date-time
    required

    When the link stops working.

  • id
    Type: string
    required

    Stripe's ID for the portal session (bps_…).

  • returnUrl
    Type: string | null
    required

    The returnUrl you gave, or null.

  • status
    enum
    const:  
    active
    required

    The session is ready to use.

  • url
    Type: stringFormat: uri
    required

    The link to send your customer to.

Previous
CustomerPortalInput
Next
CustomerState