Appwrite

Appwrite Organizations API

The Organizations service allows you to manage organization billing, plans, invoices, and add-ons. 45 operations across 38 paths in the Appwrite 2.0.0 OpenAPI.

GitHub OpenAPI

Operations 45

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /organizations List organizations I belong to · List Orgnizations #
Ask an LLM
“Which Appwrite organizations am I a member of?”
“Can I search the organizations on my account by name?”
Tell an agent
List all organizations I'm a member of.
Search my organizations for {search}.
POST /organizations Create a new billed organization · Create Organization #
Ask an LLM
“How do I create a new organization on a paid billing plan?”
“Can I invite teammates and apply a coupon while creating an organization?”
Tell an agent
Create organization {organizationId} named {name} on plan {billingPlan}.
Start org {organizationId} called {name} on {billingPlan}, paying with {paymentMethodId} and coupon {couponId}.
PATCH /organizations/estimations/create-organization Estimate the cost of a new organization · Estimate create Organization #
Ask an LLM
“What would it cost to open a new organization on a given plan before I commit?”
“Does inviting extra members change the estimate for creating an organization?”
Tell an agent
Estimate the price of creating an organization on {billingPlan}.
Quote a new org on {billingPlan} with invites {invites} and coupon {couponId}.
DELETE /organizations/{organizationId} Delete an organization · Delete team #
Ask an LLM
“How do I delete one of my organizations entirely?”
“Can I remove an organization by ID from my account?”
Tell an agent destructive · confirm first
Delete organization {organizationId}.
Permanently remove org {organizationId}.
GET /organizations/{organizationId}/addons List an organization's billing addons · List addons #
Ask an LLM
“Which paid addons are active on my organization?”
“Does my org already have the BAA or Premium Geo DB addon?”
Tell an agent
List billing addons for organization {organizationId}.
Show which addons {organizationId} pays for.
POST /organizations/{organizationId}/addons/baa Add the BAA addon to an organization · Create BAA addon #
Ask an LLM
“How do I get a Business Associate Agreement for HIPAA workloads on my organization?”
“Is the BAA a separate billing addon I have to enable?”
Tell an agent
Add the BAA addon to organization {organizationId}.
Enable the Business Associate Agreement for {organizationId}.
POST /organizations/{organizationId}/addons/premium-geo-db Add the Premium Geo DB addon · Create Premium Geo DB addon #
Ask an LLM
“How do I turn on the Premium Geo DB addon for more detailed geolocation?”
“Can I buy the premium geo database as an organization addon?”
Tell an agent
Add the Premium Geo DB addon to organization {organizationId}.
Enable premium geolocation data for {organizationId}.
GET /organizations/{organizationId}/addons/{addonId} Get a billing addon's details · Get addon #
Ask an LLM
“What is the status of a specific addon on my organization?”
“Is my addon still awaiting payment confirmation?”
Tell an agent
Show addon {addonId} on organization {organizationId}.
Get the details of billing addon {addonId} for {organizationId}.
DELETE /organizations/{organizationId}/addons/{addonId} Cancel a billing addon · Delete addon #
Ask an LLM
“How do I stop paying for an addon I no longer need?”
“Can I remove the BAA addon from my organization?”
Tell an agent destructive · confirm first
Delete addon {addonId} from organization {organizationId}.
Cancel billing addon {addonId} on {organizationId}.
POST /organizations/{organizationId}/addons/{addonId}/confirmations Confirm an addon payment after 3DS · Confirm addon payment after 3DS authentication #
Ask an LLM
“My card required 3D Secure when buying an addon; how do I finish the payment?”
“What do I call after 3DS authentication to activate an addon?”
Tell an agent
Confirm payment for addon {addonId} on organization {organizationId}.
Complete the 3DS-authenticated charge for addon {addonId} in {organizationId}.
GET /organizations/{organizationId}/addons/{addon}/price Get the price of a billing addon · Get addon price #
Ask an LLM
“How much does an addon like BAA cost for my organization?”
“Can I check an addon's price before enabling it?”
Tell an agent
Get the price of the {addon} addon for organization {organizationId}.
Quote addon {addon} for {organizationId}.
GET /organizations/{organizationId}/aggregations List an organization's billing aggregations · List aggregations #
Ask an LLM
“Where can I see the billing-period usage aggregations for my organization?”
“Can I filter an organization's aggregations with queries?”
Tell an agent
List billing aggregations for organization {organizationId}.
Show aggregations for {organizationId} matching {queries}.
GET /organizations/{organizationId}/aggregations/{aggregationId} Get one billing aggregation · Get aggregation #
Ask an LLM
“What usage was billed in a particular aggregation period?”
“Can I page through the breakdown inside a single aggregation?”
Tell an agent
Show aggregation {aggregationId} for organization {organizationId}.
Get {limit} items of aggregation {aggregationId} in {organizationId} starting at {offset}.
PATCH /organizations/{organizationId}/billing-address Set an organization's billing address · Set team's billing address #
Ask an LLM
“How do I choose which saved address goes on my organization's invoices?”
“Can I switch my org to a different billing address?”
Tell an agent
Set organization {organizationId}'s billing address to {billingAddressId}.
Use saved address {billingAddressId} for billing on {organizationId}.
DELETE /organizations/{organizationId}/billing-address Remove an organization's billing address · Delete team's billing address #
Ask an LLM
“How do I clear the billing address from my organization?”
“Can I unset the address that appears on my invoices?”
Tell an agent destructive · confirm first
Delete the billing address of organization {organizationId}.
Clear the invoice address on {organizationId}.
GET /organizations/{organizationId}/billing-addresses/{billingAddressId} Get a billing address · Get billing address #
Ask an LLM
“What billing address is saved under a given ID for my organization?”
“Can I view the full details of one billing address?”
Tell an agent
Show billing address {billingAddressId} of organization {organizationId}.
Fetch address {billingAddressId} for {organizationId}.
PATCH /organizations/{organizationId}/billing-email Set an organization's billing email · Set team's billing email #
Ask an LLM
“How do I send invoices to our finance team's email instead of mine?”
“Can I change the billing contact email for an organization?”
Tell an agent
Set the billing email of organization {organizationId} to {billingEmail}.
Send {organizationId}'s invoices to {billingEmail}.
PATCH /organizations/{organizationId}/budget Set an organization's spending budget · Update organization budget #
Ask an LLM
“How do I cap my organization's monthly spend?”
“Can I get alerts as my organization approaches its budget limit?”
Tell an agent
Set the budget for organization {organizationId} to {budget}.
Cap {organizationId} spend at {budget} with alerts at {alerts} percent.
GET /organizations/{organizationId}/credits List an organization's credits · List credits #
Ask an LLM
“Which credits and coupons have been applied to my organization?”
“Can I filter an organization's credit history with queries?”
Tell an agent
List credits for organization {organizationId}.
Show {organizationId}'s credits matching {queries}.
POST /organizations/{organizationId}/credits Redeem a coupon for organization credits · Add credits from coupon #
Ask an LLM
“How do I redeem a promo coupon for credits on my organization?”
“Can a coupon code be added to an existing organization?”
Tell an agent
Redeem coupon {couponId} on organization {organizationId}.
Add credits from coupon {couponId} to {organizationId}.
GET /organizations/{organizationId}/credits/available Get an organization's available credit balance · Get available credits #
Ask an LLM
“How much valid credit does my organization have left to spend?”
“What's my total remaining credit balance?”
Tell an agent
Show the available credit balance for organization {organizationId}.
Total up the unused credits on {organizationId}.
GET /organizations/{organizationId}/credits/{creditId} Get one credit's details · Get credit details #
Ask an LLM
“When does a specific credit on my organization expire?”
“How much of one applied credit has been used?”
Tell an agent
Show credit {creditId} on organization {organizationId}.
Get details for credit {creditId} in {organizationId}.
PATCH /organizations/{organizationId}/estimations/delete-organization Estimate the charges for deleting an organization · Estimate delete team #
Ask an LLM
“Will I be charged anything outstanding if I delete my organization?”
“Can I preview the final bill before deleting an org?”
Tell an agent
Estimate the cost of deleting organization {organizationId}.
Preview what I'd owe if {organizationId} were deleted.
PATCH /organizations/{organizationId}/estimations/update-plan Estimate a plan change for an organization · Estimate for update plan #
Ask an LLM
“What would my bill look like if I switched my organization to another plan?”
“Does a coupon lower the estimate for changing plans?”
Tell an agent
Estimate switching organization {organizationId} to plan {billingPlan}.
Get a plan-update estimate for {organizationId} on {billingPlan} with coupon {couponId} and invites {invites}.
POST /organizations/{organizationId}/feedbacks/downgrade Submit feedback about a plan downgrade · Create downgrade feedback #
Ask an LLM
“Where can I tell the team why I'm downgrading my plan?”
“What details are asked for when leaving downgrade feedback?”
Tell an agent
Send downgrade feedback for {organizationId} from {fromPlanId} to {toPlanId}: reason {reason}, message {message}.
Record why {organizationId} moved from {fromPlanId} to {toPlanId}: {reason}, {message}.
GET /organizations/{organizationId}/invoices List an organization's invoices · List invoices #
Ask an LLM
“Where can I see all past invoices for my organization?”
“Can I filter invoices to only unpaid ones with a query?”
Tell an agent
List invoices for organization {organizationId}.
Show {organizationId}'s invoices matching {queries}.
GET /organizations/{organizationId}/invoices/{invoiceId} Get an invoice · Get invoice #
Ask an LLM
“What's the amount and status of a specific invoice?”
“How do I look up one invoice's line items by its ID?”
Tell an agent
Show invoice {invoiceId} for organization {organizationId}.
Get the details of invoice {invoiceId} in {organizationId}.
GET /organizations/{organizationId}/invoices/{invoiceId}/download Download an invoice PDF · Download invoice in PDF #
Ask an LLM
“How do I download an invoice as a PDF file for my accountant?”
“Can I save a copy of an invoice PDF locally?”
Tell an agent
Download the PDF of invoice {invoiceId} for organization {organizationId}.
Save invoice {invoiceId} from {organizationId} as a PDF file.
POST /organizations/{organizationId}/invoices/{invoiceId}/payments Retry payment on a failed invoice · Initiate payment for failed invoice to pay live from console #
Ask an LLM
“An invoice payment failed; how do I pay it now with another card?”
“Can I choose which payment method settles a failed invoice?”
Tell an agent
Pay failed invoice {invoiceId} of organization {organizationId} with payment method {paymentMethodId}.
Charge {paymentMethodId} for the unpaid invoice {invoiceId} in {organizationId}.
PATCH /organizations/{organizationId}/invoices/{invoiceId}/status Re-check an invoice's payment status · Validate the payment for an invoice and update status #
Ask an LLM
“I paid an invoice but it still shows unpaid; how do I refresh its status?”
“Can I sync an invoice's status with its payment after it changes?”
Tell an agent
Validate the payment for invoice {invoiceId} in organization {organizationId}.
Refresh the status of invoice {invoiceId} for {organizationId} from its payment.
GET /organizations/{organizationId}/invoices/{invoiceId}/view View an invoice PDF in the browser · View invoice in PDF #
Ask an LLM
“Can I open an invoice PDF inline to view it rather than download it?”
“How do I preview an invoice in the browser?”
Tell an agent
Open invoice {invoiceId} of organization {organizationId} for viewing.
Display the invoice {invoiceId} from {organizationId} inline.
PATCH /organizations/{organizationId}/payment-method Set an organization's default payment method · Set team's payment method #
Ask an LLM
“How do I change which card my organization is charged on by default?”
“Can I make a newly added card the primary payment method?”
Tell an agent
Set payment method {paymentMethodId} as the default for organization {organizationId}.
Charge {organizationId} on card {paymentMethodId} from now on.
DELETE /organizations/{organizationId}/payment-method Remove an organization's default payment method · Delete team's default payment method #
Ask an LLM
“How do I remove the primary card on my organization?”
“Can I unset the default payment method for an org?”
Tell an agent destructive · confirm first
Remove the default payment method from organization {organizationId}.
Unset the primary card on {organizationId}.
PATCH /organizations/{organizationId}/payment-method/backup Set an organization's backup payment method · Set team's backup payment method #
Ask an LLM
“Can I add a second card that is charged if the primary one fails?”
“How do I set a fallback payment method for my organization?”
Tell an agent
Set {paymentMethodId} as the backup payment method for organization {organizationId}.
Use card {paymentMethodId} as the fallback for {organizationId}.
DELETE /organizations/{organizationId}/payment-method/backup Remove an organization's backup payment method · Delete team's backup payment method #
Ask an LLM
“How do I remove the fallback card from my organization?”
“Can I delete a backup payment method but keep the primary one?”
Tell an agent destructive · confirm first
Remove the backup payment method from organization {organizationId}.
Delete the fallback card on {organizationId}.
GET /organizations/{organizationId}/payment-methods/{paymentMethodId} Get an organization's payment method · Get payment method #
Ask an LLM
“Which card brand and expiry is on a given payment method?”
“How can I look up one of my organization's payment methods by ID?”
Tell an agent
Show payment method {paymentMethodId} of organization {organizationId}.
Get card details for {paymentMethodId} in {organizationId}.
GET /organizations/{organizationId}/plan Get an organization's current billing plan · Get organization billing plan details #
Ask an LLM
“Which billing plan is my organization on right now?”
“What limits come with my organization's current plan?”
Tell an agent
Show the current plan for organization {organizationId}.
Get the billing plan details of {organizationId}.
PATCH /organizations/{organizationId}/plan Change an organization's billing plan · Update organization billing plan #
Ask an LLM
“How do I upgrade my organization to a higher plan?”
“Can I set a budget and tax ID while switching plans?”
Tell an agent
Switch organization {organizationId} to plan {billingPlan}.
Move {organizationId} to {billingPlan} paying with {paymentMethodId} and coupon {couponId}.
PATCH /organizations/{organizationId}/plan/cancel Cancel a pending plan downgrade · Cancel organization plan change #
Ask an LLM
“I scheduled a downgrade by mistake; can I cancel it?”
“How do I keep my current plan after initiating a downgrade?”
Tell an agent
Cancel the pending downgrade on organization {organizationId}.
Undo the scheduled plan change for {organizationId}.
POST /organizations/{organizationId}/plan/estimations Create an upgrade or downgrade plan estimate · Create billing plan estimation (upgrade or downgrade) #
Ask an LLM
“How do I create a saved estimation for upgrading or downgrading my organization's plan?”
“Can I factor extra member invites into a plan upgrade or downgrade estimation?”
Tell an agent
Create a plan estimation for {organizationId} moving to {billingPlan}.
Build an upgrade/downgrade estimation for {organizationId} to {billingPlan} with {invites} invites and coupon {couponId}.
GET /organizations/{organizationId}/regions List regions available to an organization · List Regions #
Ask an LLM
“Which regions can my organization deploy projects into?”
“Is a given hosting region available on my organization's plan?”
Tell an agent
List available regions for organization {organizationId}.
Show where {organizationId} can host projects.
GET /organizations/{organizationId}/roles Get my roles and scopes in an organization · Get Scopes #
Ask an LLM
“What permissions do I have in this organization?”
“Can I check my scopes for one specific project in the org?”
Tell an agent
Get my scopes in organization {organizationId}.
Show my roles in {organizationId} for project {projectId}.
PATCH /organizations/{organizationId}/taxId Set an organization's tax ID · Set team's tax Id #
Ask an LLM
“How do I add our VAT or tax ID to organization invoices?”
“Can I update the tax ID on my billing account?”
Tell an agent
Set the tax ID of organization {organizationId} to {taxId}.
Add VAT number {taxId} to {organizationId}'s billing.
GET /organizations/{organizationId}/usage Get an organization's usage data · Get team's usage data #
Ask an LLM
“What has my organization used so far across its projects?”
“Can I pull an organization's usage for a custom date range?”
Tell an agent
Show usage for organization {organizationId}.
Report {organizationId}'s usage from {startDate} to {endDate}.
PATCH /organizations/{organizationId}/validate Validate payment after creating or upgrading · Validate payment for the organization after creation or upgrade #
Ask an LLM
“After creating or upgrading an organization, how do I confirm the payment went through?”
“Are pending invites sent once the organization's payment is validated?”
Tell an agent
Validate the payment for organization {organizationId}.
Confirm {organizationId}'s upgrade payment and send invites {invites}.

Documentation

📖
Documentation
https://appwrite.io/docs
📖
APIReference
https://appwrite.io/docs/references

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-organizations-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/appwrite/appwrite

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/overlays/appwrite-organizations-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/appwrite:appwrite-organizations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

appwrite-organizations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.0.0
  title: Appwrite Organizations API
  description: Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to https://appwrite.io/docs
  termsOfService: https://appwrite.io/policy/terms
  contact:
    name: Appwrite Team
    url: https://appwrite.io/support
    email: team@appwrite.io
  license:
    name: BSD-3-Clause
    url: https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE
servers:
- url: https://cloud.appwrite.io/v1
  description: Appwrite Cloud endpoint.
- url: https://{region}.cloud.appwrite.io/v1
  description: Appwrite Cloud regional endpoint. Replace `{region}` with your project region.
  variables:
    region:
      default: fra
      description: Appwrite Cloud region.
tags:


# --- truncated at 32 KB (159 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-organizations-api-openapi.yml