billing

Get Billing Status

get/api/billing/status

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/billing/status
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Response

Successful Response

can_purchase_mailboxesboolean required

Whether this workspace may start another mailbox purchase.

discount_months_remaininginteger nullable required

Remaining billing months covered by the active discount.

discount_percentinteger nullable required

Whole-number active discount percentage.

has_payment_methodboolean required

Whether durable local subscription state indicates billing has been configured; this is not a live provider payment-method lookup.

has_workspace_subscriptionboolean required

Whether a workspace subscription exists.

mailbox_purchase_access_reason'billing_disabled' | 'operator_override' | 'workspace_subscription' | 'workspace_subscription_required' required
org_product_monthly_centsinteger required

Combined recurring product total in integer US cents.

plan_bundled_seatsinteger required

Connected accounts included by the current plan.

plan_credits_limitinteger required

Credits included in the current billing period.

plan_display_namestring nullable required

Current plan display name.

plan_tier'free' | 'legacy' | 'starter' | 'pro' | 'scale' nullable required

Legacy plan tier when it maps to the fixed plan catalog.

stripe_customer_idstring nullable required

Stripe customer identifier, when reconciled.

workspace_subscription_current_period_endstring nullable required

ISO-8601 end of the current workspace subscription period.

workspace_subscription_statusstring nullable required

Durable provider status for the selected workspace subscription.

Changes

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