Skip to main content
Eine neuere Version dieses Produkts ist erhältlich.
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Abonnement ändern

Änderungen vorschlagen
PDFs

PUT /accounts/{account_id}/core/v1/subscriptions/{subscription_id}

Ersetzt die gesamte gespeicherte Ressource durch den bereitgestellten JSON-Anfragetext, wobei Schlüsselwerte erhalten bleiben, die vom Benutzer nicht geändert werden können.

Nebenwirkungen

  • Wenn der Benutzer das Abonnement kündigt, muss der PUT-Endpunkt mit "status": "inactive" aufgerufen werden.

  • Wenn der Status auf „inaktiv“ gesetzt wird, werden die ausstehenden Gebühren für dieses Abonnement an Zuora gesendet und das Zuora-Abonnement wird auf irgendeine Weise als „inaktiv“ gekennzeichnet.

Parameter

Name Typ In Erforderlich Beschreibung

Konto-ID

Zeichenkette

Pfad

True

ID der übergeordneten Kontoressource

  • Beispiel: {{.Account}}

Abonnement-ID

Zeichenkette

Pfad

True

ID der aufzulistenden Abonnementsammlung

Anfragetext

Ersetzt die gesamte gespeicherte Ressource durch den bereitgestellten JSON-Anfragetext, wobei Schlüsselwerte erhalten bleiben, die vom Benutzer nicht geändert werden können.

Nebenwirkungen

  • Wenn der Benutzer das Abonnement kündigt, muss der PUT-Endpunkt mit "status": "inactive" aufgerufen werden.

  • Wenn der Status auf „inaktiv“ gesetzt wird, werden die ausstehenden Gebühren für dieses Abonnement an Zuora gesendet und das Zuora-Abonnement wird auf irgendeine Weise als „inaktiv“ gekennzeichnet.

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Medientyp der Ressource. Definierte Werte sind:

  • "application/astra-subscription"

Version

Zeichenkette

True

Version der Ressource. Definierte Werte sind:

  • "1,0"

  • "1,1"

  • "1,2"

id

Zeichenkette

Falsch

Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:

  • Entspricht dem UUIDv4-Schema

Kundenprofil-ID

Zeichenkette

Falsch

JSON-Zeichenkette, die die Kundenprofil-ID von "Authorize.net" enthält, welche von der Benutzeroberfläche aufgerufen wurde, ist für die Testphase nicht festgelegt. Gibt beim Lesevorgang eine leere Zeichenkette zurück, falls nicht festgelegt. Definierte Werte sind:

  • Mindestlänge: 0

  • Maximale Länge: 63

paymentFirstName

Zeichenkette

Falsch

JSON-Zeichenkette mit dem vom Benutzer angegebenen Vornamen in Langform für die Zahlungsabwicklung. Wird nur bei der Verlängerung des Abonnements angegeben. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

paymentLastName

Zeichenkette

Falsch

JSON-Zeichenkette mit dem vom Benutzer angegebenen, ausgeschriebenen Nachnamen für die Zahlungsabwicklung. Wird nur bei der Verlängerung des Abonnements angegeben. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

paymentAddress

"paymentAddress"

Falsch

Ein JSON-Objekt mit einer Sammlung von JSON-Zeichenketten, die eine Rechnungsadresse angeben. Wird nur angegeben, wenn das Abonnement erneut abgerechnet wird. Wenn dieser Schlüssel existiert, sind alle sechs enthaltenen JSON-Zeichenketten vorhanden. Wenn vom Benutzer nichts angegeben wurde, ist die Zeichenkette leer.

paymentProfileID

Zeichenkette

Falsch

JSON-Zeichenkette mit der Zahlungsprofil-ID von "Authorize.net" die von der Benutzeroberfläche aufgerufen wurde, nicht für die Testphase festgelegt. Gibt während des Lesevorgangs eine leere Zeichenkette zurück, falls nicht festgelegt. Definierte Werte sind:

  • Mindestlänge: 0

  • Maximale Länge: 63

paymentExpiry

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Zeitstempel, der das Ablaufdatum der Zahlungsmethode angibt. Diese Angabe stammt von authorize.net(http://authorize.net und wird über die Benutzeroberfläche festgelegt. Folgende Werte sind definiert:

  • Entspricht dem ISO-8601-Datums- und Zeitschema. Dieses Feld wird bei Testlaufzeiten nicht zurückgegeben.

purchaseOrderNumber

Zeichenkette

Falsch

JSON-Zeichenkette mit der Bestellnummer für die Zahlungsmethode. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 31

Marktplatz

Zeichenkette

Falsch

JSON-Zeichenkette, die den Marktplatz für ein Konto angibt, auf dem Zahlungen erfasst werden. Definierte Werte:

  • "netapp"

  • "azure"

  • "aws"

  • "gcp"

licenseSN

Zeichenkette

Falsch

JSON-Zeichenkette mit der Lizenzseriennummer für die Zahlungsmethode. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 31

Bedingungen

Zeichenkette

Falsch

JSON-Zeichenkette, die die aktuelle Stufe des Kontos angibt. Definierte Werte sind:

  • "Testversion"

  • "bezahlt"

Status

Zeichenkette

Falsch

JSON-Zeichenkette, die den aktuellen Status des Abonnements angibt. Folgende Werte sind definiert:

  • "aktiv"

  • "inaktiv"

appLimit

Nummer

Falsch

JSON-Zahl, die das Anwendungslimit für dieses Abonnement angibt. Der Wert -1 bedeutet, dass kein Limit besteht.

namespaceLimit

Nummer

Falsch

JSON-Zahl, die das Namespace-Limit für dieses Abonnement angibt. Der Wert -1 bedeutet, dass kein Limit gilt.

subscriptionPeriod

Nummer

Falsch

JSON-Zahl, die den Abonnementzeitraum angibt. Der Wert -1 bedeutet keine Begrenzung. Einheit: Tage

gracePeriod

Nummer

Falsch

JSON-Zahl, die die Kulanzfrist nach Ablauf des Probeabonnements oder bei Kündigung eines kostenpflichtigen Abonnements angibt. Einheit: Tage

reminderBeforePeriod

Nummer

Falsch

Eine JSON-Zahl, die angibt, wie viele Tage vor Ablauf des Testabonnements die Kundenbenachrichtigungen beginnen. Der Wert wird in Tagen angegeben, wobei -1 bedeutet, dass dies nicht zutrifft.

onboardStatus

Zeichenkette

Falsch

JSON-Zeichenkette, die den aktuellen Status des Kunden-Onboardings angibt. Gültige Werte sind „nicht gestartet“, „in Bearbeitung“, „erfolgreich“ und „fehlgeschlagen“. Definierte Werte sind:

  • "nicht gestartet"

  • "im Gange"

  • "Erfolg"

  • "fehlgeschlagen"

costPerAppUnit

Nummer

Falsch

JSON-Zahl, die die Kosten pro App-Einheit angibt. Bei einer Testversion ist der Wert 0. Einheit: US-Dollar

costPerNamespaceUnit

Nummer

Falsch

JSON-Zahl, die die Kosten pro Namespace-Einheit angibt. Für eine Testversion ist der Wert 0. Einheit: US-Dollar

Metadaten

"type_astra_metadata_update"

Falsch

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:

  • Entspricht dem Astra-Metadatenschema. Wird beim Erstellen kein Label angegeben, wird ein Metadatenobjekt ohne Labels erstellt. Wird beim Aktualisieren kein Label angegeben, bleiben die Labels, creationTimestamp und createdBy, des Metadatenobjekts unverändert erhalten.
Beispielanfrage 
{
  "type": "application/astra-subscription",
  "version": "1.2",
  "customerProfileID": "2157047189",
  "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
  "paymentExpiry": "2022-05-01T00:00:00Z"
}

Antwort

Status: 204, Indicates if the subscription resource was updated.

Antwort

Status: 401, Unauthorized
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

Korrelations-ID

Zeichenkette

Falsch
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Antwort

Status: 400, Bad request
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

Korrelations-ID

Zeichenkette

Falsch

invalidFields

Array["invalidFields"]

Falsch

Liste ungültiger Anfragetextfelder
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Antwort

Status: 409, Conflict
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

Korrelations-ID

Zeichenkette

Falsch

invalidFields

Array["invalidFields"]

Falsch

Liste ungültiger Anfragetextfelder
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

Antwort

Status: 403, Forbidden
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

Korrelations-ID

Zeichenkette

Falsch
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Fehler

Status: 404, Not found
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

Korrelations-ID

Zeichenkette

Falsch
Beispiel-Fehlermeldung 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Definitionen

Siehe Definitionen

paymentAddress

Ein JSON-Objekt mit einer Sammlung von JSON-Zeichenketten, die eine Rechnungsadresse angeben. Wird nur angegeben, wenn das Abonnement erneut abgerechnet wird. Wenn dieser Schlüssel existiert, sind alle sechs enthaltenen JSON-Zeichenketten vorhanden. Wenn vom Benutzer nichts angegeben wurde, ist die Zeichenkette leer.

Name Typ Erforderlich Beschreibung

addressCountry

Zeichenkette

True

JSON-Zeichenkette mit dem Ländernamen oder Ländercode, der der Postanschrift gemäß ISO 3166 Alpha-2 zugeordnet ist. Definierte Werte sind:

  • Mindestlänge: 0

  • Maximale Länge: 2

addressLocality

Zeichenkette

True

JSON-Zeichenkette mit dem Ort (z. B. Stadt) zur Postanschrift. Folgende Werte sind definiert:

  • Mindestlänge: 0

  • Maximale Länge: 63

addressRegion

Zeichenkette

True

JSON-Zeichenkette mit der Region (z. B. Bundesland), die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:

  • Mindestlänge: 0

  • Maximale Länge: 63

postalCode

Zeichenkette

True

JSON-Zeichenkette mit der Postleitzahl, die der Postanschrift zugeordnet ist. Definierte Werte sind:

  • Mindestlänge: 0

  • Maximale Länge: 63

streetAddress1

Zeichenkette

True

JSON-Zeichenkette mit der Straßenadresse, die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:

  • Mindestlänge: 0

  • Maximale Länge: 63

streetAddress2

Zeichenkette

Falsch

JSON-Zeichenkette mit optionalen zusätzlichen Adressinformationen, Postfach und mehr. Definierte Werte sind:

  • Mindestlänge: 0

  • Maximale Länge: 63

Typ_Astra_Label

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Wert

Zeichenkette

True

type_astra_metadata_update

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:

  • Entspricht dem Astra-Metadatenschema. Wird beim Erstellen kein Label angegeben, wird ein Metadatenobjekt ohne Labels erstellt. Wird beim Aktualisieren kein Label angegeben, bleiben die Labels, creationTimestamp und createdBy, des Metadatenobjekts unverändert erhalten.

Name Typ Erforderlich Beschreibung

Etiketten

Array["Typ_Astra_Label"]

Falsch

CreationZeitstempel

Zeichenkette

Falsch

Änderungszeitstempel

Zeichenkette

Falsch

Erstellt von

Zeichenkette

Falsch

modifiedBy

Zeichenkette

Falsch

invalidParams

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Name des ungültigen Abfrageparameters

Grund

Zeichenkette

True

Grund, warum der Abfrageparameter ungültig ist

invalidFields

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Name des ungültigen Anfragetextfelds

Grund

Zeichenkette

True

Grund, warum das Anfragekörperfeld ungültig ist