Billing

Get plan and usage

Billed per connected account, the first 2 free. Only keys and people that reach every profile see it, since the plan counts every profile's accounts.

get/billing

Request

  • Base URL
    https://api.rizamo.com/v1
  • Auth
    HTTP bearer

Response

OK

status'free' | 'active' | 'past_due' | 'unpaid' | 'cancelling' required

free: up to 2 accounts, no card. active: a paid plan. past_due: a payment failed and Stripe retries it for up to 14 days; everything works. unpaid: still unpaid after 14 days, so accounts beyond 2 are paused until it is paid. cancelling: the plan ends at periodEnd, then the team is on the free plan.

interval'month' | 'year' nullable required

Monthly or yearly; null on the free plan.

periodEndstring date-time nullable required

When the period ends: the next renewal, or the end of a plan that is cancelling.

action'checkout' | 'pay' | 'update_card' | 'choose_accounts' nullable required

What a team owner must do in the web app, if anything. checkout: accounts wait for a paid plan to start, or more accounts are active than the free plan keeps (connected before billing was on), and the newest pause at the daily check (04:00 UTC) unless a plan starts. pay: an added account's charge needs the card holder (3-D Secure) or failed. update_card: a renewal failed. choose_accounts: the plan ended or went unpaid, and the owner may pick which 2 accounts stay active.

Changes

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