Sign in

v13

OpenAPI 3.0.32026-07-31359869.4 MB
integrations

Create integration store (free and paid plans)

Creates an integration store with automatic billing plan handling. For free resources, omit billingPlanId to auto-discover free plans. For paid resources, provide a billingPlanId from the billing plans endpoint.

post/v1/storage/stores/integration/direct

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

namestring required

Human-readable name for the storage resource

integrationConfigurationIdstring required

ID of your integration configuration. Get this from GET /v1/integrations/configurations

metadataobject

Optional key-value pairs for resource metadata

externalIdstring

Optional external identifier for tracking purposes

protocolSettingsobject

Protocol-specific configuration settings

source'marketplace' | 'deploy-button' | 'external' | 'v0' | 'resource-claims' | 'cli' | 'oauth' | 'backoffice'

Source of the store creation request

billingPlanIdstring

ID of the billing plan for paid resources. Get available plans from GET /integrations/integration/{id}/products/{productId}/plans. If not provided, automatically discovers free billing plans.

paymentMethodIdstring

Payment method ID for paid resources. Optional - uses default payment method if not provided.

prepaymentAmountCentsnumber

Amount in cents for prepayment billing plans. Required only for prepayment plans with variable amounts.

Example request

{
  "name": "my-dev-database",
  "integrationConfigurationId": "icfg_cuwj0AdCdH3BwWT4LPijCC7t",
  "metadata": {
    "environment": "development",
    "project": "my-app",
    "tags": [
      "database",
      "postgres"
    ]
  },
  "externalId": "dev-db-001",
  "protocolSettings": {
    "experimentation": {
      "edgeConfigSyncingEnabled": true
    }
  },
  "source": "marketplace",
  "billingPlanId": "bp_abc123def456",
  "paymentMethodId": "pm_1AbcDefGhiJklMno",
  "prepaymentAmountCents": 5000
}

Response

Example response

{
  "store": {
    "product": {
      "resourceTitle": "Instance"
    }
  }
}