--- title: "Get Billing Status" method: GET path: "/api/billing/status" tags: ["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: one of: - HTTP bearer and API key in header `x-flage-org-id` - HTTP bearer and API key in header `x-flage-org-slug` ## Response `200` Successful Response - BillingStatusResponse - `account_subscriptions` BillingSubscription[], required: Durable account-level billing subscriptions. - `channel` string, nullable, required: Sender channel associated with the subscription, when recorded. - `sender_account_id` string, nullable, required: Sender account billed by the subscription, when still available. - `status` string, required: Durable provider subscription status, including local canceling state. - `stripe_subscription_id` string, required: Stripe subscription identifier. - `subscription_type` 'account', required: Account-level subscription category returned in this collection. - `available_plans` PlanSummary[], required: Revision-backed plans the workspace can currently choose. - `account_overage_mode` 'metered' | 'blocked', nullable, required: How additional accounts are handled, when fixed. - `action` 'checkout' | 'review_change' | 'current' | 'contact' | 'unavailable', required: Server-authorized next action for this plan. - `connected_accounts` integer, nullable, required: Connected accounts included, or null for contact-only terms. - `credit_overage_mode` 'metered' | 'blocked', nullable, required: How credit overage is handled, when fixed. - `credit_overage_price_microusd` integer, nullable, required: Price per overage credit in millionths of a US dollar, when fixed. - `display_name` string, required: Customer-facing plan name. - `family_key` string, required: Stable plan family identifier across revisions. - `monthly_credits` integer, nullable, required: Credits included each period, or null for contact-only terms. - `offer_schedule` union, required: Recurring and optional introductory terms. - RecurringOfferScheduleSummary - `introductory` unknown, required - `introductory_billing_periods` unknown, required - `kind` 'recurring', required: Recurring commercial schedule. - `ongoing` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - IntroductoryOfferScheduleSummary - `introductory` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - `introductory_billing_periods` 1, required: Billing periods covered by the introductory terms. - `kind` 'introductory', required: Time-bounded introductory schedule. - `ongoing` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - `plan_revision_id` string, nullable, required: Immutable plan revision identifier, absent for contact-only offers. - `price` PlanPrice, required - `kind` 'exact' | 'from', required: Whether this is the exact monthly price or a public starting price. - `monthly_cents` integer, required: Monthly plan price in integer US cents. - `relationship` 'available' | 'current' | 'replacement', required: Relationship between this plan and the workspace. - `subtitle` string, nullable, required: Optional customer-facing plan detail. - `can_purchase_mailboxes` boolean, required: Whether this workspace may start another mailbox purchase. - `current_plan` PlanSummary, required - `account_overage_mode` 'metered' | 'blocked', nullable, required: How additional accounts are handled, when fixed. - `action` 'checkout' | 'review_change' | 'current' | 'contact' | 'unavailable', required: Server-authorized next action for this plan. - `connected_accounts` integer, nullable, required: Connected accounts included, or null for contact-only terms. - `credit_overage_mode` 'metered' | 'blocked', nullable, required: How credit overage is handled, when fixed. - `credit_overage_price_microusd` integer, nullable, required: Price per overage credit in millionths of a US dollar, when fixed. - `display_name` string, required: Customer-facing plan name. - `family_key` string, required: Stable plan family identifier across revisions. - `monthly_credits` integer, nullable, required: Credits included each period, or null for contact-only terms. - `offer_schedule` union, required: Recurring and optional introductory terms. - RecurringOfferScheduleSummary - `introductory` unknown, required - `introductory_billing_periods` unknown, required - `kind` 'recurring', required: Recurring commercial schedule. - `ongoing` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - IntroductoryOfferScheduleSummary - `introductory` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - `introductory_billing_periods` 1, required: Billing periods covered by the introductory terms. - `kind` 'introductory', required: Time-bounded introductory schedule. - `ongoing` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - `plan_revision_id` string, nullable, required: Immutable plan revision identifier, absent for contact-only offers. - `price` PlanPrice, required - `kind` 'exact' | 'from', required: Whether this is the exact monthly price or a public starting price. - `monthly_cents` integer, required: Monthly plan price in integer US cents. - `relationship` 'available' | 'current' | 'replacement', required: Relationship between this plan and the workspace. - `subtitle` string, nullable, required: Optional customer-facing plan detail. - `discount_months_remaining` integer, nullable, required: Remaining billing months covered by the active discount. - `discount_percent` integer, nullable, required: Whole-number active discount percentage. - `has_payment_method` boolean, required: Whether durable local subscription state indicates billing has been configured; this is not a live provider payment-method lookup. - `has_workspace_subscription` boolean, required: Whether a workspace subscription exists. - `mailbox_purchase_access_reason` 'billing_disabled' | 'operator_override' | 'workspace_subscription' | 'workspace_subscription_required', required - `one_time_charges` OneTimeCharge[], required: Recent one-time workspace charges. - `amount_cents` integer, required: Charge amount in integer US cents. - `charged_at` string, required: ISO-8601 time when the local charge record was created. - `description` string, required: Customer-facing description of the one-time charge. - `invoice_url` string, nullable, required: Hosted Stripe invoice URL after reconciliation, when available. - `status` 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' | 'unknown', required: Durable invoice status, or unknown before invoice reconciliation. - `stripe_invoice_id` string, nullable, required: Stripe invoice identifier after reconciliation, when available. - `org_product_line_items` OrgProductLineItem[], required: Current recurring connected-account product lines. - `account_identifiers` string[], required: Sanitized account identifiers represented by this product line. - `display_name` string, required: Customer-facing product name. - `line_total_cents` integer, required: Monthly product total after included-account absorption, in integer US cents. - `product_kind` 'oauth_mailbox' | 'purchased_mailbox' | 'linkedin_account', required: Recurring workspace product category. - `quantity` integer, required: Active connected accounts in this product category. - `unit_amount_cents` integer, required: Monthly unit price in integer US cents. - `org_product_monthly_cents` integer, required: Combined recurring product total in integer US cents. - `plan_bundled_seats` integer, required: Connected accounts included by the current plan. - `plan_credits_limit` integer, required: Credits included in the current billing period. - `plan_display_name` string, 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. - `purchasable_plans` PlanCatalogEntry[], required: Fixed public plans available for checkout. - `bundled_seats` integer, required: Connected accounts included by the plan. - `credits_limit` integer, required: Credits included in each billing period. - `display_name` string, required: Customer-facing plan name. - `plan_tier` 'starter' | 'pro' | 'scale', required: Stable purchasable plan tier. - `price_cents` integer, required: Monthly plan price in integer US cents. - `replacement_plan` PlanSummary, required - `account_overage_mode` 'metered' | 'blocked', nullable, required: How additional accounts are handled, when fixed. - `action` 'checkout' | 'review_change' | 'current' | 'contact' | 'unavailable', required: Server-authorized next action for this plan. - `connected_accounts` integer, nullable, required: Connected accounts included, or null for contact-only terms. - `credit_overage_mode` 'metered' | 'blocked', nullable, required: How credit overage is handled, when fixed. - `credit_overage_price_microusd` integer, nullable, required: Price per overage credit in millionths of a US dollar, when fixed. - `display_name` string, required: Customer-facing plan name. - `family_key` string, required: Stable plan family identifier across revisions. - `monthly_credits` integer, nullable, required: Credits included each period, or null for contact-only terms. - `offer_schedule` union, required: Recurring and optional introductory terms. - RecurringOfferScheduleSummary - `introductory` unknown, required - `introductory_billing_periods` unknown, required - `kind` 'recurring', required: Recurring commercial schedule. - `ongoing` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - IntroductoryOfferScheduleSummary - `introductory` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - `introductory_billing_periods` 1, required: Billing periods covered by the introductory terms. - `kind` 'introductory', required: Time-bounded introductory schedule. - `ongoing` PlanPhaseTerms, required - `account_overage_mode` 'metered' | 'blocked', required: How additional connected accounts are handled. - `connected_accounts` integer, required: Connected accounts included in this phase. - `credit_overage_mode` 'metered', required: How credits above the included amount are handled. - `credit_overage_price_microusd` integer, required: Price of one overage credit in millionths of a US dollar. - `monthly_credits` integer, required: Credits included during this phase. - `monthly_price_cents` integer, required: Phase price in integer US cents. - `plan_revision_id` string, nullable, required: Immutable plan revision identifier, absent for contact-only offers. - `price` PlanPrice, required - `kind` 'exact' | 'from', required: Whether this is the exact monthly price or a public starting price. - `monthly_cents` integer, required: Monthly plan price in integer US cents. - `relationship` 'available' | 'current' | 'replacement', required: Relationship between this plan and the workspace. - `subtitle` string, nullable, required: Optional customer-facing plan detail. - `seat_quotes` ProductSeatQuote[], required: Current marginal connected-account prices. - `active_count` integer, required: Current active accounts for this product. - `free_quota` integer, required: Plan accounts available to this product after bundle absorption. - `next_seat_free` boolean, required: Whether one more account stays inside the plan bundle. - `price_cents` integer, required: Monthly price of one chargeable account in US cents. - `product_kind` 'oauth_mailbox' | 'linkedin_account', required: Connected-account product being quoted. - `stripe_customer_id` string, nullable, required: Stripe customer identifier, when reconciled. - `workspace_subscription_current_period_end` string, nullable, required: ISO-8601 end of the current workspace subscription period. - `workspace_subscription_status` string, nullable, required: Durable provider status for the selected workspace subscription. --- [API](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract.md) - [All operations](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract/llms.txt) - [OpenAPI document](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract/revisions/c80e903ef8f3?raw)