|
| 1 | +# Flexprice MCP Server |
| 2 | + |
| 3 | +Official flexprice MCP Server |
| 4 | + |
| 5 | +[What is an MCP Server?](https://www.anthropic.com/news/model-context-protocol) |
| 6 | + |
| 7 | +## Characteristics |
| 8 | +Attribute|Details| |
| 9 | +|-|-| |
| 10 | +**Image Source**|Official Image |
| 11 | +**Docker Image**|[mcp/flexprice](https://hub.docker.com/repository/docker/mcp/flexprice) |
| 12 | +**Author**|[flexprice](https://github.com/flexprice) |
| 13 | +**Repository**|https://github.com/flexprice/mcp-server |
| 14 | +**Dockerfile**|https://github.com/flexprice/mcp-server/blob/main/Dockerfile |
| 15 | +**Docker Image built by**|Docker Inc. |
| 16 | +**Docker Scout Health Score**|  |
| 17 | +**Licence**|Apache License 2.0 |
| 18 | + |
| 19 | +## Available Tools |
| 20 | +Tools provided by this Server|Short Description |
| 21 | +-|- |
| 22 | +`getCustomerById`|Get a customer by ID| |
| 23 | +`getCustomerByLookupKey`|Get a customer by lookup key (external ID)| |
| 24 | +`getCustomerEntitlements`|Get a customer's entitlements| |
| 25 | +`getCustomerSubscriptions`|Get a customer's subscriptions| |
| 26 | +`getCustomerUsageSummary`|Get a customer's usage summary| |
| 27 | +`getCustomers`|Get all customers| |
| 28 | +`getEventsByCustomer`|Get events for a customer| |
| 29 | +`getInvoiceById`|Get an invoice by its ID| |
| 30 | +`getInvoiceByNumber`|Get an invoice by its number| |
| 31 | +`getInvoices`|Get invoices with optional filtering by date range and status| |
| 32 | +`getInvoicesByCustomerId`|Get all invoices for a specific customer| |
| 33 | +`getPaymentById`|Get a payment by ID| |
| 34 | +`getPayments`|Get payments with optional filtering| |
| 35 | +`getPlanById`|Get a plan by ID| |
| 36 | +`getPlans`|Get all plans| |
| 37 | +`getPriceById`|Get a price by ID| |
| 38 | +`getPrices`|Get all prices| |
| 39 | +`getSubscriptionById`|Get a subscription by ID| |
| 40 | +`getSubscriptionPauses`|Get all pauses for a subscription| |
| 41 | +`getSubscriptionUsage`|Get usage for a subscription| |
| 42 | +`getSubscriptions`|Get all subscriptions| |
| 43 | +`getWalletBalance`|Get the real-time balance of a wallet| |
| 44 | +`getWalletById`|Get a wallet by ID| |
| 45 | +`getWalletTransactions`|Get transactions for a wallet with pagination| |
| 46 | +`getWalletsByCustomerId`|Get all wallets for a customer| |
| 47 | + |
| 48 | +--- |
| 49 | +## Tools Details |
| 50 | + |
| 51 | +#### Tool: **`getCustomerById`** |
| 52 | +Get a customer by ID |
| 53 | +Parameters|Type|Description |
| 54 | +-|-|- |
| 55 | +`customerId`|`string`| |
| 56 | + |
| 57 | +--- |
| 58 | +#### Tool: **`getCustomerByLookupKey`** |
| 59 | +Get a customer by lookup key (external ID) |
| 60 | +Parameters|Type|Description |
| 61 | +-|-|- |
| 62 | +`lookupKey`|`string`| |
| 63 | + |
| 64 | +--- |
| 65 | +#### Tool: **`getCustomerEntitlements`** |
| 66 | +Get a customer's entitlements |
| 67 | +Parameters|Type|Description |
| 68 | +-|-|- |
| 69 | +`customerId`|`string`| |
| 70 | + |
| 71 | +--- |
| 72 | +#### Tool: **`getCustomerSubscriptions`** |
| 73 | +Get a customer's subscriptions |
| 74 | +Parameters|Type|Description |
| 75 | +-|-|- |
| 76 | +`customerId`|`string`| |
| 77 | + |
| 78 | +--- |
| 79 | +#### Tool: **`getCustomerUsageSummary`** |
| 80 | +Get a customer's usage summary |
| 81 | +Parameters|Type|Description |
| 82 | +-|-|- |
| 83 | +`customerId`|`string`| |
| 84 | + |
| 85 | +--- |
| 86 | +#### Tool: **`getCustomers`** |
| 87 | +Get all customers |
| 88 | +#### Tool: **`getEventsByCustomer`** |
| 89 | +Get events for a customer |
| 90 | +Parameters|Type|Description |
| 91 | +-|-|- |
| 92 | +`externalCustomerId`|`string`| |
| 93 | +`endTime`|`string` *optional*| |
| 94 | +`iterFirstKey`|`string` *optional*| |
| 95 | +`iterLastKey`|`string` *optional*| |
| 96 | +`startTime`|`string` *optional*| |
| 97 | + |
| 98 | +--- |
| 99 | +#### Tool: **`getInvoiceById`** |
| 100 | +Get an invoice by its ID |
| 101 | +Parameters|Type|Description |
| 102 | +-|-|- |
| 103 | +`invoiceId`|`string`| |
| 104 | + |
| 105 | +--- |
| 106 | +#### Tool: **`getInvoiceByNumber`** |
| 107 | +Get an invoice by its number |
| 108 | +Parameters|Type|Description |
| 109 | +-|-|- |
| 110 | +`invoiceNumber`|`string`| |
| 111 | + |
| 112 | +--- |
| 113 | +#### Tool: **`getInvoices`** |
| 114 | +Get invoices with optional filtering by date range and status |
| 115 | +Parameters|Type|Description |
| 116 | +-|-|- |
| 117 | +`endDate`|`string` *optional*|ISO format date string for filtering invoices until this date |
| 118 | +`limit`|`number` *optional*|Maximum number of invoices to return |
| 119 | +`offset`|`number` *optional*|Number of invoices to skip for pagination |
| 120 | +`startDate`|`string` *optional*|ISO format date string for filtering invoices from this date |
| 121 | +`status`|`string` *optional*|Filter invoices by status |
| 122 | + |
| 123 | +--- |
| 124 | +#### Tool: **`getInvoicesByCustomerId`** |
| 125 | +Get all invoices for a specific customer |
| 126 | +Parameters|Type|Description |
| 127 | +-|-|- |
| 128 | +`customerId`|`string`| |
| 129 | + |
| 130 | +--- |
| 131 | +#### Tool: **`getPaymentById`** |
| 132 | +Get a payment by ID |
| 133 | +Parameters|Type|Description |
| 134 | +-|-|- |
| 135 | +`paymentId`|`string`| |
| 136 | + |
| 137 | +--- |
| 138 | +#### Tool: **`getPayments`** |
| 139 | +Get payments with optional filtering |
| 140 | +Parameters|Type|Description |
| 141 | +-|-|- |
| 142 | +`customerId`|`string` *optional*|Filter payments by customer ID |
| 143 | +`limit`|`number` *optional*|Maximum number of payments to return |
| 144 | +`offset`|`number` *optional*|Number of payments to skip for pagination |
| 145 | +`status`|`string` *optional*|Filter payments by status (pending, processed, failed) |
| 146 | + |
| 147 | +--- |
| 148 | +#### Tool: **`getPlanById`** |
| 149 | +Get a plan by ID |
| 150 | +Parameters|Type|Description |
| 151 | +-|-|- |
| 152 | +`planId`|`string`| |
| 153 | + |
| 154 | +--- |
| 155 | +#### Tool: **`getPlans`** |
| 156 | +Get all plans |
| 157 | +#### Tool: **`getPriceById`** |
| 158 | +Get a price by ID |
| 159 | +Parameters|Type|Description |
| 160 | +-|-|- |
| 161 | +`priceId`|`string`| |
| 162 | + |
| 163 | +--- |
| 164 | +#### Tool: **`getPrices`** |
| 165 | +Get all prices |
| 166 | +#### Tool: **`getSubscriptionById`** |
| 167 | +Get a subscription by ID |
| 168 | +Parameters|Type|Description |
| 169 | +-|-|- |
| 170 | +`subscriptionId`|`string`| |
| 171 | + |
| 172 | +--- |
| 173 | +#### Tool: **`getSubscriptionPauses`** |
| 174 | +Get all pauses for a subscription |
| 175 | +Parameters|Type|Description |
| 176 | +-|-|- |
| 177 | +`subscriptionId`|`string`| |
| 178 | + |
| 179 | +--- |
| 180 | +#### Tool: **`getSubscriptionUsage`** |
| 181 | +Get usage for a subscription |
| 182 | +Parameters|Type|Description |
| 183 | +-|-|- |
| 184 | +`subscriptionId`|`string`| |
| 185 | + |
| 186 | +--- |
| 187 | +#### Tool: **`getSubscriptions`** |
| 188 | +Get all subscriptions |
| 189 | +#### Tool: **`getWalletBalance`** |
| 190 | +Get the real-time balance of a wallet |
| 191 | +Parameters|Type|Description |
| 192 | +-|-|- |
| 193 | +`walletId`|`string`| |
| 194 | + |
| 195 | +--- |
| 196 | +#### Tool: **`getWalletById`** |
| 197 | +Get a wallet by ID |
| 198 | +Parameters|Type|Description |
| 199 | +-|-|- |
| 200 | +`walletId`|`string`| |
| 201 | + |
| 202 | +--- |
| 203 | +#### Tool: **`getWalletTransactions`** |
| 204 | +Get transactions for a wallet with pagination |
| 205 | +Parameters|Type|Description |
| 206 | +-|-|- |
| 207 | +`walletId`|`string`| |
| 208 | +`limit`|`number` *optional*|Maximum number of transactions to return |
| 209 | +`offset`|`number` *optional*|Number of transactions to skip for pagination |
| 210 | + |
| 211 | +--- |
| 212 | +#### Tool: **`getWalletsByCustomerId`** |
| 213 | +Get all wallets for a customer |
| 214 | +Parameters|Type|Description |
| 215 | +-|-|- |
| 216 | +`customerId`|`string`| |
| 217 | + |
| 218 | +--- |
| 219 | +## Use this MCP Server |
| 220 | + |
| 221 | +```json |
| 222 | +{ |
| 223 | + "mcpServers": { |
| 224 | + "flexprice": { |
| 225 | + "command": "docker", |
| 226 | + "args": [ |
| 227 | + "run", |
| 228 | + "-i", |
| 229 | + "--rm", |
| 230 | + "-e", |
| 231 | + "BASE_URL", |
| 232 | + "-e", |
| 233 | + "API_KEY", |
| 234 | + "mcp/flexprice" |
| 235 | + ], |
| 236 | + "env": { |
| 237 | + "BASE_URL": "https://api.cloud.flexprice.io", |
| 238 | + "API_KEY": "your_api_key_here" |
| 239 | + } |
| 240 | + } |
| 241 | + } |
| 242 | +} |
| 243 | +``` |
| 244 | + |
| 245 | +[Why is it safer to run MCP Servers with Docker?](https://www.docker.com/blog/the-model-context-protocol-simplifying-building-ai-apps-with-anthropic-claude-desktop-and-docker/) |
0 commit comments