---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx money customer_subscriptions"
description: "The sylphx money customer_subscriptions commands of Sylphx Money: every verb, with its argument, its flags and a run line."
type: reference
product: payments
summary: "Every sylphx money customer_subscriptions command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `customer_subscriptions` commands of Sylphx Money, as the CLI spells them: the same
calls as [the `customer_subscriptions` API page](/docs/api/customer_subscriptions), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a customer subscription.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

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

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription` · scope `billing:read` · effect `read` · [Request, response and examples](/docs/api/customer_subscriptions/get)

## list

Lists customer subscriptions, newest first.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx money customer-subscriptions list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions` · scope `billing:read` · effect `read` · [Request, response and examples](/docs/api/customer_subscriptions/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over filterable fields. |

## cancel

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

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

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

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription:cancel` · scope `billing:write` · effect `destructive` · [Request, response and examples](/docs/api/customer_subscriptions/cancel)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--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. |
| `--yes` | `bool` | Do not ask before this destructive call. |

## resume

Resumes a web subscription set to cancel at its period end.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

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

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription:resume` · scope `billing:write` · effect `write` · [Request, response and examples](/docs/api/customer_subscriptions/resume)

## update-quantity

Changes the seat quantity of a web subscription, now, and syncs the processor's subscription item to it. A retry with the same `Idempotency-Key` (required) and the same request changes nothing twice.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

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

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription:updateQuantity` · scope `billing:write` · effect `write` · [Request, response and examples](/docs/api/customer_subscriptions/update_quantity)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--quantity` | `int` | The new quantity (seats) of the subscription's one item; at least 1. To end the subscription, cancel it. Required. |
| `--proration-behavior` | `enum` | How the change is billed; unspecified is `create_prorations`. One of `create_prorations`, `none`, `always_invoice`. |