billing

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

Turn a subscription's renewal on or off.

Minden billing végpont

Az összes fejlesztői dokumentáció

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.payment.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

NévTípusKötelezőMi ez
subscriptionId (path)UuidIgenThe subscription whose renewal is being changed.

Kérés törzse

NévTípusKötelezőMi ez
auto_renewbooleanIgentrue to charge again at current_period_end; false to run to the end of the paid period and then expire.

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusSubscriptionStatusIgenA subscription's lifecycle state (docs/05 §1).
planSubscriptionPlanRefIgenThe pinned plan version a subscription was sold (a purchase-time snapshot).
priceMoneyAmountIgenThe captured price the subscriber pays (minor units + code, §2.8).
intervalstring<monthly, annual>Igen
entitlementsobjectIgenThe resolved entitlements captured at purchase (feature/quota map).
current_period_startstringIgen
current_period_endstringIgen
auto_renewbooleanIgenWhether 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_railstring<engine, paypal>NemWhich 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_atstringIgen
canceled_atobjectNem
created_atstringIgen
updated_atstringNem

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429