---
title: "Update Subscription"
method: PATCH
path: "/api/v1/subscriptions/{subscription_id}"
tags: ["subscriptions", "subscriptions"]
---

# Update Subscription

`PATCH /api/v1/subscriptions/{subscription_id}`

## Request

- Base URL: `https://app.goodleads.club` (the document declares no server; this is the origin it was published from)
- URL: `https://app.goodleads.club/api/v1/subscriptions/{subscription_id}`
- Auth: API key in header `X-API-Key`

## Path parameters

- `subscription_id` string, uuid, required

## Request body

- SubscriptionUpdate
  - `name` string, nullable
  - `schedule` object, nullable
  - `pricing` object, nullable
  - `billing_mode` 'card' | 'invoice' | 'none', nullable
  - `offer_code` string, nullable
  - `cap` object, nullable
  - `lane` 'all' | 'best' | 'contact', nullable
  - `delivery_method` 'file' | 'crm', nullable
  - `connection_id` string, uuid, nullable
  - `buyer_email` string, nullable
  - `floor_created_at` string, date-time, nullable
  - `status` 'active' | 'paused' | 'canceled', nullable
  - `customer_id` string, uuid, nullable
  - `billing_status` 'none' | 'active' | 'past_due' | 'canceled', nullable
  - `max_age_days` integer, nullable
  - `notify_empty` boolean, nullable
  - `recipients` string[], nullable

## Response `200`

Successful Response

- SubscriptionResponse
  - `subscription_id` string, uuid, required
  - `name` string, required
  - `status` string, required
  - `buyer_email` string, nullable
  - `customer_id` string, uuid, nullable, required
  - `saved_list_id` string, nullable
  - `schedule` object, nullable
  - `schedule_words` string, nullable
  - `pricing` object, nullable
  - `billing_mode` string
  - `billing_status` string
  - `offer_code` string, nullable
  - `credits_remaining_cents` integer, nullable
  - `unbilled_cents` integer
  - `cap` object, nullable
  - `lane` string, nullable
  - `delivery_method` string
  - `connection_id` string, uuid, nullable, required
  - `floor_created_at` string, date-time, nullable
  - `max_age_days` integer, nullable
  - `notify_empty` boolean
  - `recipients` string[], nullable
  - `next_delivery_at` string, date-time, nullable
  - `last_run_at` string, date-time, nullable, required
  - `last_error` string, nullable
  - `retry_after` string, date-time, nullable
  - `manage_url` string, nullable
  - `created_at` string, date-time, nullable, required
  - `stripe_subscription_id` string, nullable
  - `stripe_customer_id` string, nullable
  - `stripe_price_id` string, nullable
  - `current_period_end` string, date-time, nullable
  - `last_delivery` LastDelivery
    - `delivery_id` string, uuid, required
    - `status` string, required
    - `fired_at` string, date-time, required
    - `delivered_at` string, date-time, nullable
    - `window_key` string, nullable
    - `record_count` integer, nullable
    - `waiting_count` integer, nullable
    - `total_cents` integer, nullable
    - `retail_cents` integer, nullable
    - `cost_cents` integer, nullable
    - `order_id` string, uuid, nullable
    - `error` string, nullable
  - `health` string, nullable
  - `cadence` string, required
  - `cap_cents_per_delivery` integer, nullable
  - `high_water_mark` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/goodleads/apis/formation-gtm-api.md) · [All operations](https://skmtc.dev/goodleads/apis/formation-gtm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goodleads/apis/formation-gtm-api/revisions/2068d13a82cf?raw)