Neues Abonnement erstellen
Erstellt ein neues Abonnement und legt die gewünschten Werte für die Subscription API Ressource fest. Dies dient dazu, ein Abonnement mit benutzerdefinierten Einstellungen zu initiieren, die auf Ihre Anforderungen zugeschnitten sind.
HTTP-Methode und Endpunkt
POST /accounts/{account_id}/core/v1/subscriptions
Nutzungshinweise
Gibt die gewünschten Werte für die zu erstellende Subscription-API-Ressource an.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
True |
ID der übergeordneten Kontoressource
|
Anfragetext
Gibt die gewünschten Werte für die zu erstellende Subscription-API-Ressource an.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
True |
Version der Ressource. Definierte Werte sind:
|
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:
|
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:
|
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:
|
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:
|
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:
|
Marktplatz |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die den Marktplatz für ein Konto angibt, auf dem Zahlungen erfasst werden. Definierte Werte:
|
Bedingungen |
Zeichenkette |
True |
JSON-Zeichenkette, die die aktuelle Stufe des Kontos angibt. Definierte Werte sind:
|
Metadaten |
Falsch |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielanfrage
{
"type": "application/astra-subscription",
"version": "1.2",
"terms": "trial"
}
Antwort
Status: 201, Returns the newly created subscription resource in the JSON response body.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
True |
Version der Ressource. Definierte Werte sind:
|
id |
Zeichenkette |
True |
Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:
|
Kundenprofil-ID |
Zeichenkette |
True |
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:
|
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:
|
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:
|
purchaseOrderNumber |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der Bestellnummer für die Zahlungsmethode. Folgende Werte sind definiert:
|
Marktplatz |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die den Marktplatz für ein Konto angibt, auf dem Zahlungen erfasst werden. Definierte Werte:
|
licenseSN |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der Lizenzseriennummer für die Zahlungsmethode. Folgende Werte sind definiert:
|
Bedingungen |
Zeichenkette |
True |
JSON-Zeichenkette, die die aktuelle Stufe des Kontos angibt. Definierte Werte sind:
|
Status |
Zeichenkette |
True |
JSON-Zeichenkette, die den aktuellen Status des Abonnements angibt. Folgende Werte sind definiert:
|
appLimit |
Nummer |
True |
JSON-Zahl, die das Anwendungslimit für dieses Abonnement angibt. Der Wert -1 bedeutet, dass kein Limit besteht. |
namespaceLimit |
Nummer |
True |
JSON-Zahl, die das Namespace-Limit für dieses Abonnement angibt. Der Wert -1 bedeutet, dass kein Limit gilt. |
subscriptionPeriod |
Nummer |
True |
JSON-Zahl, die den Abonnementzeitraum angibt. Der Wert -1 bedeutet keine Begrenzung. Einheit: Tage |
gracePeriod |
Nummer |
True |
JSON-Zahl, die die Kulanzfrist nach Ablauf des Probeabonnements oder bei Kündigung eines kostenpflichtigen Abonnements angibt. Einheit: Tage |
reminderBeforePeriod |
Nummer |
True |
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 |
True |
JSON-Zeichenkette, die den aktuellen Status des Kunden-Onboardings angibt. Gültige Werte sind „nicht gestartet“, „in Bearbeitung“, „erfolgreich“ und „fehlgeschlagen“. Definierte Werte sind:
|
costPerAppUnit |
Nummer |
True |
JSON-Zahl, die die Kosten pro App-Einheit angibt. Bei einer Testversion ist der Wert 0. Einheit: US-Dollar |
costPerNamespaceUnit |
Nummer |
True |
JSON-Zahl, die die Kosten pro Namespace-Einheit angibt. Für eine Testversion ist der Wert 0. Einheit: US-Dollar |
Metadaten |
True |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielantwort
{
"type": "application/astra-subscription",
"version": "1.2",
"id": "40b4106f-b743-5d83-95c7-d539b2b45f63",
"customerProfileID": "2157047189",
"paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
"paymentExpiry": "2022-02-01T00:00:00Z",
"purchaseOrderNumber": "72384632",
"marketplace": "netapp",
"licenseSN": "278343",
"terms": "trial",
"status": "active",
"appLimit": 0,
"namespaceLimit": 10,
"subscriptionPeriod": 90,
"gracePeriod": 7,
"reminderBeforePeriod": 30,
"onboardStatus": "in progress",
"costPerAppUnit": 0,
"costPerNamespaceUnit": 0.005,
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
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/2",
"title": "Collection not found",
"detail": "The collection 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:
|
addressLocality |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Ort (z. B. Stadt) zur Postanschrift. Folgende Werte sind definiert:
|
addressRegion |
Zeichenkette |
True |
JSON-Zeichenkette mit der Region (z. B. Bundesland), die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:
|
postalCode |
Zeichenkette |
True |
JSON-Zeichenkette mit der Postleitzahl, die der Postanschrift zugeordnet ist. Definierte Werte sind:
|
streetAddress1 |
Zeichenkette |
True |
JSON-Zeichenkette mit der Straßenadresse, die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:
|
streetAddress2 |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit optionalen zusätzlichen Adressinformationen, Postfach und mehr. Definierte Werte sind:
|
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 |