billing
POST /v1/subscriptions/{subscriptionId}/auto-renew
Turn a subscription's renewal on or off.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს billing.payment.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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.… |
billing_rail | string<engine, paypal> | არა | Which clock decides when this subscription is charged (W41-G, ADR 0029). engine is the default and is what ADR 0011 describes: the engine decides money is due, mints an… |
started_at | string | დიახ | — |
canceled_at | object | არა | — |
created_at | string | დიახ | — |
updated_at | string | არა | — |
შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს
401 · 403 · 404 · 422 · 429