billing

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

Turn a subscription's renewal on or off.

Бүх billing төгсгөлийн цэгүүд

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь billing.payment.manage эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.

Энэ төгсгөл цэг нь ямар ч байгууллагын 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_renewbooleanТийм`true` to charge again at `current_period_end`; `false` to run to the end of the paid period and then expire.

Хариу үйлдэл

НэрТөрөлЗаавал шаардлагатайЭнэ юу вэ
idUuidТиймUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidТиймUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusSubscriptionStatusТиймA subscription's lifecycle state (docs/05 §1).
planSubscriptionPlanRefТиймThe pinned plan version a subscription was sold (a purchase-time snapshot).
priceMoneyAmountТиймThe captured price the subscriber pays (minor units + code, §2.8).
intervalstring<monthly, annual>Тийм
entitlementsobjectТиймThe resolved entitlements captured at purchase (feature/quota map).
current_period_startstringТийм
current_period_endstringТийм
auto_renewbooleanТийм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_atstringТийм
canceled_atobjectҮгүй
created_atstringТийм
updated_atstringҮгүй

Энэ төгсгөл цэгээс буцааж болох алдаанууд

401 · 403 · 404 · 422 · 429