Operator

One organization's billing: subscription, invoices, Build Credits ledger, charges, usage

get/operator/billing/accounts/{organizationId}

Request

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

Path parameters

organizationIdstring uuid required

Response

Account

organizationIdstring uuid required
organizationNamestring required
planId'free' | 'pro' | 'business' required
subscriptionStatus'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused' | 'null' nullable required
interval'month' | 'year' | 'null' nullable required
currentPeriodEndstring nullable required

ISO-8601 timestamp

cancelAtPeriodEndboolean required
trialEndstring nullable required

ISO-8601 timestamp

dunningState'ok' | 'past_due' | 'restricted' required
pastDueSincestring nullable required

ISO-8601 timestamp

graceUntilstring nullable required

ISO-8601 timestamp

deploysBlockedAtstring nullable required

ISO-8601 timestamp

customerIdstring nullable required
livemodeboolean nullable required
mrrinteger required

USD list price per month of the current subscription, also for one billed in a local currency (0 on Free or while trialing)

openAmountinteger required

amount remaining on open invoices

Changes

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