Billing

Plans, prices, usage, credits, spending limits and invoices.

Base URL: https://api.fjordrun.com. Generated from the OpenAPI document (API version 0.1.0).

Plans and prices

GET /api/v1/pricing

Authentication: none.

Response

200: JSON.

Example

curl "https://api.fjordrun.com/api/v1/pricing"

Get team usage

GET /api/v1/teams/{tid}/usage

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
tid	path	string (UUID)	yes

Response

200: JSON.

Example

curl "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/usage" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Get billing settings and credit

GET /api/v1/teams/{tid}/billing

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
tid	path	string (UUID)	yes

Response

200: JSON.

Example

curl "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/billing" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Update spending limit and auto-recharge

PATCH /api/v1/teams/{tid}/billing

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
tid	path	string (UUID)	yes

Request body

Field	Type	Required	Description
usage_limit_eur	number	no	min 0, max 1000000, can be null
auto_recharge_enabled	boolean	no	can be null
auto_recharge_threshold_eur	integer	no	min 1, max 1000, can be null
auto_recharge_amount_eur	integer	no	min 10, max 500, can be null
auto_recharge_monthly_cap_eur	integer	no	min 10, max 5000, can be null

Response

200: JSON.

Example

curl -X PATCH "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/billing" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"usage_limit_eur":0}'

List credit transactions

GET /api/v1/teams/{tid}/billing/credits

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
tid	path	string (UUID)	yes
limit	query	integer	no	min 1, max 200, default 50
offset	query	integer	no	min 0, default 0

Response

200: JSON.

Example

curl "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/billing/credits" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Buy credit

POST /api/v1/teams/{tid}/billing/topup

Start a credit purchase: returns the Stripe Checkout URL. Credit is added by the webhook once paid.

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
tid	path	string (UUID)	yes
save_card	query	boolean	no	default false

Request body

Field	Type	Required	Description
amount_eur	integer	yes	min 5, max 1000
save_card	boolean	no	default false

Response

200: JSON.

Example

curl -X POST "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/billing/topup" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount_eur":5}'

Start a plan checkout

POST /api/v1/teams/{tid}/billing/checkout

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
tid	path	string (UUID)	yes

Request body

Field	Type	Required	Description
plan	"hobby", "pro"	yes

Response

200: JSON.

Example

curl -X POST "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/billing/checkout" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"plan":"hobby"}'

Open the billing portal

POST /api/v1/teams/{tid}/billing/portal

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
tid	path	string (UUID)	yes

Response

200: JSON.

Example

curl -X POST "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/billing/portal" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

List invoices

GET /api/v1/teams/{tid}/invoices

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
tid	path	string (UUID)	yes

Response

200: JSON.

Example

curl "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/invoices" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Request objects

BillingPatch

Only the fields sent are changed (usage_limit_eur: null removes the limit).

Field	Type	Required	Description
usage_limit_eur	number	no	min 0, max 1000000, can be null
auto_recharge_enabled	boolean	no	can be null
auto_recharge_threshold_eur	integer	no	min 1, max 1000, can be null
auto_recharge_amount_eur	integer	no	min 10, max 500, can be null
auto_recharge_monthly_cap_eur	integer	no	min 10, max 5000, can be null

CheckoutIn

Field	Type	Required	Description
plan	"hobby", "pro"	yes

TopupIn

Field	Type	Required	Description
amount_eur	integer	yes	min 5, max 1000
save_card	boolean	no	default false