Skip to content
API docs
Sign inOpen app

Billing

Get billing

GET/v1/workspaces/{workspaceId}/billing

The workspace's plan, subscription and usage, and every plan it could move to with its price, limits and what it would stop. Any member or API key can read it.

Path parameters

  • workspaceIdstringrequired

    The workspace's id. An API key can only use its own workspace.

Response

  • modeenumrequired

    on when billing runs on this deployment.

    One of "off", "unconfigured", "on"

  • planenumrequired

    One of "business", "publishers", "agencies"

  • planNamestringrequired
  • freeone of 2required

    Set by staff, or null. A free workspace is never billed and has no checkout.

    Show 2 options

    • Option 1

      • planenum or nullrequired

        The plan it is free on. Null means no plan, with everything included.

      • meteringbooleanrequired

        False when checks are never charged.

    • null

  • statusenumrequired

    A suspended workspace's forms show "This form is currently inactive", and it can't publish.

    One of "trialing", "active", "suspended"

  • suspendedBecauseenum or nullrequired
  • trialEndsAtnumber or nullrequired

    When the trial ends, in milliseconds since the epoch. Set while trialing.

  • subscriptionone of 2required
    Show 2 options

    • Option 1

      • cancelAtPeriodEndbooleanrequired
      • currentPeriodEndnumber or nullrequired

        The renewal date, in milliseconds since the epoch.

      • intervalenumrequired

        One of "month", "year"

      • scheduledChangeone of 2required

        A change that waits for the period to end, such as yearly to monthly. Null when none is waiting.

        Show 2 options

        • Option 1

          • planenumrequired

            One of "business", "publishers", "agencies"

          • intervalenumrequired

            One of "month", "year"

          • atnumberrequired

        • null

    • null

  • yearlyAvailablebooleanrequired

    Plans can be paid yearly here, at priceYearly, billed once a year.

  • canManagebooleanrequired

    True when the caller is the owner, who alone can pay.

  • usageone of 2required

    Null for a member limited to some brands, since nothing is counted for them.

    Show 2 options

    • Option 1

      • formsnumberrequired
      • brandsnumberrequired
      • usersnumberrequired

    • null

  • plansarray of objectrequired

    Every plan.

    Show 10 fields
    • idenumrequired

      One of "business", "publishers", "agencies"

    • namestringrequired
    • priceMonthlynumberrequired
    • priceYearlynumberrequired
    • limitsobjectrequired
      Show 3 fields
      • formsnumber or nullrequired
      • brandsnumber or nullrequired
      • usersnumber or nullrequired
    • featuresarray of stringrequired
    • retentionDaysnumber or nullrequired
    • includedCreditsUsdnumberrequired

      Free credits each month for metered checks.

    • overarray of object or nullrequired

      What is over this plan's limits. A workspace can only buy a plan it fits. Null for a member limited to some brands.

    • stopsarray of object or nullrequired

      Checks that published forms run now and that would stop on this plan. The move is still allowed, and the forms skip the check and keep the lead. Null for a member limited to some brands.

  • suggestedPlanenum or nullrequired

    The cheapest plan that covers the workspace's usage. Null for a member limited to some brands.

Errors answer with a status and the error shape.