billing

POST `/v1/subscriptions/{subscriptionId}/auto-renew`

Turn a subscription's renewal on or off.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/subscriptions/{subscriptionId}/auto-renew \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "auto_renew": <boolean> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

**The customer's renewal switch, and the only one there is.** With `auto_renew` **false** the subscription runs to the end of the period already paid for and is then `expired` by the rebill sweep — nothing is minted, no card is charged, and the entitlements lapse at the same instant the period does. It is **not** an immediate cancellation: every day already bought is kept. With it **true** the subscription is selected by the nightly sweep at `current_period_end`, an order is minted and the payment method is charged. The switch is reversible right up to that moment, which is the customer's way back after turning it off. For a compute server the machine follows on its own: the provider's own renewal flag is pinned to "hold" for the life of every machine and is never exposed, so an unrenewed contract keeps serving for 24 hours, is powered down, and is deleted six days after that. Zinn® issues each vendor renewal explicitly, after the money is captured. Find a server's subscription with `subscription_id` on `GET /v1/compute/servers/{serverId}/renewal`. The response is the subscription **as the database now holds it**, not an echo of the request. Requires `billing.payment.manage` — the authority to decide what this account is charged. It deliberately does **not** require `sites.view`: a subscription is not a site, and this endpoint governs every plan, including ones that own no site. `404` for a subscription in another tenant as well as for one that does not exist — a `403` would confirm that an id belongs to somebody. `422` when the subscription has already ended (`canceled`/`expired`): writing `true` to a row the sweep can never select again would tell the customer they were covered when nothing will charge or serve them.

参数

名称	类型	必填	内容简介
`subscriptionId (path)`	`Uuid`	是	The subscription whose renewal is being changed.

请求正文

名称	类型	必填	内容简介
`auto_renew`	`boolean`	是	`true` to charge again at `current_period_end`; `false` to run to the end of the paid period and then expire.

响应

名称	类型	必填	内容简介
`id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`SubscriptionStatus`	是	A subscription's lifecycle state (docs/05 §1).
`plan`	`SubscriptionPlanRef`	是	The pinned plan version a subscription was sold (a purchase-time snapshot).
`price`	`MoneyAmount`	是	The captured price the subscriber pays (minor units + code, §2.8).
`interval`	`string<monthly, annual>`	是	—
`entitlements`	`object`	是	The resolved entitlements captured at purchase (feature/quota map).
`current_period_start`	`string`	是	—
`current_period_end`	`string`	是	—
`auto_renew`	`boolean`	是	Whether this subscription charges again at `current_period_end`. `false` does not mean it has ended: it runs to the end of the period already paid for and is then `expired`. Cha…
`started_at`	`string`	是	—
`canceled_at`	`object`	否	—
`created_at`	`string`	是	—
`updated_at`	`string`	否	—

此端点可能返回的错误

401 · 403 · 404 · 422 · 429

POST /v1/subscriptions/{subscriptionId}/auto-renew