API reference

Every operation, generated from the OpenAPI document, which you can also download. Platform operations live on https://microauth.com and authenticate with a workspace API key. SDK operations live on https://api.microauth.com and use the SDK secret key. Guides for both are in Platform API and Any language (HTTP).

Each operation shows its authentication:

• Workspace API key or dashboard session: callable from scripts.
• Dashboard session: only from the signed in dashboard, for actions that need a person.
• SDK secret key: your API's server, through the SDK or your own code.
• None: public, mostly sign up and sign in.

APIs

Launch APIs and manage their settings, SDK secret, test key and custom domain.

GET List APIs

/api/v1/workspaces/{wid}/apis

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Response 200

OK

Example request

curl "https://microauth.com/api/v1/workspaces/{wid}/apis" \
  -H "Authorization: Bearer mak_..."

Example response

[
  {
    "created_at": "2026-10-11T12:00:00Z",
    "customers": 0,
    "id": "string",
    "logo_url": "string",
    "month_requests": 0,
    "name": "string",
    "plan_code": "string",
    "portal_url": "string",
    "sdk_last_seen_at": "2026-10-11T12:00:00Z",
    "slug": "string",
    "status": "string"
  }
]

POST Launch an API

/api/v1/workspaces/{wid}/apis

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Request body

api_base_url	string	Up to 300 characters.
namerequired	string	Up to 80 characters.
presetrequired	string	Starting pricing, change it any time. One of payg, free, subscriptions. Defaults to "payg".
slug	string	Portal address, <slug>.microauth.dev. Generated from the name when empty. Up to 40 characters.

Response 201

api	object
api.accent_color	string
api.api_base_url	string	Where your API runs, shown in the portal quickstart.
api.auto_recharge_allowed	boolean
api.billable_status_codes	array of integers or null
api.created_at	string (date-time)
api.docs_url	string
api.domain	object
api.domain.allowed	boolean	The API's plan includes custom domains.
api.domain.checked_at	string (date-time)
api.domain.cname_target	string	Point the domain here with a CNAME record.
api.domain.domain	string
api.domain.error	string
api.domain.status	string	One of none, pending, verified, active, failed.
api.domain.txt_name	string
api.domain.txt_value	string
api.first_usage_at	string (date-time)
api.id	string
api.key_header	string	Header customers send their key in.
api.logo_url	string
api.low_balance_micro	integer
api.min_topup_cents	integer
api.monthly_quota	integer	Requests per month per customer, 0 for no limit.
api.name	string
api.payg_enabled	boolean	Customers can buy prepaid credit.
api.plan	object
api.plan.code	string
api.plan.custom_domain	boolean
api.plan.max_customers	integer
api.plan.monthly_requests	integer
api.plan.name	string
api.plan.price_monthly_cents	integer
api.plan.purchasable	boolean	True when checkout is available for this plan.
api.plan.remove_branding	boolean
api.plan.teams	boolean
api.plan_grace_until	string (date-time)
api.plan_period_end	string (date-time)
api.plan_status	string	One of active, past_due, canceled.
api.plans_enabled	boolean	Customers can subscribe to public plans.
api.portal_url	string
api.previous_secret_valid_until	string (date-time)
api.price_per_request_micro	integer
api.privacy_url	string
api.role	string	Your role in the API's workspace.
api.rps	integer	Requests per second per customer, 0 for no limit.
api.sdk_agent	string
api.sdk_first_seen_at	string (date-time)
api.sdk_last_seen_at	string (date-time)
api.secret_prefix	string
api.signup_mode	string	One of open, approval, invite.
api.slug	string
api.status	string	One of active, suspended.
api.stripe	object
api.stripe.account_id	string
api.stripe.account_name	string
api.stripe.charges_enabled	boolean
api.stripe.configured	boolean	MicroAuth has Stripe Connect set up.
api.stripe.connected	boolean
api.stripe.connected_at	string (date-time)
api.stripe.livemode	boolean
api.support_email	string
api.suspended_reason	string
api.tagline	string
api.terms_url	string
api.topup_amounts_cents	array of integers or null
api.website_url	string
api.welcome_credit_micro	integer
api.workspace_id	string
secret	string	SDK secret key. You can reveal it again from the API's Connect page.

Example request

curl -X POST "https://microauth.com/api/v1/workspaces/{wid}/apis" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "api_base_url": "string",
  "name": "string",
  "preset": "payg",
  "slug": "string"
}'

Example response

{
  "api": {
    "accent_color": "string",
    "api_base_url": "string",
    "auto_recharge_allowed": true,
    "billable_status_codes": [
      0
    ],
    "created_at": "2026-10-11T12:00:00Z",
    "docs_url": "string",
    "domain": {
      "allowed": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "cname_target": "string",
      "domain": "string",
      "error": "string",
      "status": "none",
      "txt_name": "string",
      "txt_value": "string"
    },
    "first_usage_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "key_header": "string",
    "logo_url": "string",
    "low_balance_micro": 0,
    "min_topup_cents": 0,
    "monthly_quota": 0,
    "name": "string",
    "payg_enabled": true,
    "plan": {
      "code": "string",
      "custom_domain": true,
      "max_customers": 0,
      "monthly_requests": 0,
      "name": "string",
      "price_monthly_cents": 0,
      "purchasable": true,
      "remove_branding": true,
      "teams": true
    },
    "plan_grace_until": "2026-10-11T12:00:00Z",
    "plan_period_end": "2026-10-11T12:00:00Z",
    "plan_status": "active",
    "plans_enabled": true,
    "portal_url": "string",
    "previous_secret_valid_until": "2026-10-11T12:00:00Z",
    "price_per_request_micro": 0,
    "privacy_url": "string",
    "role": "string",
    "rps": 0,
    "sdk_agent": "string",
    "sdk_first_seen_at": "2026-10-11T12:00:00Z",
    "sdk_last_seen_at": "2026-10-11T12:00:00Z",
    "secret_prefix": "string",
    "signup_mode": "open",
    "slug": "string",
    "status": "active",
    "stripe": {
      "account_id": "string",
      "account_name": "string",
      "charges_enabled": true,
      "configured": true,
      "connected": true,
      "connected_at": "2026-10-11T12:00:00Z",
      "livemode": true
    },
    "support_email": "string",
    "suspended_reason": "string",
    "tagline": "string",
    "terms_url": "string",
    "topup_amounts_cents": [
      0
    ],
    "website_url": "string",
    "welcome_credit_micro": 0,
    "workspace_id": "string"
  },
  "secret": "string"
}

GET Check a portal address

/api/v1/slug-available

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

query slug

string

Up to 60 characters.

Response 200

available	boolean
reason	string
slug	string

Example request

curl "https://microauth.com/api/v1/slug-available" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "available": true,
  "reason": "string",
  "slug": "string"
}

GET Get an API

/api/v1/apis/{id}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

accent_color	string
api_base_url	string	Where your API runs, shown in the portal quickstart.
auto_recharge_allowed	boolean
billable_status_codes	array of integers or null
created_at	string (date-time)
docs_url	string
domain	object
domain.allowed	boolean	The API's plan includes custom domains.
domain.checked_at	string (date-time)
domain.cname_target	string	Point the domain here with a CNAME record.
domain.domain	string
domain.error	string
domain.status	string	One of none, pending, verified, active, failed.
domain.txt_name	string
domain.txt_value	string
first_usage_at	string (date-time)
id	string
key_header	string	Header customers send their key in.
logo_url	string
low_balance_micro	integer
min_topup_cents	integer
monthly_quota	integer	Requests per month per customer, 0 for no limit.
name	string
payg_enabled	boolean	Customers can buy prepaid credit.
plan	object
plan.code	string
plan.custom_domain	boolean
plan.max_customers	integer
plan.monthly_requests	integer
plan.name	string
plan.price_monthly_cents	integer
plan.purchasable	boolean	True when checkout is available for this plan.
plan.remove_branding	boolean
plan.teams	boolean
plan_grace_until	string (date-time)
plan_period_end	string (date-time)
plan_status	string	One of active, past_due, canceled.
plans_enabled	boolean	Customers can subscribe to public plans.
portal_url	string
previous_secret_valid_until	string (date-time)
price_per_request_micro	integer
privacy_url	string
role	string	Your role in the API's workspace.
rps	integer	Requests per second per customer, 0 for no limit.
sdk_agent	string
sdk_first_seen_at	string (date-time)
sdk_last_seen_at	string (date-time)
secret_prefix	string
signup_mode	string	One of open, approval, invite.
slug	string
status	string	One of active, suspended.
stripe	object
stripe.account_id	string
stripe.account_name	string
stripe.charges_enabled	boolean
stripe.configured	boolean	MicroAuth has Stripe Connect set up.
stripe.connected	boolean
stripe.connected_at	string (date-time)
stripe.livemode	boolean
support_email	string
suspended_reason	string
tagline	string
terms_url	string
topup_amounts_cents	array of integers or null
website_url	string
welcome_credit_micro	integer
workspace_id	string

Example request

curl "https://microauth.com/api/v1/apis/{id}" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "accent_color": "string",
  "api_base_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "first_usage_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "key_header": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "payg_enabled": true,
  "plan": {
    "code": "string",
    "custom_domain": true,
    "max_customers": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "purchasable": true,
    "remove_branding": true,
    "teams": true
  },
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plans_enabled": true,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "topup_amounts_cents": [
    0
  ],
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

PATCH Update an API's settings

/api/v1/apis/{id}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Request body

accent_color	string	Up to 7 characters.
api_base_url	string	Up to 300 characters.
auto_recharge_allowed	boolean
billable_status_codes	array of integers	Up to 40 items.
docs_url	string	Up to 300 characters.
key_header	string	Up to 40 characters.
low_balance_micro	integer
min_topup_cents	integer	100 to 100,000.
monthly_quota	integer	0 removes the quota.
name	string	Up to 80 characters.
payg_enabled	boolean
plans_enabled	boolean
price_per_request_micro	integer	0 to 100,000,000.
privacy_url	string	Up to 300 characters.
rps	integer	0 to 100,000.
signup_mode	string	One of open, approval, invite.
slug	string	Up to 40 characters.
support_email	string	Up to 254 characters.
tagline	string	Up to 160 characters.
terms_url	string	Up to 300 characters.
topup_amounts_cents	array of integers	Up to 6 items.
website_url	string	Up to 300 characters.
welcome_credit_micro	integer	0 to 1,000,000,000.

Response 200

accent_color	string
api_base_url	string	Where your API runs, shown in the portal quickstart.
auto_recharge_allowed	boolean
billable_status_codes	array of integers or null
created_at	string (date-time)
docs_url	string
domain	object
domain.allowed	boolean	The API's plan includes custom domains.
domain.checked_at	string (date-time)
domain.cname_target	string	Point the domain here with a CNAME record.
domain.domain	string
domain.error	string
domain.status	string	One of none, pending, verified, active, failed.
domain.txt_name	string
domain.txt_value	string
first_usage_at	string (date-time)
id	string
key_header	string	Header customers send their key in.
logo_url	string
low_balance_micro	integer
min_topup_cents	integer
monthly_quota	integer	Requests per month per customer, 0 for no limit.
name	string
payg_enabled	boolean	Customers can buy prepaid credit.
plan	object
plan.code	string
plan.custom_domain	boolean
plan.max_customers	integer
plan.monthly_requests	integer
plan.name	string
plan.price_monthly_cents	integer
plan.purchasable	boolean	True when checkout is available for this plan.
plan.remove_branding	boolean
plan.teams	boolean
plan_grace_until	string (date-time)
plan_period_end	string (date-time)
plan_status	string	One of active, past_due, canceled.
plans_enabled	boolean	Customers can subscribe to public plans.
portal_url	string
previous_secret_valid_until	string (date-time)
price_per_request_micro	integer
privacy_url	string
role	string	Your role in the API's workspace.
rps	integer	Requests per second per customer, 0 for no limit.
sdk_agent	string
sdk_first_seen_at	string (date-time)
sdk_last_seen_at	string (date-time)
secret_prefix	string
signup_mode	string	One of open, approval, invite.
slug	string
status	string	One of active, suspended.
stripe	object
stripe.account_id	string
stripe.account_name	string
stripe.charges_enabled	boolean
stripe.configured	boolean	MicroAuth has Stripe Connect set up.
stripe.connected	boolean
stripe.connected_at	string (date-time)
stripe.livemode	boolean
support_email	string
suspended_reason	string
tagline	string
terms_url	string
topup_amounts_cents	array of integers or null
website_url	string
welcome_credit_micro	integer
workspace_id	string

Example request

curl -X PATCH "https://microauth.com/api/v1/apis/{id}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "accent_color": "string",
  "api_base_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "docs_url": "string",
  "key_header": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 100,
  "monthly_quota": 0,
  "name": "string",
  "payg_enabled": true,
  "plans_enabled": true,
  "price_per_request_micro": 0,
  "privacy_url": "string",
  "rps": 0,
  "signup_mode": "open",
  "slug": "string",
  "support_email": "string",
  "tagline": "string",
  "terms_url": "string",
  "topup_amounts_cents": [
    0
  ],
  "website_url": "string",
  "welcome_credit_micro": 0
}'

Example response

{
  "accent_color": "string",
  "api_base_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "first_usage_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "key_header": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "payg_enabled": true,
  "plan": {
    "code": "string",
    "custom_domain": true,
    "max_customers": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "purchasable": true,
    "remove_branding": true,
    "teams": true
  },
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plans_enabled": true,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "topup_amounts_cents": [
    0
  ],
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

DELETE Delete an API

/api/v1/apis/{id}

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

ok

boolean

Example response

{
  "ok": true
}

PUT Upload the logo

/api/v1/apis/{id}/logo

Send the image as the raw request body with Content-Type image/png, image/jpeg or image/webp. Up to 512 KB.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
header Content-Type	string

Response 200

logo_url

string

Example request

curl -X PUT "https://microauth.com/api/v1/apis/{id}/logo" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "logo_url": "string"
}

DELETE Remove the logo

/api/v1/apis/{id}/logo

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

ok

boolean

Example request

curl -X DELETE "https://microauth.com/api/v1/apis/{id}/logo" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "ok": true
}

GET Reveal the SDK secret key

/api/v1/apis/{id}/secret

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

secret

string

Example response

{
  "secret": "string"
}

POST Rotate the SDK secret key

/api/v1/apis/{id}/secret/rotate

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Request body

grace_hoursrequired

integer

How long the old secret keeps working. 0 to 168. Defaults to 24.

Response 200

secret

string

Example response

{
  "secret": "string"
}

GET Get the test customer's key

/api/v1/apis/{id}/test-key

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

balance_micro	integer
customer_id	string
key	string
key_header	string

Example response

{
  "balance_micro": 0,
  "customer_id": "string",
  "key": "string",
  "key_header": "string"
}

POST Replace the test customer's key

/api/v1/apis/{id}/test-key/regenerate

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

balance_micro	integer
customer_id	string
key	string
key_header	string

Example response

{
  "balance_micro": 0,
  "customer_id": "string",
  "key": "string",
  "key_header": "string"
}

POST Add $5 of test credit

/api/v1/apis/{id}/test-credit

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

balance_micro	integer
customer_id	string
key	string
key_header	string

Example request

curl -X POST "https://microauth.com/api/v1/apis/{id}/test-credit" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "balance_micro": 0,
  "customer_id": "string",
  "key": "string",
  "key_header": "string"
}

GET Integration status

/api/v1/apis/{id}/connection

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

customers	integer
first_usage_at	string (date-time)
sdk_agent	string
sdk_connected	boolean	The SDK fetched a snapshot in the last 10 minutes.
sdk_first_seen_at	string (date-time)
sdk_last_seen_at	string (date-time)
stripe_ready	boolean
test_requests	integer

Example request

curl "https://microauth.com/api/v1/apis/{id}/connection" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "customers": 0,
  "first_usage_at": "2026-10-11T12:00:00Z",
  "sdk_agent": "string",
  "sdk_connected": true,
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "stripe_ready": true,
  "test_requests": 0
}

GET Usage and revenue

/api/v1/apis/{id}/stats

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
query days	integer	7 to 90. Defaults to 30.

Response 200

active_customers	integer	Customers with requests this month.
charged_month_micro	integer	Usage charged to real customers this month.
customers	integer
daily	array of objects or null	Requests include the test key; charged_micro does not.
daily[].billable	integer
daily[].charged_micro	integer
daily[].day	string
daily[].errors	integer
daily[].requests	integer
pending_customers	integer
platform_limit	integer
requests_month	integer	All requests this month, the number your MicroAuth plan counts.
requests_today	integer	All requests today, test key included.
top_customers	array of objects or null	Busiest customers this month.
top_customers[].balance_micro	integer
top_customers[].charged_micro	integer
top_customers[].id	string
top_customers[].name	string
top_customers[].requests	integer
topups_month_micro	integer	Credit bought with Stripe this month.

Example request

curl "https://microauth.com/api/v1/apis/{id}/stats" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "active_customers": 0,
  "charged_month_micro": 0,
  "customers": 0,
  "daily": [
    {
      "billable": 0,
      "charged_micro": 0,
      "day": "string",
      "errors": 0,
      "requests": 0
    }
  ],
  "pending_customers": 0,
  "platform_limit": 0,
  "requests_month": 0,
  "requests_today": 0,
  "top_customers": [
    {
      "balance_micro": 0,
      "charged_micro": 0,
      "id": "string",
      "name": "string",
      "requests": 0
    }
  ],
  "topups_month_micro": 0
}

PUT Set a custom portal domain

/api/v1/apis/{id}/domain

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Request body

domainrequired

string

Up to 253 characters.

Response 200

accent_color	string
api_base_url	string	Where your API runs, shown in the portal quickstart.
auto_recharge_allowed	boolean
billable_status_codes	array of integers or null
created_at	string (date-time)
docs_url	string
domain	object
domain.allowed	boolean	The API's plan includes custom domains.
domain.checked_at	string (date-time)
domain.cname_target	string	Point the domain here with a CNAME record.
domain.domain	string
domain.error	string
domain.status	string	One of none, pending, verified, active, failed.
domain.txt_name	string
domain.txt_value	string
first_usage_at	string (date-time)
id	string
key_header	string	Header customers send their key in.
logo_url	string
low_balance_micro	integer
min_topup_cents	integer
monthly_quota	integer	Requests per month per customer, 0 for no limit.
name	string
payg_enabled	boolean	Customers can buy prepaid credit.
plan	object
plan.code	string
plan.custom_domain	boolean
plan.max_customers	integer
plan.monthly_requests	integer
plan.name	string
plan.price_monthly_cents	integer
plan.purchasable	boolean	True when checkout is available for this plan.
plan.remove_branding	boolean
plan.teams	boolean
plan_grace_until	string (date-time)
plan_period_end	string (date-time)
plan_status	string	One of active, past_due, canceled.
plans_enabled	boolean	Customers can subscribe to public plans.
portal_url	string
previous_secret_valid_until	string (date-time)
price_per_request_micro	integer
privacy_url	string
role	string	Your role in the API's workspace.
rps	integer	Requests per second per customer, 0 for no limit.
sdk_agent	string
sdk_first_seen_at	string (date-time)
sdk_last_seen_at	string (date-time)
secret_prefix	string
signup_mode	string	One of open, approval, invite.
slug	string
status	string	One of active, suspended.
stripe	object
stripe.account_id	string
stripe.account_name	string
stripe.charges_enabled	boolean
stripe.configured	boolean	MicroAuth has Stripe Connect set up.
stripe.connected	boolean
stripe.connected_at	string (date-time)
stripe.livemode	boolean
support_email	string
suspended_reason	string
tagline	string
terms_url	string
topup_amounts_cents	array of integers or null
website_url	string
welcome_credit_micro	integer
workspace_id	string

Example request

curl -X PUT "https://microauth.com/api/v1/apis/{id}/domain" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "string"
}'

Example response

{
  "accent_color": "string",
  "api_base_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "first_usage_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "key_header": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "payg_enabled": true,
  "plan": {
    "code": "string",
    "custom_domain": true,
    "max_customers": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "purchasable": true,
    "remove_branding": true,
    "teams": true
  },
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plans_enabled": true,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "topup_amounts_cents": [
    0
  ],
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

POST Check the custom domain's DNS now

/api/v1/apis/{id}/domain/check

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

accent_color	string
api_base_url	string	Where your API runs, shown in the portal quickstart.
auto_recharge_allowed	boolean
billable_status_codes	array of integers or null
created_at	string (date-time)
docs_url	string
domain	object
domain.allowed	boolean	The API's plan includes custom domains.
domain.checked_at	string (date-time)
domain.cname_target	string	Point the domain here with a CNAME record.
domain.domain	string
domain.error	string
domain.status	string	One of none, pending, verified, active, failed.
domain.txt_name	string
domain.txt_value	string
first_usage_at	string (date-time)
id	string
key_header	string	Header customers send their key in.
logo_url	string
low_balance_micro	integer
min_topup_cents	integer
monthly_quota	integer	Requests per month per customer, 0 for no limit.
name	string
payg_enabled	boolean	Customers can buy prepaid credit.
plan	object
plan.code	string
plan.custom_domain	boolean
plan.max_customers	integer
plan.monthly_requests	integer
plan.name	string
plan.price_monthly_cents	integer
plan.purchasable	boolean	True when checkout is available for this plan.
plan.remove_branding	boolean
plan.teams	boolean
plan_grace_until	string (date-time)
plan_period_end	string (date-time)
plan_status	string	One of active, past_due, canceled.
plans_enabled	boolean	Customers can subscribe to public plans.
portal_url	string
previous_secret_valid_until	string (date-time)
price_per_request_micro	integer
privacy_url	string
role	string	Your role in the API's workspace.
rps	integer	Requests per second per customer, 0 for no limit.
sdk_agent	string
sdk_first_seen_at	string (date-time)
sdk_last_seen_at	string (date-time)
secret_prefix	string
signup_mode	string	One of open, approval, invite.
slug	string
status	string	One of active, suspended.
stripe	object
stripe.account_id	string
stripe.account_name	string
stripe.charges_enabled	boolean
stripe.configured	boolean	MicroAuth has Stripe Connect set up.
stripe.connected	boolean
stripe.connected_at	string (date-time)
stripe.livemode	boolean
support_email	string
suspended_reason	string
tagline	string
terms_url	string
topup_amounts_cents	array of integers or null
website_url	string
welcome_credit_micro	integer
workspace_id	string

Example request

curl -X POST "https://microauth.com/api/v1/apis/{id}/domain/check" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "accent_color": "string",
  "api_base_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "first_usage_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "key_header": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "payg_enabled": true,
  "plan": {
    "code": "string",
    "custom_domain": true,
    "max_customers": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "purchasable": true,
    "remove_branding": true,
    "teams": true
  },
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plans_enabled": true,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "topup_amounts_cents": [
    0
  ],
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

DELETE Remove the custom domain

/api/v1/apis/{id}/domain

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

accent_color	string
api_base_url	string	Where your API runs, shown in the portal quickstart.
auto_recharge_allowed	boolean
billable_status_codes	array of integers or null
created_at	string (date-time)
docs_url	string
domain	object
domain.allowed	boolean	The API's plan includes custom domains.
domain.checked_at	string (date-time)
domain.cname_target	string	Point the domain here with a CNAME record.
domain.domain	string
domain.error	string
domain.status	string	One of none, pending, verified, active, failed.
domain.txt_name	string
domain.txt_value	string
first_usage_at	string (date-time)
id	string
key_header	string	Header customers send their key in.
logo_url	string
low_balance_micro	integer
min_topup_cents	integer
monthly_quota	integer	Requests per month per customer, 0 for no limit.
name	string
payg_enabled	boolean	Customers can buy prepaid credit.
plan	object
plan.code	string
plan.custom_domain	boolean
plan.max_customers	integer
plan.monthly_requests	integer
plan.name	string
plan.price_monthly_cents	integer
plan.purchasable	boolean	True when checkout is available for this plan.
plan.remove_branding	boolean
plan.teams	boolean
plan_grace_until	string (date-time)
plan_period_end	string (date-time)
plan_status	string	One of active, past_due, canceled.
plans_enabled	boolean	Customers can subscribe to public plans.
portal_url	string
previous_secret_valid_until	string (date-time)
price_per_request_micro	integer
privacy_url	string
role	string	Your role in the API's workspace.
rps	integer	Requests per second per customer, 0 for no limit.
sdk_agent	string
sdk_first_seen_at	string (date-time)
sdk_last_seen_at	string (date-time)
secret_prefix	string
signup_mode	string	One of open, approval, invite.
slug	string
status	string	One of active, suspended.
stripe	object
stripe.account_id	string
stripe.account_name	string
stripe.charges_enabled	boolean
stripe.configured	boolean	MicroAuth has Stripe Connect set up.
stripe.connected	boolean
stripe.connected_at	string (date-time)
stripe.livemode	boolean
support_email	string
suspended_reason	string
tagline	string
terms_url	string
topup_amounts_cents	array of integers or null
website_url	string
welcome_credit_micro	integer
workspace_id	string

Example request

curl -X DELETE "https://microauth.com/api/v1/apis/{id}/domain" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "accent_color": "string",
  "api_base_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "first_usage_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "key_header": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "payg_enabled": true,
  "plan": {
    "code": "string",
    "custom_domain": true,
    "max_customers": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "purchasable": true,
    "remove_branding": true,
    "teams": true
  },
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plans_enabled": true,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "topup_amounts_cents": [
    0
  ],
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

Customers

Customers of an API, with their keys, limits, credit, ledger and usage.

GET List customers

/api/v1/apis/{id}/customers

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
query status	string	One of active, pending, suspended.
query q	string	Up to 100 characters.
query plan_id	string
query cursor	string	next_cursor from the previous page.
query limit	integer	1 to 200. Defaults to 50.

Response 200

customers	array of objects or null
customers[].balance_micro	integer
customers[].created_at	string (date-time)
customers[].custom_limits	boolean
customers[].email	string
customers[].id	string
customers[].is_test	boolean
customers[].last_used_at	string (date-time)
customers[].month_requests	integer
customers[].name	string
customers[].plan_id	string
customers[].plan_name	string
customers[].status	string	One of active, pending, suspended.
next_cursor	string

Example request

curl "https://microauth.com/api/v1/apis/{id}/customers" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "customers": [
    {
      "balance_micro": 0,
      "created_at": "2026-10-11T12:00:00Z",
      "custom_limits": true,
      "email": "string",
      "id": "string",
      "is_test": true,
      "last_used_at": "2026-10-11T12:00:00Z",
      "month_requests": 0,
      "name": "string",
      "plan_id": "string",
      "plan_name": "string",
      "status": "active"
    }
  ],
  "next_cursor": "string"
}

POST Invite a customer to the portal

/api/v1/apis/{id}/customers/invite

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Request body

emailrequired

string

Up to 254 characters.

Response 201

sent

boolean

Example request

curl -X POST "https://microauth.com/api/v1/apis/{id}/customers/invite" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string"
}'

Example response

{
  "sent": true
}

GET Get a customer

/api/v1/apis/{id}/customers/{customer}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
customerrequired	string (uuid)	Customer ID.

Response 200

auto_recharge	object
auto_recharge.amount_cents	integer
auto_recharge.enabled	boolean
auto_recharge.failed_at	string (date-time)
auto_recharge.has_card	boolean
auto_recharge.threshold_micro	integer
balance_micro	integer
created_at	string (date-time)
custom	object
custom.monthly_quota	integer or null
custom.price_per_request_micro	integer or null	0 to 100,000,000.
custom.rps	integer or null	0 to 100,000.
custom_limits	boolean
effective	object
effective.billing_model	string	One of payg, subscription, none.
effective.monthly_quota	integer
effective.price_per_request_micro	integer
effective.rps	integer
effective.source	string	One of custom, plan, payg.
email	string
id	string
is_test	boolean
keys	array of objects or null
keys[].created_at	string (date-time)
keys[].id	string
keys[].last_used_at	string (date-time)
keys[].name	string
keys[].prefix	string
last_used_at	string (date-time)
low_balance_micro	integer
members	array of objects or null
members[].created_at	string (date-time)
members[].email	string
members[].id	string
members[].last_login_at	string (date-time)
members[].name	string
members[].role	string
month_requests	integer
name	string
notes	string
plan_id	string
plan_name	string
plan_source	string	One of manual, stripe.
status	string	One of active, pending, suspended.
stripe_customer_id	string
subscription_period_end	string (date-time)
subscription_status	string

Example request

curl "https://microauth.com/api/v1/apis/{id}/customers/{customer}" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "auto_recharge": {
    "amount_cents": 0,
    "enabled": true,
    "failed_at": "2026-10-11T12:00:00Z",
    "has_card": true,
    "threshold_micro": 0
  },
  "balance_micro": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "custom": {
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0
  },
  "custom_limits": true,
  "effective": {
    "billing_model": "payg",
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0,
    "source": "custom"
  },
  "email": "string",
  "id": "string",
  "is_test": true,
  "keys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "prefix": "string"
    }
  ],
  "last_used_at": "2026-10-11T12:00:00Z",
  "low_balance_micro": 0,
  "members": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "id": "string",
      "last_login_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "role": "string"
    }
  ],
  "month_requests": 0,
  "name": "string",
  "notes": "string",
  "plan_id": "string",
  "plan_name": "string",
  "plan_source": "manual",
  "status": "active",
  "stripe_customer_id": "string",
  "subscription_period_end": "2026-10-11T12:00:00Z",
  "subscription_status": "string"
}

PATCH Update a customer

/api/v1/apis/{id}/customers/{customer}

Approve a pending customer with status active. Suspending blocks the customer's keys within a minute.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
customerrequired	string (uuid)	Customer ID.

Request body

low_balance_micro	integer	-1 uses the API default. At least -1.
name	string	Up to 100 characters.
notes	string	Up to 2,000 characters.
plan_id	string	Put the customer on a plan without Stripe. Send an empty string to remove the plan.
status	string	One of active, suspended.

Response 200

auto_recharge	object
auto_recharge.amount_cents	integer
auto_recharge.enabled	boolean
auto_recharge.failed_at	string (date-time)
auto_recharge.has_card	boolean
auto_recharge.threshold_micro	integer
balance_micro	integer
created_at	string (date-time)
custom	object
custom.monthly_quota	integer or null
custom.price_per_request_micro	integer or null	0 to 100,000,000.
custom.rps	integer or null	0 to 100,000.
custom_limits	boolean
effective	object
effective.billing_model	string	One of payg, subscription, none.
effective.monthly_quota	integer
effective.price_per_request_micro	integer
effective.rps	integer
effective.source	string	One of custom, plan, payg.
email	string
id	string
is_test	boolean
keys	array of objects or null
keys[].created_at	string (date-time)
keys[].id	string
keys[].last_used_at	string (date-time)
keys[].name	string
keys[].prefix	string
last_used_at	string (date-time)
low_balance_micro	integer
members	array of objects or null
members[].created_at	string (date-time)
members[].email	string
members[].id	string
members[].last_login_at	string (date-time)
members[].name	string
members[].role	string
month_requests	integer
name	string
notes	string
plan_id	string
plan_name	string
plan_source	string	One of manual, stripe.
status	string	One of active, pending, suspended.
stripe_customer_id	string
subscription_period_end	string (date-time)
subscription_status	string

Example request

curl -X PATCH "https://microauth.com/api/v1/apis/{id}/customers/{customer}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "low_balance_micro": 0,
  "name": "string",
  "notes": "string",
  "plan_id": "string",
  "status": "active"
}'

Example response

{
  "auto_recharge": {
    "amount_cents": 0,
    "enabled": true,
    "failed_at": "2026-10-11T12:00:00Z",
    "has_card": true,
    "threshold_micro": 0
  },
  "balance_micro": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "custom": {
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0
  },
  "custom_limits": true,
  "effective": {
    "billing_model": "payg",
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0,
    "source": "custom"
  },
  "email": "string",
  "id": "string",
  "is_test": true,
  "keys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "prefix": "string"
    }
  ],
  "last_used_at": "2026-10-11T12:00:00Z",
  "low_balance_micro": 0,
  "members": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "id": "string",
      "last_login_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "role": "string"
    }
  ],
  "month_requests": 0,
  "name": "string",
  "notes": "string",
  "plan_id": "string",
  "plan_name": "string",
  "plan_source": "manual",
  "status": "active",
  "stripe_customer_id": "string",
  "subscription_period_end": "2026-10-11T12:00:00Z",
  "subscription_status": "string"
}

DELETE Delete a customer

/api/v1/apis/{id}/customers/{customer}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
customerrequired	string (uuid)	Customer ID.

Response 200

ok

boolean

Example request

curl -X DELETE "https://microauth.com/api/v1/apis/{id}/customers/{customer}" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "ok": true
}

PUT Set custom limits

/api/v1/apis/{id}/customers/{customer}/limits

Custom limits beat the customer's plan and the API defaults. null inherits.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
customerrequired	string (uuid)	Customer ID.

Request body

monthly_quota	integer or null
price_per_request_micro	integer or null	0 to 100,000,000.
rps	integer or null	0 to 100,000.

Response 200

auto_recharge	object
auto_recharge.amount_cents	integer
auto_recharge.enabled	boolean
auto_recharge.failed_at	string (date-time)
auto_recharge.has_card	boolean
auto_recharge.threshold_micro	integer
balance_micro	integer
created_at	string (date-time)
custom	object
custom.monthly_quota	integer or null
custom.price_per_request_micro	integer or null	0 to 100,000,000.
custom.rps	integer or null	0 to 100,000.
custom_limits	boolean
effective	object
effective.billing_model	string	One of payg, subscription, none.
effective.monthly_quota	integer
effective.price_per_request_micro	integer
effective.rps	integer
effective.source	string	One of custom, plan, payg.
email	string
id	string
is_test	boolean
keys	array of objects or null
keys[].created_at	string (date-time)
keys[].id	string
keys[].last_used_at	string (date-time)
keys[].name	string
keys[].prefix	string
last_used_at	string (date-time)
low_balance_micro	integer
members	array of objects or null
members[].created_at	string (date-time)
members[].email	string
members[].id	string
members[].last_login_at	string (date-time)
members[].name	string
members[].role	string
month_requests	integer
name	string
notes	string
plan_id	string
plan_name	string
plan_source	string	One of manual, stripe.
status	string	One of active, pending, suspended.
stripe_customer_id	string
subscription_period_end	string (date-time)
subscription_status	string

Example request

curl -X PUT "https://microauth.com/api/v1/apis/{id}/customers/{customer}/limits" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "monthly_quota": 0,
  "price_per_request_micro": 0,
  "rps": 0
}'

Example response

{
  "auto_recharge": {
    "amount_cents": 0,
    "enabled": true,
    "failed_at": "2026-10-11T12:00:00Z",
    "has_card": true,
    "threshold_micro": 0
  },
  "balance_micro": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "custom": {
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0
  },
  "custom_limits": true,
  "effective": {
    "billing_model": "payg",
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0,
    "source": "custom"
  },
  "email": "string",
  "id": "string",
  "is_test": true,
  "keys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "prefix": "string"
    }
  ],
  "last_used_at": "2026-10-11T12:00:00Z",
  "low_balance_micro": 0,
  "members": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "id": "string",
      "last_login_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "role": "string"
    }
  ],
  "month_requests": 0,
  "name": "string",
  "notes": "string",
  "plan_id": "string",
  "plan_name": "string",
  "plan_source": "manual",
  "status": "active",
  "stripe_customer_id": "string",
  "subscription_period_end": "2026-10-11T12:00:00Z",
  "subscription_status": "string"
}

POST Add or remove credit

/api/v1/apis/{id}/customers/{customer}/credits

Use this to sell credit outside Stripe. Pass ref to make the call safe to retry.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
customerrequired	string (uuid)	Customer ID.

Request body

amount_microrequired	integer	Positive adds credit, negative removes it. 1,000,000 is $1. -100,000,000,000 to 100,000,000,000.
noterequired	string	Up to 300 characters.
ref	string	Your idempotency reference, for example an invoice number. A repeated ref is ignored. Up to 200 characters.

Response 200

applied	boolean	False when this ref was already applied.
balance_micro	integer

Example request

curl -X POST "https://microauth.com/api/v1/apis/{id}/customers/{customer}/credits" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "amount_micro": 0,
  "note": "string",
  "ref": "string"
}'

Example response

{
  "applied": true,
  "balance_micro": 0
}

GET Customer ledger

/api/v1/apis/{id}/customers/{customer}/ledger

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
customerrequired	string (uuid)	Customer ID.
query cursor	string
query limit	integer	1 to 200. Defaults to 50.

Response 200

entries	array of objects or null
entries[].actor	string
entries[].amount_micro	integer
entries[].created_at	string (date-time)
entries[].customer_id	string
entries[].customer_name	string
entries[].id	string
entries[].kind	string
entries[].note	string
entries[].ref	string
entries[].requests	integer
entries[].updated_at	string (date-time)
entries[].usage_day	string (date-time)
next_cursor	string

Example request

curl "https://microauth.com/api/v1/apis/{id}/customers/{customer}/ledger" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "entries": [
    {
      "actor": "string",
      "amount_micro": 0,
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "id": "string",
      "kind": "string",
      "note": "string",
      "ref": "string",
      "requests": 0,
      "updated_at": "2026-10-11T12:00:00Z",
      "usage_day": "2026-10-11T12:00:00Z"
    }
  ],
  "next_cursor": "string"
}

GET Customer usage by day

/api/v1/apis/{id}/customers/{customer}/usage

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
customerrequired	string (uuid)	Customer ID.
query days	integer	1 to 90. Defaults to 30.

Response 200

OK

Example request

curl "https://microauth.com/api/v1/apis/{id}/customers/{customer}/usage" \
  -H "Authorization: Bearer mak_..."

Example response

[
  {
    "billable": 0,
    "charged_micro": 0,
    "day": "string",
    "errors": 0,
    "requests": 0
  }
]

DELETE Revoke a customer's key

/api/v1/apis/{id}/customers/{customer}/keys/{key}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
customerrequired	string (uuid)	Customer ID.
keyrequired	string (uuid)	Key ID.

Response 200

ok

boolean

Example request

curl -X DELETE "https://microauth.com/api/v1/apis/{id}/customers/{customer}/keys/{key}" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "ok": true
}

GET API ledger

/api/v1/apis/{id}/ledger

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
query kind	string	Comma separated kinds, for example topup,refund.
query cursor	string
query limit	integer	1 to 200. Defaults to 50.

Response 200

entries	array of objects or null
entries[].actor	string
entries[].amount_micro	integer
entries[].created_at	string (date-time)
entries[].customer_id	string
entries[].customer_name	string
entries[].id	string
entries[].kind	string
entries[].note	string
entries[].ref	string
entries[].requests	integer
entries[].updated_at	string (date-time)
entries[].usage_day	string (date-time)
next_cursor	string

Example request

curl "https://microauth.com/api/v1/apis/{id}/ledger" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "entries": [
    {
      "actor": "string",
      "amount_micro": 0,
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "id": "string",
      "kind": "string",
      "note": "string",
      "ref": "string",
      "requests": 0,
      "updated_at": "2026-10-11T12:00:00Z",
      "usage_day": "2026-10-11T12:00:00Z"
    }
  ],
  "next_cursor": "string"
}

GET Export customers as CSV

/api/v1/apis/{id}/customers/export

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

OK

Example request

curl "https://microauth.com/api/v1/apis/{id}/customers/export" \
  -H "Authorization: Bearer mak_..."

Pricing

Subscription plans your customers can pick on the portal.

GET List plans

/api/v1/apis/{id}/plans

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

OK

Example request

curl "https://microauth.com/api/v1/apis/{id}/plans" \
  -H "Authorization: Bearer mak_..."

Example response

[
  {
    "active": true,
    "created_at": "2026-10-11T12:00:00Z",
    "credit_micro": 0,
    "description": "string",
    "id": "string",
    "monthly_quota": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "price_per_request_micro": 0,
    "rps": 0,
    "sort": 0,
    "stripe_price_id": "string",
    "stripe_sync_error": "string",
    "stripe_synced_at": "2026-10-11T12:00:00Z",
    "subscribers": 0,
    "visibility": "public"
  }
]

POST Create a plan

/api/v1/apis/{id}/plans

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Request body

active	boolean
credit_micro	integer	0 to 100,000,000,000.
description	string	Up to 300 characters.
monthly_quota	integer or null
namerequired	string	Up to 60 characters.
price_monthly_centsrequired	integer	0 to 1,000,000.
price_per_request_micro	integer or null	0 to 100,000,000.
rps	integer or null	0 to 100,000.
sort	integer	0 to 1,000.
visibility	string	One of public, private. Defaults to "public".

Response 201

active	boolean
created_at	string (date-time)
credit_micro	integer	Credit added on every paid invoice.
description	string
id	string
monthly_quota	integer or null	null uses the API default, 0 is unlimited.
name	string
price_monthly_cents	integer
price_per_request_micro	integer or null	null uses the API default.
rps	integer or null	null uses the API default, 0 is unlimited.
sort	integer
stripe_price_id	string
stripe_sync_error	string
stripe_synced_at	string (date-time)
subscribers	integer
visibility	string	One of public, private.

Example request

curl -X POST "https://microauth.com/api/v1/apis/{id}/plans" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "active": true,
  "credit_micro": 0,
  "description": "string",
  "monthly_quota": 0,
  "name": "string",
  "price_monthly_cents": 0,
  "price_per_request_micro": 0,
  "rps": 0,
  "sort": 0,
  "visibility": "public"
}'

Example response

{
  "active": true,
  "created_at": "2026-10-11T12:00:00Z",
  "credit_micro": 0,
  "description": "string",
  "id": "string",
  "monthly_quota": 0,
  "name": "string",
  "price_monthly_cents": 0,
  "price_per_request_micro": 0,
  "rps": 0,
  "sort": 0,
  "stripe_price_id": "string",
  "stripe_sync_error": "string",
  "stripe_synced_at": "2026-10-11T12:00:00Z",
  "subscribers": 0,
  "visibility": "public"
}

PUT Update a plan

/api/v1/apis/{id}/plans/{plan}

Replaces the plan's settings. A changed monthly price creates a new Stripe price for new subscribers; current subscribers keep their price until they change plans.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
planrequired	string (uuid)	Plan ID.

Request body

active	boolean
credit_micro	integer	0 to 100,000,000,000.
description	string	Up to 300 characters.
monthly_quota	integer or null
namerequired	string	Up to 60 characters.
price_monthly_centsrequired	integer	0 to 1,000,000.
price_per_request_micro	integer or null	0 to 100,000,000.
rps	integer or null	0 to 100,000.
sort	integer	0 to 1,000.
visibility	string	One of public, private. Defaults to "public".

Response 200

active	boolean
created_at	string (date-time)
credit_micro	integer	Credit added on every paid invoice.
description	string
id	string
monthly_quota	integer or null	null uses the API default, 0 is unlimited.
name	string
price_monthly_cents	integer
price_per_request_micro	integer or null	null uses the API default.
rps	integer or null	null uses the API default, 0 is unlimited.
sort	integer
stripe_price_id	string
stripe_sync_error	string
stripe_synced_at	string (date-time)
subscribers	integer
visibility	string	One of public, private.

Example request

curl -X PUT "https://microauth.com/api/v1/apis/{id}/plans/{plan}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "active": true,
  "credit_micro": 0,
  "description": "string",
  "monthly_quota": 0,
  "name": "string",
  "price_monthly_cents": 0,
  "price_per_request_micro": 0,
  "rps": 0,
  "sort": 0,
  "visibility": "public"
}'

Example response

{
  "active": true,
  "created_at": "2026-10-11T12:00:00Z",
  "credit_micro": 0,
  "description": "string",
  "id": "string",
  "monthly_quota": 0,
  "name": "string",
  "price_monthly_cents": 0,
  "price_per_request_micro": 0,
  "rps": 0,
  "sort": 0,
  "stripe_price_id": "string",
  "stripe_sync_error": "string",
  "stripe_synced_at": "2026-10-11T12:00:00Z",
  "subscribers": 0,
  "visibility": "public"
}

DELETE Delete or archive a plan

/api/v1/apis/{id}/plans/{plan}

Plans with subscribers are archived instead: they stay on the plan but nobody new can pick it.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired	string (uuid)	API ID.
planrequired	string (uuid)	Plan ID.

Response 200

ok

boolean

Example request

curl -X DELETE "https://microauth.com/api/v1/apis/{id}/plans/{plan}" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "ok": true
}

Payments

Connect Stripe so your customers can pay you.

POST Start connecting Stripe

/api/v1/apis/{id}/stripe/connect

Returns the Stripe address to send the browser to. Stripe sends the owner back to the dashboard when they finish.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

changed	boolean	True when the change already happened.
url	string	Send the browser here to finish in Stripe.

Example response

{
  "changed": true,
  "url": "string"
}

POST Refresh the Stripe account status

/api/v1/apis/{id}/stripe/refresh

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

account_id	string
account_name	string
charges_enabled	boolean
configured	boolean	MicroAuth has Stripe Connect set up.
connected	boolean
connected_at	string (date-time)
livemode	boolean

Example request

curl -X POST "https://microauth.com/api/v1/apis/{id}/stripe/refresh" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "account_id": "string",
  "account_name": "string",
  "charges_enabled": true,
  "configured": true,
  "connected": true,
  "connected_at": "2026-10-11T12:00:00Z",
  "livemode": true
}

DELETE Disconnect Stripe

/api/v1/apis/{id}/stripe

Card payments stop right away. Existing subscriptions keep running in Stripe until you cancel them there.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Response 200

ok

boolean

Example response

{
  "ok": true
}

MicroAuth plan

The plan each API is on with MicroAuth, and billing for it.

GET MicroAuth plans

/api/v1/platform-plans

Auth NoneServer https://microauth.com

Response 200

OK

Example request

curl "https://microauth.com/api/v1/platform-plans"

Example response

[
  {
    "code": "string",
    "custom_domain": true,
    "max_customers": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "purchasable": true,
    "remove_branding": true,
    "teams": true
  }
]

POST Change the API's MicroAuth plan

/api/v1/apis/{id}/plan

Returns a Stripe Checkout address for a first paid plan. Changes between paid plans and moves to Free apply right away.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequired

string (uuid)

API ID.

Request body

plan_coderequired

string

Up to 32 characters.

Response 200

changed	boolean	True when the change already happened.
url	string	Send the browser here to finish in Stripe.

Example response

{
  "changed": true,
  "url": "string"
}

POST Open MicroAuth billing

/api/v1/workspaces/{wid}/billing-portal

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Response 200

changed	boolean	True when the change already happened.
url	string	Send the browser here to finish in Stripe.

Example response

{
  "changed": true,
  "url": "string"
}

Workspaces

Workspaces, members, invites, workspace API keys and the activity log.

POST Create a workspace

/api/v1/workspaces

Auth Dashboard sessionServer https://microauth.com

Request body

namerequired

string

Up to 100 characters.

Response 201

api_count	integer
created_at	string (date-time)
id	string
name	string
role	string

Example response

{
  "api_count": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "name": "string",
  "role": "string"
}

GET Get a workspace

/api/v1/workspaces/{wid}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Response 200

api_count	integer
created_at	string (date-time)
id	string
name	string
role	string
teams_allowed	boolean	Inviting teammates needs an API on a plan that includes teams.

Example request

curl "https://microauth.com/api/v1/workspaces/{wid}" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "api_count": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "name": "string",
  "role": "string",
  "teams_allowed": true
}

PATCH Rename a workspace

/api/v1/workspaces/{wid}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Request body

namerequired

string

Up to 100 characters.

Response 200

ok

boolean

Example request

curl -X PATCH "https://microauth.com/api/v1/workspaces/{wid}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Example response

{
  "ok": true
}

DELETE Delete an empty workspace

/api/v1/workspaces/{wid}

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Response 200

ok

boolean

Example response

{
  "ok": true
}

GET List members and pending invites

/api/v1/workspaces/{wid}/members

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Response 200

invites	array of objects or null
invites[].created_at	string (date-time)
invites[].email	string
invites[].expires_at	string (date-time)
invites[].id	string
invites[].role	string
members	array of objects or null
members[].email	string
members[].joined_at	string (date-time)
members[].name	string
members[].role	string
members[].two_factor	boolean
members[].user_id	string

Example request

curl "https://microauth.com/api/v1/workspaces/{wid}/members" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "invites": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "expires_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "role": "string"
    }
  ],
  "members": [
    {
      "email": "string",
      "joined_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "role": "string",
      "two_factor": true,
      "user_id": "string"
    }
  ]
}

POST Invite a teammate

/api/v1/workspaces/{wid}/invites

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Request body

emailrequired	string	Up to 254 characters.
rolerequired	string	One of admin, editor, viewer.

Response 201

created_at	string (date-time)
email	string
expires_at	string (date-time)
id	string
role	string

Example response

{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "role": "string"
}

DELETE Cancel an invite

/api/v1/workspaces/{wid}/invites/{item}

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequired	string (uuid)	Workspace ID.
itemrequired	string (uuid)	The member's user ID, the invite ID or the key ID, matching the path.

Response 200

ok

boolean

Example response

{
  "ok": true
}

PATCH Change a member's role

/api/v1/workspaces/{wid}/members/{item}

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequired	string (uuid)	Workspace ID.
itemrequired	string (uuid)	User ID of the member.

Request body

rolerequired

string

One of owner, admin, editor, viewer.

Response 200

ok

boolean

Example response

{
  "ok": true
}

DELETE Remove a member or leave

/api/v1/workspaces/{wid}/members/{item}

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequired	string (uuid)	Workspace ID.
itemrequired	string (uuid)	The member's user ID, the invite ID or the key ID, matching the path.

Response 200

ok

boolean

Example response

{
  "ok": true
}

GET List workspace API keys

/api/v1/workspaces/{wid}/keys

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Response 200

OK

Example request

curl "https://microauth.com/api/v1/workspaces/{wid}/keys" \
  -H "Authorization: Bearer mak_..."

Example response

[
  {
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "last_used_at": "2026-10-11T12:00:00Z",
    "name": "string",
    "prefix": "string",
    "role": "string"
  }
]

POST Create a workspace API key

/api/v1/workspaces/{wid}/keys

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequired

string (uuid)

Workspace ID.

Request body

namerequired	string	Up to 80 characters.
rolerequired	string	One of admin, editor, viewer. Defaults to "editor".

Response 201

created_at	string (date-time)
id	string
key	string	Shown once. Store it somewhere safe.
last_used_at	string (date-time)
name	string
prefix	string
role	string

Example response

{
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "key": "string",
  "last_used_at": "2026-10-11T12:00:00Z",
  "name": "string",
  "prefix": "string",
  "role": "string"
}

DELETE Revoke a workspace API key

/api/v1/workspaces/{wid}/keys/{item}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired	string (uuid)	Workspace ID.
itemrequired	string (uuid)	The member's user ID, the invite ID or the key ID, matching the path.

Response 200

ok

boolean

Example request

curl -X DELETE "https://microauth.com/api/v1/workspaces/{wid}/keys/{item}" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "ok": true
}

GET Activity log

/api/v1/workspaces/{wid}/audit

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired	string (uuid)	Workspace ID.
query api_id	string	Only events for this API.
query customer_id	string	Only events for this customer.
query action	string	Action prefix, for example customer. or key.revoked.
query actor	string	Actor type: user, key, portal_user, system, stripe or admin.
query q	string	Matches the summary or actor name. Up to 100 characters.
query before	string	Cursor from next_before.
query since	string	Only events after this RFC 3339 time.
query limit	integer	1 to 200. Defaults to 50.

Response 200

events	array of objects or null
events[].action	string
events[].actor_id	string
events[].actor_name	string
events[].actor_type	string
events[].api_id	string
events[].api_name	string
events[].created_at	string (date-time)
events[].customer_id	string
events[].customer_name	string
events[].details	object
events[].id	string
events[].ip	string
events[].summary	string
events[].target_id	string
events[].target_type	string
next_before	string

Example request

curl "https://microauth.com/api/v1/workspaces/{wid}/audit" \
  -H "Authorization: Bearer mak_..."

Example response

{
  "events": [
    {
      "action": "string",
      "actor_id": "string",
      "actor_name": "string",
      "actor_type": "string",
      "api_id": "string",
      "api_name": "string",
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "details": {},
      "id": "string",
      "ip": "string",
      "summary": "string",
      "target_id": "string",
      "target_type": "string"
    }
  ],
  "next_before": "string"
}

GET Export the activity log

/api/v1/workspaces/{wid}/audit/export

Streams every matching event as CSV or JSON Lines, newest first, up to 100,000 rows.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequired	string (uuid)	Workspace ID.
query api_id	string	Only events for this API.
query customer_id	string	Only events for this customer.
query action	string	Action prefix, for example customer. or key.revoked.
query actor	string	Actor type: user, key, portal_user, system, stripe or admin.
query q	string	Matches the summary or actor name. Up to 100 characters.
query before	string	Cursor from next_before.
query since	string	Only events after this RFC 3339 time.
query limit	integer	1 to 200. Defaults to 50.
query format	string	One of csv, json. Defaults to "csv".

Response 200

OK

Example request

curl "https://microauth.com/api/v1/workspaces/{wid}/audit/export" \
  -H "Authorization: Bearer mak_..."

SDK

Called by the SDK, or by your own integration, with the SDK secret key. These live on https://api.microauth.com.

GET Get the access snapshot

/sdk/v1/snapshot

Customers, key hashes and effective limits for the API that owns the secret. Poll it about every 30 seconds with If-None-Match.

Auth SDK secret keyServer https://api.microauth.com

Parameters

header If-None-Match

string

Response 200

header ETag	string	Send it back as If-None-Match to get a 304 when nothing changed.
header X-MicroAuth-Generated-At	string	generated_at of the snapshot, sent on 304 responses too.
billable_status_codes	array of integers or null	Responses with these status codes are charged. Report every status, since all of them count toward quotas.
customers	array of objects or null
customers[].balance_seq	integer	Grows with every balance change. Compare it to order balance observations of one customer.
customers[].credit_balance_micro	integer
customers[].effective	object
customers[].effective.billing_model	string	One of payg, subscription, none.
customers[].effective.monthly_quota	integer
customers[].effective.price_per_request_micro	integer
customers[].effective.rps	integer
customers[].effective.source	string	One of custom, plan, payg.
customers[].id	string
customers[].month_requests	integer
customers[].policy_valid_until	string (date-time)
customers[].status	string	One of active, pending, suspended.
customers[].usage_policy_id	string (uuid)	Send it back with usage so late reports are billed at this price.
generated_at	string (date-time)
keys	array of objects or null
keys[].customer_id	string
keys[].id	string
keys[].key_hash	string	Lowercase sha256 hex of the full API key.
platform_hard_cap	boolean
platform_monthly_allowance	object	The same numbers in the shape older SDKs read.
platform_monthly_allowance.hard_cap	boolean
platform_monthly_allowance.limit	integer
platform_monthly_allowance.period_end	string (date-time)
platform_monthly_allowance.period_start	string (date-time)
platform_monthly_allowance.remaining	integer
platform_monthly_allowance.used	integer
platform_monthly_limit	integer
platform_monthly_remaining	integer
platform_monthly_used	integer
platform_period_end	string (date-time)
tenant_id	string
tenant_name	string

Example request

curl "https://api.microauth.com/sdk/v1/snapshot" \
  -H "Authorization: Bearer mas_..."

Example response

{
  "billable_status_codes": [
    0
  ],
  "customers": [
    {
      "balance_seq": 0,
      "credit_balance_micro": 0,
      "effective": {
        "billing_model": "payg",
        "monthly_quota": 0,
        "price_per_request_micro": 0,
        "rps": 0,
        "source": "custom"
      },
      "id": "string",
      "month_requests": 0,
      "policy_valid_until": "2026-10-11T12:00:00Z",
      "status": "active",
      "usage_policy_id": "0199d4f2-6c1e-7a3b-9f10-2b6c8d4e5a71"
    }
  ],
  "generated_at": "2026-10-11T12:00:00Z",
  "keys": [
    {
      "customer_id": "string",
      "id": "string",
      "key_hash": "string"
    }
  ],
  "platform_hard_cap": true,
  "platform_monthly_allowance": {
    "hard_cap": true,
    "limit": 0,
    "period_end": "2026-10-11T12:00:00Z",
    "period_start": "2026-10-11T12:00:00Z",
    "remaining": 0,
    "used": 0
  },
  "platform_monthly_limit": 0,
  "platform_monthly_remaining": 0,
  "platform_monthly_used": 0,
  "platform_period_end": "2026-10-11T12:00:00Z",
  "tenant_id": "string",
  "tenant_name": "string"
}

GET Verify one key

/sdk/v1/keys/verify

Looks up a single key hash. Useful right after a developer creates a key, before the next snapshot.

Auth SDK secret keyServer https://api.microauth.com

Parameters

query key_hash

string

Lowercase sha256 hex of the API key your API received.

Response 200

billable_status_codes	array of integers or null
customer	object
customer.balance_seq	integer	Grows with every balance change. Compare it to order balance observations of one customer.
customer.credit_balance_micro	integer
customer.effective	object
customer.effective.billing_model	string	One of payg, subscription, none.
customer.effective.monthly_quota	integer
customer.effective.price_per_request_micro	integer
customer.effective.rps	integer
customer.effective.source	string	One of custom, plan, payg.
customer.id	string
customer.month_requests	integer
customer.policy_valid_until	string (date-time)
customer.status	string	One of active, pending, suspended.
customer.usage_policy_id	string (uuid)	Send it back with usage so late reports are billed at this price.
key_id	string
valid	boolean

Example request

curl "https://api.microauth.com/sdk/v1/keys/verify" \
  -H "Authorization: Bearer mas_..."

Example response

{
  "billable_status_codes": [
    0
  ],
  "customer": {
    "balance_seq": 0,
    "credit_balance_micro": 0,
    "effective": {
      "billing_model": "payg",
      "monthly_quota": 0,
      "price_per_request_micro": 0,
      "rps": 0,
      "source": "custom"
    },
    "id": "string",
    "month_requests": 0,
    "policy_valid_until": "2026-10-11T12:00:00Z",
    "status": "active",
    "usage_policy_id": "0199d4f2-6c1e-7a3b-9f10-2b6c8d4e5a71"
  },
  "key_id": "string",
  "valid": true
}

POST Report usage

/sdk/v1/usage

Reports served requests. Every item is idempotent by idempotency_key. Items marked retry can be sent again unchanged.

Auth SDK secret keyServer https://api.microauth.com

Request body

itemsrequired	array of objects or null	1 to 1,000 items.
items[].api_key_id	string	The key id from the snapshot.
items[].count	integer	Number of requests, 1 to 10,000,000.
items[].idempotency_keyrequired	string	8 to 128 letters, digits, dots, underscores, colons or dashes. Keep it the same across retries.
items[].key_id	string	Older name for api_key_id.
items[].period_startrequired	string (date-time)	When the request happened. Usage is grouped by UTC hour.
items[].requests	integer	Older name for count.
items[].status_coderequired	integer	The HTTP status your API answered with.
items[].usage_policy_id	string	usage_policy_id from the snapshot that admitted the request.

Response 200

accepted	integer	Items accepted by this call.
customers	array of objects or null	Balances after this report for every customer with an accepted or duplicate item.
customers[].balance_seq	integer
customers[].credit_balance_micro	integer
customers[].id	string
results	array of objects or null
results[].charged_micro	integer	What the item charged the customer, in micro-USD. For a duplicate it is the original charge. Set on accepted and duplicate items.
results[].customer_id	string	The customer the item was recorded for. Set on accepted and duplicate items.
results[].detail	string
results[].http_status	integer
results[].idempotency_key	string
results[].recorded_at	string (date-time)	When MicroAuth first recorded the item. Set on accepted and duplicate items.
results[].status	string	One of accepted, duplicate, rejected, retry.

Example request

curl -X POST "https://api.microauth.com/sdk/v1/usage" \
  -H "Authorization: Bearer mas_..." \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    {
      "api_key_id": "string",
      "count": 0,
      "idempotency_key": "string",
      "key_id": "string",
      "period_start": "2026-10-11T12:00:00Z",
      "requests": 0,
      "status_code": 0,
      "usage_policy_id": "string"
    }
  ]
}'

Example response

{
  "accepted": 0,
  "customers": [
    {
      "balance_seq": 0,
      "credit_balance_micro": 0,
      "id": "string"
    }
  ],
  "results": [
    {
      "charged_micro": 0,
      "customer_id": "string",
      "detail": "string",
      "http_status": 0,
      "idempotency_key": "string",
      "recorded_at": "2026-10-11T12:00:00Z",
      "status": "accepted"
    }
  ]
}

Account

Your own profile, password and two factor authentication. These need a dashboard session.

GET Current user and workspaces

/api/v1/me

Auth Dashboard sessionServer https://microauth.com

Response 200

user	object
user.created_at	string (date-time)
user.email	string
user.id	string
user.is_admin	boolean
user.name	string
user.two_factor	boolean
workspaces	array of objects or null
workspaces[].api_count	integer
workspaces[].created_at	string (date-time)
workspaces[].id	string
workspaces[].name	string
workspaces[].role	string

Example response

{
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "two_factor": true
  },
  "workspaces": [
    {
      "api_count": 0,
      "created_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "name": "string",
      "role": "string"
    }
  ]
}

PATCH Update your profile

/api/v1/me

Auth Dashboard sessionServer https://microauth.com

Request body

namerequired

string

Up to 100 characters.

Response 200

created_at	string (date-time)
email	string
id	string
is_admin	boolean
name	string
two_factor	boolean

Example response

{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "id": "string",
  "is_admin": true,
  "name": "string",
  "two_factor": true
}

POST Change your password

/api/v1/me/password

Auth Dashboard sessionServer https://microauth.com

Request body

current_passwordrequired	string	Up to 200 characters.
passwordrequired	string	Up to 72 characters.

Response 200

ok

boolean

Example response

{
  "ok": true
}

POST Start two factor setup

/api/v1/me/2fa/setup

Auth Dashboard sessionServer https://microauth.com

Response 200

secret	string	Base32 secret for manual entry.
uri	string	otpauth:// link to show as a QR code.

Example response

{
  "secret": "string",
  "uri": "string"
}

POST Turn on two factor authentication

/api/v1/me/2fa/enable

Auth Dashboard sessionServer https://microauth.com

Request body

coderequired

string

Up to 20 characters.

Response 200

recovery_codes

array of strings or null

Shown once. Each code signs in one time.

Example response

{
  "recovery_codes": [
    "string"
  ]
}

POST Turn off two factor authentication

/api/v1/me/2fa/disable

Auth Dashboard sessionServer https://microauth.com

Request body

coderequired	string	Up to 20 characters.
passwordrequired	string	Up to 200 characters.

Response 200

ok

boolean

Example response

{
  "ok": true
}

POST Replace recovery codes

/api/v1/me/2fa/recovery-codes

Auth Dashboard sessionServer https://microauth.com

Request body

coderequired	string	Up to 20 characters.
passwordrequired	string	Up to 200 characters.

Response 200

recovery_codes

array of strings or null

Shown once. Each code signs in one time.

Example response

{
  "recovery_codes": [
    "string"
  ]
}

Auth

Sign up and sign in. The dashboard calls these from the browser.

POST Send a sign up code

/api/v1/auth/signup

Emails a 6 digit code. Check it with /auth/signup/verify. The response is the same whether or not the email already has an account.

Auth NoneServer https://microauth.com

Request body

emailrequired

string

Email address. Up to 254 characters.

Response 202

sent

boolean

Example request

curl -X POST "https://microauth.com/api/v1/auth/signup" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string"
}'

Example response

{
  "sent": true
}

POST Check a sign up code

/api/v1/auth/signup/verify

Uses up the code and returns a ticket for /auth/signup/complete. An email that already has an account never gets a code, so it fails like a wrong code.

Auth NoneServer https://microauth.com

Request body

coderequired	string	The 6 digit code from the email. Up to 6 characters.
emailrequired	string	Up to 254 characters.

Response 200

expires_at	string (date-time)
ticket	string	Send this with the next step. It works once, for 30 minutes.

Example request

curl -X POST "https://microauth.com/api/v1/auth/signup/verify" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "email": "string"
}'

Example response

{
  "expires_at": "2026-10-11T12:00:00Z",
  "ticket": "string"
}

POST Create the account

/api/v1/auth/signup/complete

Auth NoneServer https://microauth.com

Request body

namerequired	string	Up to 100 characters.
passwordrequired	string	Up to 72 characters.
ticketrequired	string	From /auth/signup/verify. Up to 1,000 characters.
workspace	string	Workspace name, usually your company. Defaults to your name. Up to 100 characters.

Response 200

header Set-Cookie	string
user	object
user.created_at	string (date-time)
user.email	string
user.id	string
user.is_admin	boolean
user.name	string
user.two_factor	boolean
workspace_id	string

Example request

curl -X POST "https://microauth.com/api/v1/auth/signup/complete" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "password": "string",
  "ticket": "string",
  "workspace": "string"
}'

Example response

{
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "two_factor": true
  },
  "workspace_id": "string"
}

POST Sign in

/api/v1/auth/login

Auth NoneServer https://microauth.com

Request body

emailrequired	string	Up to 254 characters.
passwordrequired	string	Up to 200 characters.

Response 200

header Set-Cookie	string
challenge	string	Send this with the authenticator code to /auth/login/2fa.
two_factor_required	boolean
user	object
user.created_at	string (date-time)
user.email	string
user.id	string
user.is_admin	boolean
user.name	string
user.two_factor	boolean

Example request

curl -X POST "https://microauth.com/api/v1/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string",
  "password": "string"
}'

Example response

{
  "challenge": "string",
  "two_factor_required": true,
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "two_factor": true
  }
}

POST Finish signing in with two factor authentication

/api/v1/auth/login/2fa

Auth NoneServer https://microauth.com

Request body

challengerequired	string
coderequired	string	Authenticator code or a recovery code. Up to 20 characters.

Response 200

header Set-Cookie	string
challenge	string	Send this with the authenticator code to /auth/login/2fa.
two_factor_required	boolean
user	object
user.created_at	string (date-time)
user.email	string
user.id	string
user.is_admin	boolean
user.name	string
user.two_factor	boolean

Example request

curl -X POST "https://microauth.com/api/v1/auth/login/2fa" \
  -H "Content-Type: application/json" \
  -d '{
  "challenge": "string",
  "code": "string"
}'

Example response

{
  "challenge": "string",
  "two_factor_required": true,
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "two_factor": true
  }
}

POST Sign out

/api/v1/auth/logout

Auth NoneServer https://microauth.com

Parameters

cookie ma_session

string

Response 200

header Set-Cookie	string
ok	boolean

Example request

curl -X POST "https://microauth.com/api/v1/auth/logout"

Example response

{
  "ok": true
}

POST Send a password reset code

/api/v1/auth/password/forgot

Auth NoneServer https://microauth.com

Request body

emailrequired

string

Email address. Up to 254 characters.

Response 202

sent

boolean

Example request

curl -X POST "https://microauth.com/api/v1/auth/password/forgot" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string"
}'

Example response

{
  "sent": true
}

POST Check a password reset code

/api/v1/auth/password/verify

Uses up the code and returns a ticket for /auth/password/reset.

Auth NoneServer https://microauth.com

Request body

coderequired	string	The 6 digit code from the email. Up to 6 characters.
emailrequired	string	Up to 254 characters.

Response 200

expires_at	string (date-time)
ticket	string	Send this with the next step. It works once, for 30 minutes.

Example request

curl -X POST "https://microauth.com/api/v1/auth/password/verify" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "email": "string"
}'

Example response

{
  "expires_at": "2026-10-11T12:00:00Z",
  "ticket": "string"
}

POST Reset the password

/api/v1/auth/password/reset

Auth NoneServer https://microauth.com

Request body

passwordrequired	string	Up to 72 characters.
ticketrequired	string	From /auth/password/verify. Up to 1,000 characters.

Response 200

header Set-Cookie	string
signed_in	boolean
user	object
user.created_at	string (date-time)
user.email	string
user.id	string
user.is_admin	boolean
user.name	string
user.two_factor	boolean

Example request

curl -X POST "https://microauth.com/api/v1/auth/password/reset" \
  -H "Content-Type: application/json" \
  -d '{
  "password": "string",
  "ticket": "string"
}'

Example response

{
  "signed_in": true,
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "two_factor": true
  }
}

GET Look up a workspace invite

/api/v1/auth/invites/{token}

Auth NoneServer https://microauth.com

Parameters

tokenrequired

string

Token from the invite link. Up to 100 characters.

Response 200

account_exists	boolean
email	string
expires_at	string (date-time)
role	string
workspace	string

Example request

curl "https://microauth.com/api/v1/auth/invites/{token}"

Example response

{
  "account_exists": true,
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "role": "string",
  "workspace": "string"
}

POST Accept a workspace invite

/api/v1/auth/invites/{token}/accept

Auth NoneServer https://microauth.com

Parameters

cookie ma_session	string
tokenrequired	string	Token from the invite link. Up to 100 characters.

Request body

name	string	Up to 100 characters.
password	string	Up to 72 characters.

Response 200

header Set-Cookie	string
user	object
user.created_at	string (date-time)
user.email	string
user.id	string
user.is_admin	boolean
user.name	string
user.two_factor	boolean
workspace_id	string

Example request

curl -X POST "https://microauth.com/api/v1/auth/invites/{token}/accept" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "password": "string"
}'

Example response

{
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "two_factor": true
  },
  "workspace_id": "string"
}