---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Customer subscriptions"
description: "The `customer_subscriptions` collection of Sylphx Money: A Customer Subscription is a subject's recurring purchase, mirrored from the processor after Money read it back."
type: reference
product: payments
summary: "A Customer Subscription is a subject's recurring purchase, mirrored from the processor after Money read it back."
updated: 2026-09-28
order: 900
---

A Customer Subscription is a subject's recurring purchase, mirrored from the processor after Money read it back. Money writes it; a caller changes it only through `:cancel` and `:resume`.

**Service** Sylphx Money · **Resource type** `money.sylphx.com/CustomerSubscription` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/customer_subscriptions/{customer_subscription}` · **Shape** `record`

## Fields

| 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. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/customer_subscriptions#get) | Gets a customer subscription. |
| `GET` | [`list`](/docs/api/customer_subscriptions#list) | Lists customer subscriptions, newest first. |
| `POST` | [`cancel`](/docs/api/customer_subscriptions#cancel) | Cancels a web subscription, now or at the period end, and optionally refunds its last payment (for example a statutory cancellation window). |
| `POST` | [`resume`](/docs/api/customer_subscriptions#resume) | Resumes a web subscription set to cancel at its period end. |
| `POST` | [`update_quantity`](/docs/api/customer_subscriptions#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. |

## get

Gets a 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.

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

## cancel

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

`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)

## resume

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

`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.

`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)