SHshorebird
billing

Get the signed-in user's plan.

The plan the signed-in user's own account is on, with that account's install credit and overage limit applied. Read from a cache that can trail a subscription change by a few minutes; DELETE /users/me/plan-cache drops it. Service accounts are refused with a 403 (service_account_forbidden).

get/plan

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Response

The user's plan.

namestring required

The plan's display name.

currencystring required

The ISO 4217 code of the plan's currency (e.g. usd).

base_priceinteger required

The list price per billing period, in minor units of currency (e.g. cents), whatever the installs used. Does not reflect coupons or discounts.

base_install_countinteger required

The patch installs included in the base price each billing period.

patch_install_creditinteger required

Extra patch installs granted to the account's owner on top of base_install_count, such as promotional or support credit. 0 when there is none.

patch_overage_limitinteger nullable required

The most installs past the allotment the owner has agreed to pay for each overage period: their spending limit, in installs. Null when the owner has set no limit.

price_per_overage_installstring nullable required

The price of each install past the allotment, in minor units of currency, as a decimal number in a string because it can be fractional (e.g. "0.1"). Null when the plan has no overage billing.

current_period_startstring date-time required

The start of the current billing period. The start of the current month on the Hobby plan.

current_period_endstring date-time required

The end of the current billing period. The start of the next month on the Hobby plan.

cancel_at_period_endboolean required

Whether the subscription is set to end at the end of the current billing period.

is_tieredboolean required

Whether the plan is one of the standard tiers an account can switch between.

is_trialboolean required

Whether the account is on a trial, which is not billed and ends on its own.

base_standingstring required

The payment standing of the subscription carrying the plan: none (no subscription), trialing, active, or past_due. past_due keeps the plan in force while Stripe retries the payment; prompt for a working payment method.

overage_standingstring required

The payment standing of the subscription carrying the overage price, in the same terms as base_standing plus unpaid (every retry failed and only paying the invoice resumes overage). Equal to base_standing when overage bills on the base subscription; independent when an annual plan bills overage on its own monthly subscription. none when the plan has no overage billing.

overage_statestring required

Whether installs past the allotment are served, and on what terms: unavailable (the plan has no overage billing), off (the limit is 0), blocked (a payment is overdue; see overage_blocked_by), capped (up to patch_overage_limit each overage period), or unlimited.

overage_blocked_bystring nullable required

Which overdue payment holds overage back while overage_state is blocked: base_past_due, overage_past_due, or overage_unpaid. Null otherwise.

overage_period_startstring date-time nullable required

The start of the period overage is capped and invoiced over: the billing period for a monthly plan, the overage subscription's own month for an annual one. Null when the plan has no overage billing.

overage_period_endstring date-time nullable required

The end of the period overage is capped and invoiced over. Null when the plan has no overage billing.

featuresstring[] required

The features the plan enables. Current values: collaboration, historicalInsights, audienceAnalytics, customTokenExpiration, auditLogs, sizeAnalysis, oidcFederation.

levelstring required

The plan's tier: free, pro, business, or enterprise.

minimum_releases_keptinteger nullable required

How many of an app's releases are kept however long they sit unused. Null when releases are never retired.

max_team_sizeinteger nullable required

The most members an account may have: 1 on plans without collaboration, null when there is no limit.

available_rolesRole[] required

The roles that may be given to members on this plan.

billing_intervalstring nullable required

The unit the subscription bills on: day, week, month, or year. Null without a subscription.

billing_interval_countinteger nullable required

How many billing_intervals make one billing period. Null without a subscription.

subscriber_sincestring date-time nullable required

When the subscription started; unchanged by renewals and plan changes. Null without a subscription.

Changes

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