---
title: "Preview a Subscription update"
method: POST
path: "/subscriptions/{id}/preview"
tags: ["Subscriptions"]
---

# Preview a Subscription update

`POST /subscriptions/{id}/preview`

Generates a preview of the changes that would occur if the Subscription is updated

## Path parameters

- `id` string, required

## Request body

- GenerateUpdatePreviewRequestDTO
  - `price` string — The ID of the price to apply to the subscription update
  - `nextBillingDate` string, date-time — The date of the next recurring payment. Must be in the future and after the current period start.

## Response `200`

OK

- UpdatePreviewDTO
  - `id` string, required — The ID of the preview
  - `subscription` object, required — How subscription will be updated, if the preview is applied
    - `id` string, required — The ID of the subscription
    - `price` string, required — The ID of the price associated with the subscription
    - `currentCycle` number, required — The current cycle of the subscription, starting from 1
    - `currentPeriodStart` string, date-time, required — The start date of the current period
    - `currentPeriodEnd` string, date-time, required — The end date of the current period
    - `upcomingInvoice` object, required — The upcoming invoice details
      - `amount` number, required — Amount to be charged for the upcoming invoice.
      - `currency` 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk', required — Currency of the upcoming invoice.
      - `periodStart` string, date-time, required — Start date of the billing period.
      - `periodEnd` string, date-time, required — End date of the billing period.
      - `statementDescriptor` string, nullable, required — Statement descriptor for the upcoming invoice.
      - `comment` string, nullable, required — Comment for the upcoming invoice.
  - `previewValidUntil` string, date-time, required — The date until the preview is valid.

## Other responses

- `202` — The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.
- `400` — The request was rejected. `type` is `invalid_request_error` when the request itself is at fault — `errors` then lists every problem found, with field-attributable entries prefixed by the field’s path; `invalid_state_error` when the request was well-formed but the resource is not in a state that allows it; or `payment_error` when the payment was refused by the issuer or processor.
- `401` — No API key was supplied, or the key is not valid. `type` is `authentication_error`.
- `403` — The API key is valid but lacks the permission this operation requires. `type` is `permission_error`.
- `404` — No resource exists with the requested identifier. `type` is `not_found_error`.
- `409` — `type` is `conflict_error`. The supplied `X-Idempotency-Key` was already used with a different request body (`code` is `idempotency_conflict`, and retrying will not help), or the resource is being modified by another in-flight request (`code` is `resource_locked`, and retrying with backoff will).
- `429` — Too many requests. The rate limit is applied per client across all operations. `type` is `rate_limit_error`.
- `500` — The request could not be completed because of an unexpected error. `type` is `api_error`.
- `504` — The request exceeded the processing time limit and was abandoned. `type` is `api_error` and `code` is `timeout` — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly.

---

[API](https://skmtc.dev/odus/apis/odus-orchestration-api.md) · [All operations](https://skmtc.dev/odus/apis/odus-orchestration-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/odus/odus-orchestration-api/revisions/d5fdcba31576/schema)