---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Cancel a customer subscription"
description: "`money.customer_subscriptions.cancel` (POST /v1/{name}:cancel): Cancels a web subscription, now or at the period end, and optionally refunds its last payment (for example a statutory cancellation window)."
type: reference
product: payments
summary: "Cancels a web subscription, now or at the period end, and optionally refunds its last payment (for example a statutory cancellation window)."
updated: 2026-09-28
nav: false
---

Cancels a web subscription, now or at the period end, and optionally refunds its last payment (for example a statutory cancellation window).

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription:cancel`
- **Scope** `billing:write`
- **Effect** `destructive` — a successful call removes data; the CLI asks before it runs.
- **Collection** [customer_subscriptions](/docs/api/customer_subscriptions)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The subscription to cancel. Required. |
| `at_period_end` | `bool` | End it at the period end (true) or now (false). |
| `refund_last_payment` | `bool` | Refund the last payment in full; only with `at_period_end` false. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/customer_subscriptions/{customer_subscription}`. |
| `uid` | `string` | `csb_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `subject` | `Subject` | Who holds it. Output only. |
| `source` | `string` | `stripe`, `app_store`, or `google_play`. Output only. |
| `processor_subscription_id` | `string` | The processor's subscription id. Output only. |
| `status` | `string` | `trialing`, `active`, `past_due`, `paused`, `canceled`, `unpaid`, `incomplete`, or `incomplete_expired`, as the processor reports it. Output only. |
| `items` | `LineItem[]` | The prices, by lookup key, and their quantities. Output only. |
| `current_period_end_time` | `timestamp` | The end of the paid period. Output only. |
| `cancel_at_period_end` | `bool` | Whether it ends at `current_period_end_time` instead of renewing. Output only. |
| `trial_end_time` | `timestamp` | The end of the trial, when there is one. Output only. |
| `metadata` | `struct` | The checkout's metadata. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### Subject

| Field | Type | What it is |
| --- | --- | --- |
| `end_user` | `string` | An end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the `kind` group. |
| `customer_organization` | `string` | A customer organization's id. One of the `kind` group. |

### LineItem

| Field | Type | What it is |
| --- | --- | --- |
| `price` | `string` | The price's lookup key. Required. |
| `quantity` | `int32` | How many; default 1. Seats for a per-seat or family price. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`UNAVAILABLE`](/docs/api/errors/UNAVAILABLE) — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription:cancel" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

```ts
const response = await sylphx.money.customerSubscriptions.cancel({ name: 'orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription' })
```

**Rust**

```rust
let mut req = sylphx::money::CancelCustomerSubscriptionRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription".to_string();
let response = sx.money().customer_subscriptions().cancel(req).await?;
```

**CLI**

```bash
sylphx money customer-subscriptions cancel orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription --yes
```

**MCP**

```json
{ "method_id": "money.customer_subscriptions.cancel", "args": {"name":"orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription"} }
```