---
title: "Mark payment paid"
method: PATCH
path: "/subscriptions/{subscriptionId}/payments/{paymentNumber}"
tags: ["Subscriptions"]
---

# Mark payment paid

`PATCH /subscriptions/{subscriptionId}/payments/{paymentNumber}`

Manually update a declined payment as approved (e.g. if payment was collected elsewhere)

## Path parameters

- `subscriptionId` integer, required
- `paymentNumber` integer, required

## Headers

- `api-token` string, required

## Request body

- SubscriptionPaymentPatchReq
  - `status` integer, required — The updated payment status. Must be included and specified as `approved` to register the payment for update. All other status values will be rejected.

## Response `200`

Successful payment update. The response body contains the newly approved payment and the parent subscription.

- SubscriptionPaymentPatchRes
  - `id` integer
  - `dateCreated` string, date-time
  - `dateUpdated` string, date-time
  - `dateActivated` string, date
  - `dateBilling` string, date
  - `status` string
  - `paymentPlanId` integer
  - `customerCode` string
  - `timesBilled` integer
  - `setupAmount` number, float
  - `recurringAmount` number, float
  - `freeTrialPeriod` integer
  - `maxCycles` integer
  - `hasFailedPayments` string
  - `addOnIds` integer[]
  - `payments` BasePayment
    - `id` integer
    - `setupAmount` number, float
    - `recurringAmount` number, float
    - `addOnAmount` number, float
    - `amount` number, float
    - `taxAmount` number, float
    - `dateDue` string, date-time
    - `dateProcessed` string, date-time
    - `status` string
    - `paymentNumber` integer
    - `numberOfRetries` integer

## Other responses

- `400` — You are initiating a request with invalid parameter and/or body values.
- `401` — You are not authorized to access this resource. Please ensure that you are authenticated, and that you are using the `api-token` header
- `403` — You do not have permission to access this resource. Please ensure you are both authenticated and that you have the required roles/permissions active.
- `500` — Helcim internal server error encountered.

---

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