---
title: "Registra a data em que o usuário pretende cancelar a assinatura"
method: POST
path: "/api/v1/Subscription/wantCancel"
tags: ["Subscription"]
---

# Registra a data em que o usuário pretende cancelar a assinatura

`POST /api/v1/Subscription/wantCancel`

## Request

- Base URL: `https://api.meucartaosim.com.br` (the document declares no server; this is the origin it was published from)
- URL: `https://api.meucartaosim.com.br/api/v1/Subscription/wantCancel`
- Auth: API key in header `Authorization`

## Request body

- PostSubscriptionWantCancel
  - `id` integer, required
  - `wantCancelDate` string, date-time, required

## Response `200`

OK

- GetSubscriptionDetailsDTOCustomReturn
  - `data` GetSubscriptionDetailsDTO[], nullable
    - `id` integer
    - `planId` integer
    - `planName` string, nullable
    - `planUF` string, nullable
    - `createdAt` string, date-time
    - `canceledAt` string, date-time, nullable
    - `updatedAt` string, date-time, nullable
    - `wantCancelAt` string, date-time, nullable
    - `status` 'notefectivated' | 'active' | 'expired' | 'canceled' | 'inmigration'
    - `dueDay` integer
    - `dueType` string, nullable
    - `dueReference` string, nullable
    - `periodType` string, nullable
    - `periodDuration` integer
    - `freeDependents` integer
    - `maxDependents` integer
    - `dependentValue` number, double
    - `periodInterval` integer
    - `holderId` integer
    - `discounts` SubscriptionDiscount[], nullable
      - `id` integer
      - `subscriptionId` integer
      - `type` string, nullable
      - `productId` integer, nullable
      - `productName` string, nullable
      - `value` number, double
      - `cyclesQuantity` integer
    - `items` SubscriptionItem[], nullable
      - `id` integer
      - `subscriptionId` integer
      - `productId` integer
      - `productName` string, nullable
      - `cycles` integer
      - `value` number, double
      - `quantity` integer
      - `usage` integer
      - `addon` boolean
      - `clientId` integer, nullable
      - `clientName` string, nullable
      - `createdAt` string, date-time
      - `prepaid` boolean
      - `cycleStart` integer
      - `prepaidEnd` string, date-time, nullable
      - `prepaidPaid` boolean
      - `cancelSubscriptionItemId` integer, nullable
      - `cancelationFeePending` boolean
      - `billedCycles` integer
    - `periods` SubscriptionPeriod[], nullable
      - `id` integer
      - `subscriptionId` integer
      - `startAt` string, date-time
      - `endAt` string, date-time
      - `cycles` integer
      - `billingAt` string, date-time
      - `status` 'notbilled' | 'pending' | 'paid' | 'disposable'
    - `paymentMethod` SubscriptionPaymentMethod
      - `id` integer
      - `name` string, nullable
      - `paymentLink` boolean
      - `customDue` boolean
    - `plan` Plan
      - `id` integer
      - `name` string, nullable
      - `active` boolean
      - `observation` string, nullable
      - `startAt` string, date-time, nullable
      - `endAt` string, date-time, nullable
      - `periodInterval` integer
      - `periodType` string, nullable
      - `periodDuration` integer
      - `dueType` string, nullable
      - `dueDay` integer
      - `dueReference` string, nullable
      - `freeDependents` integer
      - `maxDependents` integer
      - `dependentValue` number, double
      - `trialDays` integer
      - `fidelity` integer
      - `cancelationFeeType` 'setted' | 'settedproportional' | 'productproportional'
      - `cancelationFee` number, double
      - `cancelationFeeProduct` integer, nullable
      - `allowCustomDue` boolean
      - `allowInstallment` boolean
      - `maxInstallment` integer
      - `planPaymentMethods` PlanPaymentMethod[], nullable
        - `id` integer
        - `planId` integer
        - `paymentMethodId` integer
        - `name` string, nullable
        - `allowPaymentLink` boolean
      - `planProducts` PlanProduct[], nullable
        - `id` integer
        - `planId` integer
        - `productId` integer
        - `cycles` integer
        - `value` number, double
        - `quantity` integer
        - `name` string, nullable
        - `optional` boolean
        - `addon` boolean
        - `addonCategory` integer, nullable
        - `allowPrepaidBilling` boolean
      - `planProfiles` PlanProfile[], nullable
        - `id` integer
        - `planId` integer
        - `profileId` integer
        - `name` string, nullable
      - `migrationRule` string, nullable
      - `uf` string, nullable
    - `paymentUrl` string, nullable
    - `internalUser` SubscriptionInternalUser
      - `register` string, nullable
      - `cancel` string, nullable
      - `estabName` string, nullable
      - `requestCancelUser` string, nullable
    - `payload` unknown
    - `chargeId` integer, nullable
  - `total` integer
  - `responseTime` integer
  - `feedback` string, nullable
  - `status` 'Continue' | 'SwitchingProtocols' | 'Processing' | 'EarlyHints' | 'OK' | 'Created' | 'Accepted' | 'NonAuthoritativeInformation' | 'NoContent' | 'ResetContent' | 'PartialContent' | 'MultiStatus' | 'AlreadyReported' | 'IMUsed' | 'MultipleChoices' | 'MovedPermanently' | 'Found' | 'SeeOther' | 'NotModified' | 'UseProxy' | 'Unused' | 'TemporaryRedirect' | 'PermanentRedirect' | 'BadRequest' | 'Unauthorized' | 'PaymentRequired' | 'Forbidden' | 'NotFound' | 'MethodNotAllowed' | 'NotAcceptable' | 'ProxyAuthenticationRequired' | 'RequestTimeout' | 'Conflict' | 'Gone' | 'LengthRequired' | 'PreconditionFailed' | 'RequestEntityTooLarge' | 'RequestUriTooLong' | 'UnsupportedMediaType' | 'RequestedRangeNotSatisfiable' | 'ExpectationFailed' | 'MisdirectedRequest' | 'UnprocessableEntity' | 'Locked' | 'FailedDependency' | 'UpgradeRequired' | 'PreconditionRequired' | 'TooManyRequests' | 'RequestHeaderFieldsTooLarge' | 'UnavailableForLegalReasons' | 'InternalServerError' | 'NotImplemented' | 'BadGateway' | 'ServiceUnavailable' | 'GatewayTimeout' | 'HttpVersionNotSupported' | 'VariantAlsoNegotiates' | 'InsufficientStorage' | 'LoopDetected' | 'NotExtended' | 'NetworkAuthenticationRequired'
  - `notifications` ReturnError[], nullable
    - `type` string, nullable
    - `message` string, nullable
    - `code` string, nullable
  - `warnings` ReturnError[], nullable
    - `type` string, nullable
    - `message` string, nullable
    - `code` string, nullable

## Other responses

- `400`: Bad Request

## Changes

- **2026-10-30** `0fd8d9cb7154`: 3 info
  - added the optional property `data/items/items/items/billedCycles` to the response with the `200` status
  - added the optional property `data/items/items/items/cancelSubscriptionItemId` to the response with the `200` status
  - added the optional property `data/items/items/items/cancelationFeePending` to the response with the `200` status
- **2026-09-30** `d3c7d1b0898d`: 5 info
  - added the optional property `data/items/items/items/cycleStart` to the response with the `200` status
  - added the optional property `data/items/items/items/prepaid` to the response with the `200` status
  - added the optional property `data/items/items/items/prepaidEnd` to the response with the `200` status
  - added the optional property `data/items/items/items/prepaidPaid` to the response with the `200` status
  - …1 more

[Operation history](https://skmtc.dev/meucartaosim/apis/cartaosim-api/changes/api/v1/Subscription/wantCancel/post.md)

---

[API](https://skmtc.dev/meucartaosim/apis/cartaosim-api.md) - [All operations](https://skmtc.dev/meucartaosim/apis/cartaosim-api/llms.txt) - [OpenAPI document](https://skmtc.dev/meucartaosim/apis/cartaosim-api/revisions/d17228159154?raw)
