Billing

Current plan, subscription, dunning state, caps and usage vs limits of an organization (billing:read)

get/billing

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/billing
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Query parameters

orgIdstring

Organization id (required when you belong to several)

lang'en' | 'sv'

Language of labels and Stripe pages (default en)

Response

Billing status

configuredboolean required

false: Stripe is not set up on this server — every team has the default plan and nothing can be bought

organizationIdstring uuid required
planSource'subscription' | 'default' | 'unlimited' | 'grant' required

grant: a plan given by Hostingsurge without payment (see grant) is the one that applies

currencystring required

the team's billing currency: its live subscription's currency (Build Credit packs are sold in it), otherwise the default (usd); a new subscription can choose any catalog currency

trialAvailableboolean required

the next subscription of this organization starts with a free trial

canManageboolean required

the caller may change the plan and open the Customer Portal (a dashboard session of an owner, admin or billing member)

Changes

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