---
title: "Update subscription metadata"
method: PATCH
path: "/api/subscriptions/{id}"
tags: ["Subscriptions"]
---

# Update subscription metadata

`PATCH /api/subscriptions/{id}`

Update the metadata field on a subscription. Other fields cannot be changed directly.

## Path parameters

- `id` string, required

## Request body

- UpdateSubscriptionDto
  - `metadata` object

## Response `200`

Subscription metadata updated

- SubscriptionResponse
  - `id` string, required
  - `externalId` string
  - `customerId` string, required
  - `planId` string, required
  - `previousPlanId` string
  - `status` 'ACTIVE' | 'PAST_DUE' | 'CANCELED' | 'TRIALING' | 'PAUSED', required
  - `currency` string, required
  - `billingTiming` 'IN_ADVANCE' | 'IN_ARREARS', required
  - `currentPeriodStart` string, required
  - `currentPeriodEnd` string, required
  - `cancelAt` string
  - `canceledAt` string
  - `trialStart` string
  - `trialEnd` string
  - `startedAt` string, required
  - `metadata` object
  - `customer` SubscriptionCustomerResponse
    - `id` string, required
    - `name` string, required
    - `email` string, required
  - `plan` SubscriptionPlanResponse
    - `id` string, required
    - `name` string, required
    - `billingInterval` 'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY', required
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `404` — Subscription not found

---

[API](https://skmtc.net/novabilling/apis/novabilling-api.md) · [All operations](https://skmtc.net/novabilling/apis/novabilling-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/novabilling/novabilling-api/versions/0e449a4e0dc8/schema)