Skip to main content

object

StatusResponse

LLM
View as Markdown
Open llms.txt

Current subscription state for the workspace.

Properties

  • Name
    status
    Type
    string
    Description
    Billing status. One of: unpaid, initializing, trial_pending, trialing, active, past_due, paused, incomplete, incomplete_expired, canceled.
  • Name
    active
    Type
    boolean
    Description
    Whether the subscription allows usage right now
  • Name
    plan
    Type
    string
    Description
    Current plan name
  • Name
    cancelAtPeriodEnd
    Type
    boolean
    Description
    True when the subscription is scheduled to cancel at the end of the current billing period. The subscription is still active until cancelAt; after that date it transitions to canceled.
  • Name
    cancelAt
    Type
    string
    Description
    When access ends if a cancellation is scheduled. Absent when the subscription is not scheduled to cancel.
  • Name
    trialEndsAt
    Type
    string
    Description
    When the trial ends and the first real charge is attempted. Only populated when status is "trialing"; absent otherwise.
  • Name
    paymentIssue
    Type
    boolean
    Description
    True when the subscription is in a state that indicates a payment problem (past_due, unpaid, incomplete, incomplete_expired). The UI should prompt the customer to update their payment method.
  • Name
    trialAvailable
    Type
    boolean
    Description
    Whether the self-service trial can still be started for this workspace.

Related operations