Orb MCP by usefulapi is an MCP server published by io.usefulapi, hosted at orb.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 26 tools, including orb_ping, orb_list_customers, orb_get_customer, orb_get_customer_by_external_id, orb_get_customer_costs.
Read Orb customers, subscriptions, invoices, usage and costs; create or update customers.
3,998 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Health and auth check — verifies the API key works. Orb API: GET /ping.
No parameters.
{
"name": "orb_ping",
"title": "Ping / auth check",
"description": "Health and auth check — verifies the API key works. Orb API: GET /ping.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Ping / auth check",
"readOnlyHint": true
}
}List customers in the Orb account. Orb API: GET /customers.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
{
"name": "orb_list_customers",
"title": "List customers",
"description": "List customers in the Orb account. Orb API: GET /customers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
}
}
},
"annotations": {
"title": "List customers",
"readOnlyHint": true
}
}Fetch a single customer by Orb customer id. Orb API: GET /customers/{customer_id}.
| Parameter | Type | Description |
|---|---|---|
| customer_id * | string | Orb customer id. |
{
"name": "orb_get_customer",
"title": "Get customer",
"description": "Fetch a single customer by Orb customer id. Orb API: GET /customers/{customer_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"customer_id": {
"type": "string",
"description": "Orb customer id."
}
}
},
"annotations": {
"title": "Get customer",
"readOnlyHint": true
}
}Fetch a single customer by your external customer id. Orb API: GET /customers/external_customer_id/{external_customer_id}.
| Parameter | Type | Description |
|---|---|---|
| external_customer_id * | string | Your external customer id. |
{
"name": "orb_get_customer_by_external_id",
"title": "Get customer by external id",
"description": "Fetch a single customer by your external customer id. Orb API: GET /customers/external_customer_id/{external_customer_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"external_customer_id"
],
"properties": {
"external_customer_id": {
"type": "string",
"description": "Your external customer id."
}
}
},
"annotations": {
"title": "Get customer by external id",
"readOnlyHint": true
}
}Get costs incurred by a customer over a timeframe. Orb API: GET /customers/{customer_id}/costs.
| Parameter | Type | Description |
|---|---|---|
| group_by | string | Price grouping key to break costs down by. |
| view_mode | string | periodic or cumulative. |
| customer_id * | string | Orb customer id. |
| timeframe_end | string | ISO-8601 datetime, exclusive end. |
| timeframe_start | string | ISO-8601 datetime, inclusive start. |
{
"name": "orb_get_customer_costs",
"title": "Get customer costs",
"description": "Get costs incurred by a customer over a timeframe. Orb API: GET /customers/{customer_id}/costs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"group_by": {
"type": "string",
"description": "Price grouping key to break costs down by."
},
"view_mode": {
"enum": [
"periodic",
"cumulative"
],
"type": "string",
"description": "periodic or cumulative."
},
"customer_id": {
"type": "string",
"description": "Orb customer id."
},
"timeframe_end": {
"type": "string",
"description": "ISO-8601 datetime, exclusive end."
},
"timeframe_start": {
"type": "string",
"description": "ISO-8601 datetime, inclusive start."
}
}
},
"annotations": {
"title": "Get customer costs",
"readOnlyHint": true
}
}Get a customer's credit balances by currency. Orb API: GET /customers/{customer_id}/credits.
| Parameter | Type | Description |
|---|---|---|
| currency | string | Filter to a single currency. |
| customer_id * | string | Orb customer id. |
| include_all_blocks | boolean | Include expired/depleted blocks too. |
{
"name": "orb_get_customer_credits",
"title": "Get customer credit balances",
"description": "Get a customer's credit balances by currency. Orb API: GET /customers/{customer_id}/credits.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"currency": {
"type": "string",
"description": "Filter to a single currency."
},
"customer_id": {
"type": "string",
"description": "Orb customer id."
},
"include_all_blocks": {
"type": "boolean",
"description": "Include expired/depleted blocks too."
}
}
},
"annotations": {
"title": "Get customer credit balances",
"readOnlyHint": true
}
}Get the append-only credit ledger for a customer. Orb API: GET /customers/{customer_id}/credits/ledger.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
| currency | string | Filter to a single currency. |
| entry_type | string | Filter to a ledger entry type (e.g. increment, decrement, expiration_change). |
| customer_id * | string | Orb customer id. |
{
"name": "orb_get_customer_credits_ledger",
"title": "Get customer credit ledger",
"description": "Get the append-only credit ledger for a customer. Orb API: GET /customers/{customer_id}/credits/ledger.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
},
"currency": {
"type": "string",
"description": "Filter to a single currency."
},
"entry_type": {
"type": "string",
"description": "Filter to a ledger entry type (e.g. increment, decrement, expiration_change)."
},
"customer_id": {
"type": "string",
"description": "Orb customer id."
}
}
},
"annotations": {
"title": "Get customer credit ledger",
"readOnlyHint": true
}
}List plans configured in the Orb account. Orb API: GET /plans.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
| status | string | Filter by plan status. |
{
"name": "orb_list_plans",
"title": "List plans",
"description": "List plans configured in the Orb account. Orb API: GET /plans.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
},
"status": {
"enum": [
"active",
"archived",
"draft"
],
"type": "string",
"description": "Filter by plan status."
}
}
},
"annotations": {
"title": "List plans",
"readOnlyHint": true
}
}Fetch a single plan by id. Orb API: GET /plans/{plan_id}.
| Parameter | Type | Description |
|---|---|---|
| plan_id * | string | Orb plan id. |
{
"name": "orb_get_plan",
"title": "Get plan",
"description": "Fetch a single plan by id. Orb API: GET /plans/{plan_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"plan_id"
],
"properties": {
"plan_id": {
"type": "string",
"description": "Orb plan id."
}
}
},
"annotations": {
"title": "Get plan",
"readOnlyHint": true
}
}List subscriptions, optionally filtered by customer or status. Orb API: GET /subscriptions.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
| status | string | Filter by subscription status. |
| customer_id | string | Filter to an Orb customer id. |
| external_customer_id | string | Filter to your external customer id. |
{
"name": "orb_list_subscriptions",
"title": "List subscriptions",
"description": "List subscriptions, optionally filtered by customer or status. Orb API: GET /subscriptions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
},
"status": {
"enum": [
"active",
"ended",
"upcoming"
],
"type": "string",
"description": "Filter by subscription status."
},
"customer_id": {
"type": "string",
"description": "Filter to an Orb customer id."
},
"external_customer_id": {
"type": "string",
"description": "Filter to your external customer id."
}
}
},
"annotations": {
"title": "List subscriptions",
"readOnlyHint": true
}
}Fetch a single subscription by id. Orb API: GET /subscriptions/{subscription_id}.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | string | Orb subscription id. |
{
"name": "orb_get_subscription",
"title": "Get subscription",
"description": "Fetch a single subscription by id. Orb API: GET /subscriptions/{subscription_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "string",
"description": "Orb subscription id."
}
}
},
"annotations": {
"title": "Get subscription",
"readOnlyHint": true
}
}Get costs for a subscription over a timeframe. Orb API: GET /subscriptions/{subscription_id}/costs.
| Parameter | Type | Description |
|---|---|---|
| group_by | string | Price grouping key to break costs down by. |
| view_mode | string | periodic or cumulative. |
| timeframe_end | string | ISO-8601 datetime, exclusive end. |
| subscription_id * | string | Orb subscription id. |
| timeframe_start | string | ISO-8601 datetime, inclusive start. |
{
"name": "orb_get_subscription_costs",
"title": "Get subscription costs",
"description": "Get costs for a subscription over a timeframe. Orb API: GET /subscriptions/{subscription_id}/costs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"group_by": {
"type": "string",
"description": "Price grouping key to break costs down by."
},
"view_mode": {
"enum": [
"periodic",
"cumulative"
],
"type": "string",
"description": "periodic or cumulative."
},
"timeframe_end": {
"type": "string",
"description": "ISO-8601 datetime, exclusive end."
},
"subscription_id": {
"type": "string",
"description": "Orb subscription id."
},
"timeframe_start": {
"type": "string",
"description": "ISO-8601 datetime, inclusive start."
}
}
},
"annotations": {
"title": "Get subscription costs",
"readOnlyHint": true
}
}Get metered usage for a subscription over a timeframe. Orb API: GET /subscriptions/{subscription_id}/usage.
| Parameter | Type | Description |
|---|---|---|
| group_by | string | Property to group usage by. |
| granularity | string | Time granularity for buckets (e.g. day). |
| timeframe_end | string | ISO-8601 datetime, exclusive end. |
| subscription_id * | string | Orb subscription id. |
| timeframe_start | string | ISO-8601 datetime, inclusive start. |
{
"name": "orb_get_subscription_usage",
"title": "Get subscription usage",
"description": "Get metered usage for a subscription over a timeframe. Orb API: GET /subscriptions/{subscription_id}/usage.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"group_by": {
"type": "string",
"description": "Property to group usage by."
},
"granularity": {
"type": "string",
"description": "Time granularity for buckets (e.g. day)."
},
"timeframe_end": {
"type": "string",
"description": "ISO-8601 datetime, exclusive end."
},
"subscription_id": {
"type": "string",
"description": "Orb subscription id."
},
"timeframe_start": {
"type": "string",
"description": "ISO-8601 datetime, inclusive start."
}
}
},
"annotations": {
"title": "Get subscription usage",
"readOnlyHint": true
}
}Get the plan-change schedule for a subscription. Orb API: GET /subscriptions/{subscription_id}/schedule.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
| subscription_id * | string | Orb subscription id. |
{
"name": "orb_get_subscription_schedule",
"title": "Get subscription schedule",
"description": "Get the plan-change schedule for a subscription. Orb API: GET /subscriptions/{subscription_id}/schedule.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
},
"subscription_id": {
"type": "string",
"description": "Orb subscription id."
}
}
},
"annotations": {
"title": "Get subscription schedule",
"readOnlyHint": true
}
}List invoices, optionally filtered by customer, subscription, or status. Orb API: GET /invoices.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
| status | string | Filter by invoice status (e.g. draft, issued, paid, void). |
| due_date | string | ISO-8601 date filter. |
| date_type | string | Which date `due_date` filters on (e.g. due_date, invoice_date). |
| customer_id | string | Filter to an Orb customer id. |
| subscription_id | string | Filter to a subscription id. |
| external_customer_id | string | Filter to your external customer id. |
{
"name": "orb_list_invoices",
"title": "List invoices",
"description": "List invoices, optionally filtered by customer, subscription, or status. Orb API: GET /invoices.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
},
"status": {
"type": "string",
"description": "Filter by invoice status (e.g. draft, issued, paid, void)."
},
"due_date": {
"type": "string",
"description": "ISO-8601 date filter."
},
"date_type": {
"type": "string",
"description": "Which date `due_date` filters on (e.g. due_date, invoice_date)."
},
"customer_id": {
"type": "string",
"description": "Filter to an Orb customer id."
},
"subscription_id": {
"type": "string",
"description": "Filter to a subscription id."
},
"external_customer_id": {
"type": "string",
"description": "Filter to your external customer id."
}
}
},
"annotations": {
"title": "List invoices",
"readOnlyHint": true
}
}Fetch a single invoice by id. Orb API: GET /invoices/{invoice_id}.
| Parameter | Type | Description |
|---|---|---|
| invoice_id * | string | Orb invoice id. |
{
"name": "orb_get_invoice",
"title": "Get invoice",
"description": "Fetch a single invoice by id. Orb API: GET /invoices/{invoice_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id"
],
"properties": {
"invoice_id": {
"type": "string",
"description": "Orb invoice id."
}
}
},
"annotations": {
"title": "Get invoice",
"readOnlyHint": true
}
}Preview the upcoming (draft) invoice for a subscription. Orb API: GET /invoices/upcoming.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | string | Orb subscription id. |
{
"name": "orb_get_upcoming_invoice",
"title": "Get upcoming invoice",
"description": "Preview the upcoming (draft) invoice for a subscription. Orb API: GET /invoices/upcoming.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "string",
"description": "Orb subscription id."
}
}
},
"annotations": {
"title": "Get upcoming invoice",
"readOnlyHint": true
}
}List items (the things you bill for). Orb API: GET /items.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
{
"name": "orb_list_items",
"title": "List items",
"description": "List items (the things you bill for). Orb API: GET /items.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
}
}
},
"annotations": {
"title": "List items",
"readOnlyHint": true
}
}Fetch a single item by id. Orb API: GET /items/{item_id}.
| Parameter | Type | Description |
|---|---|---|
| item_id * | string | Orb item id. |
{
"name": "orb_get_item",
"title": "Get item",
"description": "Fetch a single item by id. Orb API: GET /items/{item_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"item_id"
],
"properties": {
"item_id": {
"type": "string",
"description": "Orb item id."
}
}
},
"annotations": {
"title": "Get item",
"readOnlyHint": true
}
}List prices configured in the Orb account. Orb API: GET /prices.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
{
"name": "orb_list_prices",
"title": "List prices",
"description": "List prices configured in the Orb account. Orb API: GET /prices.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
}
}
},
"annotations": {
"title": "List prices",
"readOnlyHint": true
}
}Fetch a single price by id. Orb API: GET /prices/{price_id}.
| Parameter | Type | Description |
|---|---|---|
| price_id * | string | Orb price id. |
{
"name": "orb_get_price",
"title": "Get price",
"description": "Fetch a single price by id. Orb API: GET /prices/{price_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"price_id"
],
"properties": {
"price_id": {
"type": "string",
"description": "Orb price id."
}
}
},
"annotations": {
"title": "Get price",
"readOnlyHint": true
}
}List billable metrics configured in the Orb account. Orb API: GET /metrics.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
{
"name": "orb_list_metrics",
"title": "List billable metrics",
"description": "List billable metrics configured in the Orb account. Orb API: GET /metrics.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
}
}
},
"annotations": {
"title": "List billable metrics",
"readOnlyHint": true
}
}List coupons in the Orb account. Orb API: GET /coupons.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
| show_archived | boolean | Include archived coupons. |
{
"name": "orb_list_coupons",
"title": "List coupons",
"description": "List coupons in the Orb account. Orb API: GET /coupons.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
},
"show_archived": {
"type": "boolean",
"description": "Include archived coupons."
}
}
},
"annotations": {
"title": "List coupons",
"readOnlyHint": true
}
}List usage/spend alerts, optionally filtered by customer or subscription. Orb API: GET /alerts.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max items to return (1–100, default 20). |
| cursor | string | Opaque pagination cursor (from pagination_metadata.next_cursor). |
| customer_id | string | Filter to an Orb customer id. |
| subscription_id | string | Filter to a subscription id. |
| external_customer_id | string | Filter to your external customer id. |
{
"name": "orb_list_alerts",
"title": "List alerts",
"description": "List usage/spend alerts, optionally filtered by customer or subscription. Orb API: GET /alerts.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max items to return (1–100, default 20)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor (from pagination_metadata.next_cursor)."
},
"customer_id": {
"type": "string",
"description": "Filter to an Orb customer id."
},
"subscription_id": {
"type": "string",
"description": "Filter to a subscription id."
},
"external_customer_id": {
"type": "string",
"description": "Filter to your external customer id."
}
}
},
"annotations": {
"title": "List alerts",
"readOnlyHint": true
}
}Creates a new customer in Orb (additive). Requires name and a valid email. Orb API: POST /customers.
| Parameter | Type | Description |
|---|---|---|
| name * | string | Customer display name (required). |
| email * | string | Customer billing email (required, must be a valid email). |
| currency | string | ISO-4217 currency code for this customer. |
| metadata | object | User-defined key/value metadata (string→string). |
| timezone | string | IANA timezone (e.g. America/New_York). |
| payment_provider | string | External payment/invoicing provider. |
| payment_provider_id | string | Id of this customer in the external payment provider. |
| external_customer_id | string | Your external id for this customer. |
{
"name": "orb_create_customer",
"title": "Create customer",
"description": "Creates a new customer in Orb (additive). Requires name and a valid email. Orb API: POST /customers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"email"
],
"properties": {
"name": {
"type": "string",
"description": "Customer display name (required)."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Customer billing email (required, must be a valid email)."
},
"currency": {
"type": "string",
"description": "ISO-4217 currency code for this customer."
},
"metadata": {
"type": "object",
"description": "User-defined key/value metadata (string→string).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"timezone": {
"type": "string",
"description": "IANA timezone (e.g. America/New_York)."
},
"payment_provider": {
"enum": [
"quickbooks",
"bill.com",
"stripe_charge",
"stripe_invoice",
"netsuite",
"adyen"
],
"type": "string",
"description": "External payment/invoicing provider."
},
"payment_provider_id": {
"type": "string",
"description": "Id of this customer in the external payment provider."
},
"external_customer_id": {
"type": "string",
"description": "Your external id for this customer."
}
}
},
"annotations": {
"title": "Create customer",
"destructiveHint": true
}
}Updates an existing customer's details (reversible). Only provided fields are changed. Orb API: PUT /customers/{customer_id}.
| Parameter | Type | Description |
|---|---|---|
| name | string | New display name. |
| string | New billing email (must be a valid email). | |
| currency | string | New ISO-4217 currency code. |
| metadata | object | User-defined key/value metadata (string→string). |
| timezone | string | New IANA timezone. |
| customer_id * | string | Orb customer id (required). |
| payment_provider | string | External payment/invoicing provider. |
| payment_provider_id | string | New id in the external payment provider. |
| external_customer_id | string | New external id. |
Tools for Orb, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Show usage for subscription ID sub-1042 over the last 30 days."; "List all unpaid invoices and which customers they belong to."; "Preview the next invoice for subscription ID sub-1042.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Orb data. Free plan: 50 tool calls per month. Run orb_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run orb_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run orb_upgrade without a plan: it returns both plans, each with a payment link for the user to open. orb_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
{
"name": "orb_update_customer",
"title": "Update customer",
"description": "Updates an existing customer's details (reversible). Only provided fields are changed. Orb API: PUT /customers/{customer_id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"name": {
"type": "string",
"description": "New display name."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "New billing email (must be a valid email)."
},
"currency": {
"type": "string",
"description": "New ISO-4217 currency code."
},
"metadata": {
"type": "object",
"description": "User-defined key/value metadata (string→string).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"timezone": {
"type": "string",
"description": "New IANA timezone."
},
"customer_id": {
"type": "string",
"description": "Orb customer id (required)."
},
"payment_provider": {
"enum": [
"quickbooks",
"bill.com",
"stripe_charge",
"stripe_invoice",
"netsuite",
"adyen"
],
"type": "string",
"description": "External payment/invoicing provider."
},
"payment_provider_id": {
"type": "string",
"description": "New id in the external payment provider."
},
"external_customer_id": {
"type": "string",
"description": "New external id."
}
}
},
"annotations": {
"title": "Update customer",
"destructiveHint": true
}
}