Billing

Get billing summary

Current plan, entitlements, seat and document usage, and the available upgrade prices. Readable by any workspace member so the UI can show why an action was blocked; only the owner can change anything.

get/v1/billing

Request

  • Base URL: https://api.signvoy.com
  • URL: https://api.signvoy.com/v1/billing
  • Auth: one of:
    • API key in header X-Workspace-Id
    • HTTP bearer

Response

Billing summary

plan'free' | 'pro' | 'team' | 'enterprise' required

Plan on the subscription, i.e. what the account pays for

effectivePlan'free' | 'pro' | 'team' | 'enterprise' required

Plan actually in force. Differs from plan only when the subscription has lapsed, in which case entitlements fall back to Free.

statusstring nullable

Stripe subscription status; null on an account that never paid

interval'month' | 'year' nullable

Billing interval; null on Free

cancelAtPeriodEndboolean required

Whether the subscription stops at the end of the period

currentPeriodEndstring date-time nullable

End of the current billing period; null on Free

hasBillingHistoryboolean required

Whether this account has ever reached checkout, and therefore whether the Customer Portal has invoices and a payment method to show

extraSeatMonthlyUsdnumber required

Price per extra seat per month, in USD

extraSeatAnnualUsdnumber required

Price per extra seat per month when billed annually, in USD

Example response

{
  "plan": "pro",
  "effectivePlan": "pro",
  "status": "active",
  "interval": "month",
  "seats": {
    "included": 3,
    "purchased": 1,
    "allowed": 4,
    "used": 4
  },
  "documents": {
    "sent": 7,
    "limit": 10
  },
  "workspaces": {
    "count": 1,
    "limit": 1
  },
  "extraSeatMonthlyUsd": 8,
  "extraSeatAnnualUsd": 6,
  "availablePlans": [
    {
      "plan": "pro",
      "monthlyUsd": 10,
      "annualMonthlyUsd": 8,
      "includedSeats": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.