---
title: "Changes to Deprecated partner coupon-payment alias"
method: POST
path: "/api/v1/partner/residency_applications/{id}/pay/coupon"
---

# Changes to Deprecated partner coupon-payment alias

`POST /api/v1/partner/residency_applications/{id}/pay/coupon`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 2 of 12 revisions.

- **2026-09-22** `d2c5a5cda002`: 7 info
- **2026-09-15** `197106eab8bc`: 3 breaking, 3 warning, 14 info

## Changes

- **2026-09-22** `d2c5a5cda002`: 7 info
  - added the optional property `code` to the response with the `400` status
  - added the optional property `code` to the response with the `401` status
  - added the optional property `code` to the response with the `403` status
  - added the optional property `code` to the response with the `404` status
  - added the optional property `code` to the response with the `409` status
  - added the optional property `code` to the response with the `429` status
  - added the optional property `code` to the response with the `500` status
- **2026-09-15** `197106eab8bc`: 3 breaking, 3 warning, 14 info
  - the `header` request parameter `Idempotency-Key` became required
  - for the `header` request parameter `Idempotency-Key`, the minLength was increased from `1` to `8`
  - added the pattern `^[A-Za-z0-9_.~-]+$` to the `header` request parameter `Idempotency-Key`
  - for the `header` request parameter `Idempotency-Key`, the maxLength was set to `128`
  - removed the optional property `message` from the response with the `200` status
  - removed the optional property `success` from the response with the `200` status
  - the response property `data` became required for the status `200`
  - added the required property `data/applicantPortalAccess` to the response with the `200` status
  - added the required property `data/applicationData` to the response with the `200` status
  - added the required property `data/applicationVersion` to the response with the `200` status
  - added the required property `data/approvedAt` to the response with the `200` status
  - added the required property `data/createdAt` to the response with the `200` status
  - added the required property `data/id` to the response with the `200` status
  - added the required property `data/nextSteps` to the response with the `200` status
  - added the required property `data/referralCode` to the response with the `200` status
  - added the required property `data/rejectedAt` to the response with the `200` status
  - added the required property `data/residentPermitNumber` to the response with the `200` status
  - added the required property `data/statusId` to the response with the `200` status
  - added the required property `data/submittedAt` to the response with the `200` status
  - added the required property `data/version` to the response with the `200` status

---

[Operation](https://skmtc.dev/eprospera/apis/e-pro-spera-api/docs/api/v1/partner/residency_applications/:id/pay/coupon/post.md) - [API](https://skmtc.dev/eprospera/apis/e-pro-spera-api.md) - [Page](https://skmtc.dev/eprospera/apis/e-pro-spera-api/changes/api/v1/partner/residency_applications/:id/pay/coupon/post)