stores

Creates, updates, deletes, gets or lists a stores resource.

Overview

Name	stores
Type	Resource
Id	vercel.integrations.stores

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_direct	insert	name, integration_configuration_id, integration_product_id_or_slug	team_id, slug	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
slug	string	The Team slug to perform the request on behalf of.
team_id	string	The Team identifier to perform the request on behalf of. (wire: teamId)

INSERT examples

create_direct

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.

INSERT INTO vercel.integrations.stores (
name,
integration_configuration_id,
integration_product_id_or_slug,
metadata,
external_id,
protocol_settings,
source,
billing_plan_id,
payment_method_id,
prepayment_amount_cents,
team_id,
slug
)
SELECT 
'{{ name }}' /* required */,
'{{ integration_configuration_id }}' /* required */,
'{{ integration_product_id_or_slug }}' /* required */,
'{{ metadata }}',
'{{ external_id }}',
'{{ protocol_settings }}',
'{{ source }}',
'{{ billing_plan_id }}',
'{{ payment_method_id }}',
{{ prepayment_amount_cents }},
'{{ team_id }}',
'{{ slug }}'
RETURNING
store
;

Manifest

# Description fields are for documentation purposes
- name: stores
props:
  - name: name
    value: "{{ name }}"
    description: |
      Human-readable name for the storage resource
  - name: integration_configuration_id
    value: "{{ integration_configuration_id }}"
    description: |
      ID of your integration configuration. Get this from GET /v1/integrations/configurations
  - name: integration_product_id_or_slug
    value: "{{ integration_product_id_or_slug }}"
    description: |
      ID or slug of the integration product. Get available products from GET /v1/integrations/configuration/{id}/products
  - name: metadata
    value: "{{ metadata }}"
    description: |
      Optional key-value pairs for resource metadata
  - name: external_id
    value: "{{ external_id }}"
    description: |
      Optional external identifier for tracking purposes
  - name: protocol_settings
    value: "{{ protocol_settings }}"
    description: |
      Protocol-specific configuration settings
  - name: source
    value: "{{ source }}"
    description: |
      Source of the store creation request
    valid_values: ['marketplace', 'deploy-button', 'external', 'v0', 'resource-claims', 'cli', 'oauth', 'backoffice', 'import-recommended-integrations', 'organization']
    default: marketplace
  - name: billing_plan_id
    value: "{{ billing_plan_id }}"
    description: |
      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.
  - name: payment_method_id
    value: "{{ payment_method_id }}"
    description: |
      Payment method ID for paid resources. Optional - uses default payment method if not provided.
  - name: prepayment_amount_cents
    value: {{ prepayment_amount_cents }}
    description: |
      Amount in cents for prepayment billing plans. Required only for prepayment plans with variable amounts.
  - name: team_id
    value: "{{ team_id }}"
    description: The Team identifier to perform the request on behalf of.
    description: The Team identifier to perform the request on behalf of.
  - name: slug
    value: "{{ slug }}"
    description: The Team slug to perform the request on behalf of.
    description: The Team slug to perform the request on behalf of.