Subscription

Get Agency extra accounts state and price

Return how many connected-account slots the workspace owner has: included with Agency, granted by posterly, and paid extra accounts, plus accounts in use, the current limit, the price per extra account for the base plan interval ($0.50 per month or $4.70 per year), the minimum purchase (20 at a time, no maximum), the lowest total allowed right now, and eligibility with a reason code. When an earlier purchase could not be charged (3D Secure or a declined card) payment_pending carries the Stripe-hosted payment link; no further change is accepted until it is paid or expires. Workspace owner only (403 workspace_owner_required for teammates, even with an owner-issued key). Requires the billing:read scope. Bypasses the API add-on paywall.

get/api/v1/subscription/extra-accounts

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/subscription/extra-accounts
  • Auth: HTTP bearer

Query parameters

workspace_idstring

Workspace to act in. Omit to use the API-key scoped workspace or your personal workspace. Required (400 workspace_id_required) when the key can act in several workspaces.

Response

Extra accounts state.

eligibleboolean required

True when the owner can buy or remove extra accounts right now.

codestring nullable

Why not eligible: agency_required, no_stripe_subscription, subscription_not_eligible, cancel_at_period_end, payment_pending, unsupported_interval, extra_accounts_not_configured.

reasonstring nullable
trialingboolean
interval'month' | 'year' nullable
included_accountsinteger

Accounts included with Agency (100).

admin_granted_accountsinteger
paid_extra_accountsinteger required
account_limitinteger required
accounts_in_useinteger required
highest_accounts_in_useinteger

Most connected accounts in any workspace the owner owns.

min_paid_extra_accountsinteger

The lowest total of paid extra accounts allowed right now.

min_purchaseinteger required

Every increase must add at least this many (20).

price_per_account_centsinteger nullable
price_per_accountstring nullable
recurring_centsinteger nullable

Recurring cost of the current paid extra accounts per interval.

Example response

{
  "eligible": true,
  "code": null,
  "reason": null,
  "trialing": false,
  "interval": "month",
  "included_accounts": 100,
  "admin_granted_accounts": 0,
  "paid_extra_accounts": 20,
  "account_limit": 120,
  "accounts_in_use": 96,
  "highest_accounts_in_use": 96,
  "min_paid_extra_accounts": 0,
  "min_purchase": 20,
  "price_per_account_cents": 50,
  "price_per_account": "$0.50",
  "recurring_cents": 1000,
  "payment_pending": null
}

Changes

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