Kündigung zum zulässigen Vertragsende vormerken

Anfrage, Parameter und Antworten für diesen API-Endpunkt.

PUT/api/v1/customer/products/{id}/cancellation

Überblick

Dieser Endpunkt benötigt einen API-Schlüssel mit Schreibzugriff. Sein Ersteller muss weiterhin der Benutzer des Kundenkontos sein.

Header & Parameter

AuthorizationBearer $SYSTEY_API_KEY · erforderlich

idpath · erforderlich

{"type":"string","format":"uuid"}

Beispielanfrage

Ersetzen Sie Platzhalter durch eigene Werte. Speichern Sie $REQUEST_UUID vor einer schreibenden Aktion, sofern dieser Endpunkt einen Idempotency-Key benötigt.

cURL

curl -i -X PUT "https://systey.com/api/v1/customer/products/<resource UUID>/cancellation" \
  -H "Authorization: Bearer $SYSTEY_API_KEY"

Antwort

HTTP 200

Schemafelder und Anforderungen
Feld	Typ	Pflicht
`data`	object	Ja
`data.id` uuid	string	Ja
`data.name`	string	Ja
`data.description`	string \| null	Ja
`data.specificationItems`	array	Ja
`data.specificationItems[]`	object	—
`data.specificationItems[].label`	string	Ja
`data.specificationItems[].value`	string	Ja
`data.status` "ACTIVE" \| "PAUSED" \| "CANCELLED"	string	Ja
`data.sandbox`	boolean	Ja
`data.category` string \| null	string \| null	Ja
`data.priceCents`	integer	Ja
`data.billingCycle` "ONCE" \| "MONTHLY" \| "YEARLY"	string	Ja
`data.commercialModel` "CONTRACT" \| "PREPAID"	string	Ja
`data.renewalMode` "NONE" \| "AUTOMATIC" \| "CUSTOMER"	string	Ja
`data.contractTermMonths`	number \| null	Ja
`data.minimumTermMonths`	number \| null	Ja
`data.renewalMonths`	number \| null	Ja
`data.noticeDays`	number \| null	Ja
`data.serviceStartedAt` date-time \| null	string \| null	Ja
`data.serviceEndsAt` date-time \| null	string \| null	Ja
`data.cancelRequestedAt` date-time \| null	string \| null	Ja
`data.cancelEffectiveAt` date-time \| null	string \| null	Ja
`data.hostname`	string \| null	Ja
`data.ipAddress`	string \| null	Ja
`data.createdAt` date-time	string	Ja
`data.updatedAt` date-time	string	Ja
`data.domain` object \| null	object \| null	Ja
`data.domain.name`	string	Ja
`data.domain.status`	string	Ja
`data.domain.expiresAt` date-time \| null	string \| null	Ja
`data.domain.sandbox`	boolean	Ja

Fehler

Fehlerantworten enthalten error sowie optional message und details. Rate-Limit: 120 Anfragen pro Minute und Schlüssel. Bei HTTP 429 den Retry-After-Header beachten.