billing

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

Turn a subscription's renewal on or off.

Svi billing krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu billing.payment.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

NazivVrstaObaveznoŠto je to
subscriptionId (path)UuidDaThe subscription whose renewal is being changed.

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
auto_renewbooleanDatrue to charge again at current_period_end; false to run to the end of the paid period and then expire.

Odgovor

NazivVrstaObaveznoŠto je to
idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusSubscriptionStatusDaA subscription's lifecycle state (docs/05 §1).
planSubscriptionPlanRefDaThe pinned plan version a subscription was sold (a purchase-time snapshot).
priceMoneyAmountDaThe captured price the subscriber pays (minor units + code, §2.8).
intervalstring<monthly, annual>Da
entitlementsobjectDaThe resolved entitlements captured at purchase (feature/quota map).
current_period_startstringDa
current_period_endstringDa
auto_renewbooleanDaWhether 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>NeWhich 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_atstringDa
canceled_atobjectNe
created_atstringDa
updated_atstringNe

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422 · 429