---
title: "Update pipeline"
method: PATCH
path: "/pipelines/{id}"
tags: ["Pipelines"]
---

# Update pipeline

`PATCH /pipelines/{id}`

## Path parameters

- `id` string, required

## Request body

- object
  - `source` SourceConfig
    - `type` 'stripe', required
    - `stripe` SourceStripeConfig, required
      - `api_key` string, required — Stripe API key (sk_test_... or sk_live_...)
      - `account_id` string — Stripe account ID (resolved from API if omitted)
      - `livemode` boolean — Whether this is a live mode sync
      - `api_version` '2026-03-25.dahlia' | '2026-02-25.clover' | '2026-01-28.clover' | '2025-12-15.clover' | '2025-11-17.clover' | '2025-10-29.clover' | '2025-09-30.clover' | '2025-08-27.basil' | '2025-07-30.basil' | '2025-06-30.basil' | '2025-05-28.basil' | '2025-04-30.basil' | '2025-03-31.basil' | '2025-02-24.acacia' | '2025-01-27.acacia' | '2024-12-18.acacia' | '2024-11-20.acacia' | '2024-10-28.acacia' | '2024-09-30.acacia' | '2024-06-20' | '2024-04-10' | '2024-04-03' | '2023-10-16' | '2023-08-16' | '2022-11-15' | '2022-08-01' | '2020-08-27' | '2020-03-02' | '2019-12-03' | '2019-11-05' | '2019-10-17' | '2019-10-08' | '2019-09-09' | '2019-08-14' | '2019-05-16' | '2019-03-14' | '2019-02-19' | '2019-02-11' | '2018-11-08' | '2018-10-31' | '2018-09-24' | '2018-09-06' | '2018-08-23' | '2018-07-27' | '2018-05-21' | '2018-02-28' | '2018-02-06' | '2018-02-05' | '2018-01-23' | '2017-12-14' | '2017-08-15'
      - `base_url` string, uri — Override the Stripe API base URL (e.g. http://localhost:12111 for stripe-mock)
      - `webhook_url` string, uri — URL for managed webhook endpoint registration
      - `webhook_secret` string — Webhook signing secret (whsec_...) for signature verification
      - `websocket` boolean — Enable WebSocket streaming for live events
      - `poll_events` boolean — Enable events API polling for incremental sync after backfill
      - `webhook_port` integer — Port for built-in webhook HTTP listener (e.g. 4242)
      - `revalidate_objects` string[] — Object types to re-fetch from Stripe API on webhook (e.g. ["subscription"])
      - `backfill_limit` integer — Max objects to backfill per stream (useful for testing)
      - `rate_limit` integer — Max Stripe API requests per second (default: 25)
      - `backfill_concurrency` integer — Number of time-range segments for parallel backfill (default: 10)
  - `destination` union
    - object
      - `type` 'postgres', required
      - `postgres` DestinationPostgresConfig, required
        - `url` string — Postgres connection string (alias for connection_string)
        - `connection_string` string — Postgres connection string
        - `host` string — Postgres host (required for AWS IAM)
        - `port` number — Postgres port
        - `database` string — Database name (required for AWS IAM)
        - `user` string — Database user (required for AWS IAM)
        - `schema` string, required — Target schema name (e.g. "stripe_sync")
        - `batch_size` number — Records to buffer before flushing
        - `aws` object — AWS RDS IAM authentication config
          - `region` string, required — AWS region for RDS instance
          - `role_arn` string — IAM role ARN to assume (cross-account)
          - `external_id` string — External ID for STS AssumeRole
        - `ssl_ca_pem` string — PEM-encoded CA certificate for SSL verification (required for verify-ca / verify-full with a private CA)
    - object
      - `type` 'google_sheets', required
      - `google_sheets` DestinationGoogleSheetsConfig, required
        - `client_id` string — Google OAuth2 client ID (env: GOOGLE_CLIENT_ID)
        - `client_secret` string — Google OAuth2 client secret (env: GOOGLE_CLIENT_SECRET)
        - `access_token` string, required — OAuth2 access token
        - `refresh_token` string, required — OAuth2 refresh token
        - `spreadsheet_id` string — Target spreadsheet ID (created if omitted)
        - `spreadsheet_title` string — Title when creating a new spreadsheet
        - `batch_size` number — Rows per Sheets API append call
  - `streams` object[] — Selected streams to sync. All streams synced if omitted.
    - `name` string, required — Stream (table) name to sync.
    - `sync_mode` 'incremental' | 'full_refresh' — How the source reads this stream. Defaults to full_refresh.
    - `backfill_limit` integer — Cap backfill to this many records, then mark the stream complete.
  - `desired_status` 'active' | 'paused' | 'deleted' — Set to "paused" to pause, "active" to resume, "deleted" to tear down.

## Response `200`

Updated pipeline

- object
  - `id` string, required — Unique pipeline identifier (e.g. pipe_abc123).
  - `source` SourceConfig, required
    - `type` 'stripe', required
    - `stripe` SourceStripeConfig, required
      - `api_key` string, required — Stripe API key (sk_test_... or sk_live_...)
      - `account_id` string — Stripe account ID (resolved from API if omitted)
      - `livemode` boolean — Whether this is a live mode sync
      - `api_version` '2026-03-25.dahlia' | '2026-02-25.clover' | '2026-01-28.clover' | '2025-12-15.clover' | '2025-11-17.clover' | '2025-10-29.clover' | '2025-09-30.clover' | '2025-08-27.basil' | '2025-07-30.basil' | '2025-06-30.basil' | '2025-05-28.basil' | '2025-04-30.basil' | '2025-03-31.basil' | '2025-02-24.acacia' | '2025-01-27.acacia' | '2024-12-18.acacia' | '2024-11-20.acacia' | '2024-10-28.acacia' | '2024-09-30.acacia' | '2024-06-20' | '2024-04-10' | '2024-04-03' | '2023-10-16' | '2023-08-16' | '2022-11-15' | '2022-08-01' | '2020-08-27' | '2020-03-02' | '2019-12-03' | '2019-11-05' | '2019-10-17' | '2019-10-08' | '2019-09-09' | '2019-08-14' | '2019-05-16' | '2019-03-14' | '2019-02-19' | '2019-02-11' | '2018-11-08' | '2018-10-31' | '2018-09-24' | '2018-09-06' | '2018-08-23' | '2018-07-27' | '2018-05-21' | '2018-02-28' | '2018-02-06' | '2018-02-05' | '2018-01-23' | '2017-12-14' | '2017-08-15'
      - `base_url` string, uri — Override the Stripe API base URL (e.g. http://localhost:12111 for stripe-mock)
      - `webhook_url` string, uri — URL for managed webhook endpoint registration
      - `webhook_secret` string — Webhook signing secret (whsec_...) for signature verification
      - `websocket` boolean — Enable WebSocket streaming for live events
      - `poll_events` boolean — Enable events API polling for incremental sync after backfill
      - `webhook_port` integer — Port for built-in webhook HTTP listener (e.g. 4242)
      - `revalidate_objects` string[] — Object types to re-fetch from Stripe API on webhook (e.g. ["subscription"])
      - `backfill_limit` integer — Max objects to backfill per stream (useful for testing)
      - `rate_limit` integer — Max Stripe API requests per second (default: 25)
      - `backfill_concurrency` integer — Number of time-range segments for parallel backfill (default: 10)
  - `destination` union, required
    - object
      - `type` 'postgres', required
      - `postgres` DestinationPostgresConfig, required
        - `url` string — Postgres connection string (alias for connection_string)
        - `connection_string` string — Postgres connection string
        - `host` string — Postgres host (required for AWS IAM)
        - `port` number — Postgres port
        - `database` string — Database name (required for AWS IAM)
        - `user` string — Database user (required for AWS IAM)
        - `schema` string, required — Target schema name (e.g. "stripe_sync")
        - `batch_size` number — Records to buffer before flushing
        - `aws` object — AWS RDS IAM authentication config
          - `region` string, required — AWS region for RDS instance
          - `role_arn` string — IAM role ARN to assume (cross-account)
          - `external_id` string — External ID for STS AssumeRole
        - `ssl_ca_pem` string — PEM-encoded CA certificate for SSL verification (required for verify-ca / verify-full with a private CA)
    - object
      - `type` 'google_sheets', required
      - `google_sheets` DestinationGoogleSheetsConfig, required
        - `client_id` string — Google OAuth2 client ID (env: GOOGLE_CLIENT_ID)
        - `client_secret` string — Google OAuth2 client secret (env: GOOGLE_CLIENT_SECRET)
        - `access_token` string, required — OAuth2 access token
        - `refresh_token` string, required — OAuth2 refresh token
        - `spreadsheet_id` string — Target spreadsheet ID (created if omitted)
        - `spreadsheet_title` string — Title when creating a new spreadsheet
        - `batch_size` number — Rows per Sheets API append call
  - `streams` object[] — Selected streams to sync. All streams synced if omitted.
    - `name` string, required — Stream (table) name to sync.
    - `sync_mode` 'incremental' | 'full_refresh' — How the source reads this stream. Defaults to full_refresh.
    - `backfill_limit` integer — Cap backfill to this many records, then mark the stream complete.
  - `desired_status` 'active' | 'paused' | 'deleted', required — User-controlled lifecycle state. Set via PATCH to pause, resume, or delete.
  - `status` 'setup' | 'backfill' | 'ready' | 'paused' | 'teardown' | 'error', required — Workflow-controlled execution state. Updated by the Temporal workflow.
  - `progress` object — Latest read-only sync progress snapshot from the engine. Updated when a bounded sync run completes and safe for dashboards to poll.
    - `reason` 'complete' | 'state_limit' | 'time_limit' | 'error' | 'aborted', required — Why the sync run ended.
    - `cutoff` 'soft' | 'hard' — Present when reason is time_limit. soft = stopped gracefully between messages; hard = forcibly interrupted a blocked operation.
    - `elapsed_ms` number — Wall-clock milliseconds elapsed since the stream started. Always present when reason is time_limit or aborted.
    - `global_progress` object — Final global aggregates. Same shape as trace/progress.
      - `elapsed_ms` integer, required — Wall-clock milliseconds since the sync run started.
      - `run_record_count` integer, required — Total records synced across all streams in this run.
      - `rows_per_second` number, required — Overall throughput for the entire run: run_record_count / elapsed seconds.
      - `window_rows_per_second` number, required — Instantaneous throughput: total records in last window / window duration. Measures only the most recent reporting interval.
      - `state_checkpoint_count` integer, required — Total source_state messages observed so far in this sync run.
    - `stream_progress` object — Per-stream end-of-sync summary. Errors only appear here, not in stream_status messages.
    - `record_count` object — Legacy per-stream record counts. Backward compat.

## Other responses

- `400` — Bad request
- `404` — Not found
- `409` — Invalid status transition

## Changes

- **2026-04-14** `8a0ae7c56dc2` — 1 info
  - added the optional property `progress` to the response with the `200` status
- **2026-04-06** `073870bf3a8b` — 4 breaking, 1 warning, 1 info
  - added the new required request property `destination/oneOf[subschema #2]/google_sheets`
  - the `type` request property const value changed from `google-sheets` to `google_sheets`
  - the `type` response property const value changed from `google-sheets` to `google_sheets` for the status `200`
  - removed the required property `destination/oneOf[subschema #2]/google-sheets` from the response with the `200` status
  - …2 more
- **2026-04-06** `fac010782a81` — 4 breaking, 6 warning, 5 info
  - the `status` response's property type changed from `object` to `string` for status `200`
  - removed the required property `status/iteration` from the response with the `200` status
  - removed the required property `status/paused` from the response with the `200` status
  - removed the required property `status/phase` from the response with the `200` status
  - …11 more
- …earlier changes not shown

[Full history](https://skmtc.dev/stripe/apis/stripe-sync-service/changes/pipelines/:id/patch.md)

---

[API](https://skmtc.dev/stripe/apis/stripe-sync-service.md) · [All operations](https://skmtc.dev/stripe/apis/stripe-sync-service/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/stripe/stripe-sync-service/revisions/8a0ae7c56dc2/schema)