---
title: "Update subscription details"
method: PUT
path: "/subscriptions/{subscriptionId}"
tags: ["Subscription"]
---

# Update subscription details

`PUT /subscriptions/{subscriptionId}`

Use this endpoint to update subscription details

## Path parameters

- `subscriptionId` string, uuid, required

## Headers

- `X-Amzn-Trace-Id` string

## Request body

- SubscriptionRequestObject
  - `reference` string — Optional. subscription reference.
  - `subscriptionPlanId` string, uuid, required — The identifier of the subscription plan chosen by the customer
  - `startDate` string, date, required — start date of the first installement. Next installement is due one month after, and so one. the startDate must be today date or in the futur.
  - `customerId` string, uuid, required — Required. Unique Id of the customer.
  - `notificationChannel` 'email' | 'sms' | 'whatsApp' | 'none' — By which means the payment link will be send to the customer
  - `status` 'opened' | 'started' | 'cancelled' | 'completed'

## Response `202`

subscription plan is updated successfully

- SubscriptionResponseObject
  - `id` string, uuid — Unique Identifier of the Subscription Response object
  - `reference` string — Optional. subscription reference.
  - `subscriptionPlanId` string, uuid, required — The identifier of the subscription plan chosen by the customer
  - `startDate` string, date, required — start date of the first installement. Next installement is due one month after, and so one. the startDate must be today date or in the futur.
  - `customerId` string, uuid, required — Required. Unique Id of the customer.
  - `notificationChannel` 'email' | 'sms' | 'whatsApp' | 'none' — By which means the payment link will be send to the customer
  - `status` 'opened' | 'started' | 'cancelled' | 'completed'
  - `nextInstallmentDueDate` string, date — date of next installment due date. At 7h00 UTC at the date the request to pay link will be send to the customer
  - `nbrPaidInstallments` integer — number of already paid installments.
  - `nbrUnpaidInstallments` integer — number of unpaid installments since the beginning.
  - `customerName` string — Customer Name
  - `currentInstallmentStatus` 'succeeded' | 'failed' | 'cancelled' | 'pending' | 'processing' | 'reversed' | 'authorized' — status of the transaction
  - `createdAt` string — The merchant entity registration timestamp in our platform in ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS)
  - `updatedAt` string — updated timestamp in our platform in ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS)

## Other responses

- `400` — Bad Request
- `401` — The caller is not authenticated
- `403` — Access rights not sufficient
- `404` — Cannot not found subscription. Check billingId
- `500` — Internal Server Error.

---

[API](https://skmtc.dev/bictorys/apis/pay.md) · [All operations](https://skmtc.dev/bictorys/apis/pay/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bictorys/pay/revisions/b85cce14340b/schema)