# Cancel your YoPrint subscription

```http
PATCH https://secure.yoprint.com/v1/api/store/{team_slug}/setting/subscription/current/cancel
```

- API version: v1
- Operation ID: `v1_public_setting_subscription_current_cancel`
- Section: Team settings › [YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription.md)
- Web page: https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-current-cancel/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

**This changes what your shop pays YoPrint.** It acts on your YoPrint subscription, through Stripe, not on your customers' payments.

Schedules the subscription to end at the end of the current billing period. The team keeps its plan until then, and nothing more is charged after it. Undo it before the period ends with "Resume your YoPrint subscription".

**Billing operations.** Every change is one billing operation, named by an `operation_id` you choose: 16 to 64 letters, digits, `_` or `-`, new for each change. Keep it. The answer is the operation, as `{"data": {...}}` without `success` or `status`, and its HTTP status says where it stands:

- `200`: done (`terminal: true`, `outcome: succeeded`). Reload the subscription.
- `202`: still settling, or it needs a recovery. Read it again with `GET .../setting/subscription/operation/{operation_id}`, and call `.../recover` when `next_action` is `recover`.
- `402`: the payment failed (`outcome: payment_failed`). Follow `next_action` (`use_different_card` or `update_card_then_retry`).
- `422`: either refused before anything happened (the error envelope, with `error.code`), or the operation stopped safely (`outcome: safe_failed`, with `error_code` and `next_action`).
- `409`: another billing operation is in progress for the team (`billing_operation_conflict`).
- `503`: Stripe or YoPrint's billing setup can't be reached (`billing_provider_unavailable`).

Never start a second change because an answer was lost or slow: read or recover the same `operation_id` instead, so you can't be charged twice.

## Permission

The team owner, or a member with the Manage Billing permission. Manage Settings alone is not enough.

## Side effects

- Sets the subscription to cancel at the end of the period at Stripe.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `operation_id` (string, required): Matches `^[A-Za-z0-9_-]{16,64}$`.

### Example request

```bash
curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/setting/subscription/current/cancel' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "operation_id": "billing-lifecycle-01JZ0000000000"
  }'
```

## Response

`200` The subscription lifecycle operation reached a successful terminal state.

Fields:

- `data` (object, required)
  - `error_code` (string | null, required): Matches `^[a-z0-9_:-]{1,64}$`.
  - `kind` (string, required): One of: `"card_prepare"`, `"checkout_create"`, `"checkout_swap"`, `"payment_retry"`, `"subscription_cancel"`, `"subscription_resume"`.
  - `next_action` (string, required): One of: `"recover"`, `"refresh_billing"`, `"start_new_operation"`, `"update_card_then_retry"`, `"use_different_card"`, `"wait"`.
  - `operation_id` (string, required): Matches `^[A-Za-z0-9_-]{16,64}$`.
  - `outcome` (string | null, required): One of: `"succeeded"`, `"payment_failed"`, `"safe_failed"`.
  - `retry_class` (string | null, required): One of: `"safe"`, `"compensated"`, `"provider_retry"`, `"reconciliation_required"`.
  - `state` (string, required)
  - `terminal` (boolean, required)
- `status` (integer, optional)
- `success` (boolean, optional)

Example response:

```json
{
  "data": {
    "error_code": null,
    "kind": "subscription_cancel",
    "next_action": "refresh_billing",
    "operation_id": "billing-cancel-01JZ0000000000000",
    "outcome": "succeeded",
    "retry_class": null,
    "state": "settled",
    "terminal": true
  }
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: You are not the owner and your role lacks Manage Billing. The body is `{"message": "Insufficient Permission"}`, without the error envelope. Fix: Use the owner's key, or that of a member with Manage Billing.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `409` A different billing operation owns the team lifecycle or frozen state changed.
  - When: Another billing operation is in progress. Fix: Wait and check the current operation.
- `422` The subscription state rejected this lifecycle action or a terminal safe failure was recorded.
  - When: The subscription can't be cancelled from its current state (`subscription_not_cancellable`), or the body has fields other than `operation_id` (`invalid_lifecycle_context`). Fix: Reload the subscription.
- `503` Billing provider configuration or readback is temporarily unavailable.
  - When: Billing is temporarily unavailable (`billing_provider_unavailable`). Fix: Read the operation again later.

## Notes

- Part of your YoPrint subscription: what your shop pays YoPrint, not your customers' payments.
- AI apps (MCP connections) can't call this operation: they get 403 `agent_operation_not_available`. Use a personal API key.

## Related

- [Resume your YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-current-resume.md): `PATCH /v1/api/store/{team_slug}/setting/subscription/current/resume`
- [Get a YoPrint billing operation](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-operation-show.md): `GET /v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}`