Geschenkabonnement

Sie können eine Funktion in Ihre Anwendung integrieren, die es Nutzern ermöglicht, Abonnements an andere zu verschenken. So können Sie den Umsatz ankurbeln und neue Nutzer gewinnen.

So funktioniert's

Ein Nutzer kann einem in Ihrem System vorhandenen Nutzer ein Abonnement schenken, indem er dessen Kontoinformationen angibt. Alternativ kann er das Abonnement einem neuen Nutzer schenken, indem er dessen E-Mail-Adresse angibt. Der Schenker kann seinen Namen verbergen oder der E-Mail-Geschenkbenachrichtigung eine Nachricht anfügen. Nach Abschluss des Abonnements gehört das Abo dem Beschenkten. Das abgeschlossene Abonnement ist vom Typ Einmalzahlung.

Interaktionsablauf beim Verschenken eines Abonnements an einen bestehenden Nutzer:

Interaktionsablauf beim Verschenken eines Abonnements an einen neuen Nutzer:

Einrichtung

Sie können in Ihrer App die Möglichkeit einrichten, ein Abonnement:

• an einen bestehenden Nutzer zu verschenken
• an einen neuen Nutzer zu verschenken

Bestehenden Nutzer beschenken

1. Implementieren Sie in Ihrer Anwendung eine Oberfläche mitsamt den folgenden Bedienelementen für den Kauf eines Geschenkabonnements:
   • Felder für die Eingabe der Daten des Geschenkempfängers
   • Feld für die Eingabe einer Nachricht des Absenders (optional)
   • Auswahlmöglichkeit für den anonymen Versand (optional)
   • Bedienelemente zur Auswahl eines Abo-Modells (optional)

2. Implementieren Sie, dass nach der Eingabe der Geschenkdetails ein Token abgerufen und danach der Bezahlvorgang fortgesetzt wird. Übermitteln Sie dazu das Objekt purchase.subscription.gift mitsamt den folgenden Parametern an den API-Aufruf Token erstellen:
   • recipient – ID des Abonnementempfängers. Erforderlich.
   • email – E-Mail-Adresse des Empfängers. Erforderlich.
   • redirect_url – Redirect-URL. Geben Sie einen Link zu einer Seite mit zusätzlichen Informationen über das geschenkte Abonnement oder zur Hauptseite des Projekts an.

• Zusätzlich können Sie die folgenden Parameter im Objekt purchase.subscription übermitteln:
  • gift.anonymous – ob das Geschenk anonym verschickt wurde. Wenn true, ist der Name des Absenders in der E-Mail-Benachrichtigung ausgeblendet. false ist voreingestellt.
  • gift.message – Nachricht des Geschenkgebers. Wird der per E-Mail versendeten Geschenkbenachrichtigung angefügt.
  • plan_id – ID des Abo-Modells.

Beispielhafte Anfrage für den Abruf eines Tokens:

{
  "purchase": {
    "checkout": {
      "currency": "USD",
      "amount": 10
    },
    "subscription": {
      "gift": {
        "recipient": "test_recipient_v1",
        "email": "recipient_email@email.com",
        "redirect_url": "https://example.com/",
        "anonymous": true,
        "message": "Happy birthday!"
      }
    }
  },
  "settings": {
    "currency": "USD",
    "language": "en",
    "project_id": 16184,
    "ui": {
      "components": {
        "virtual_currency": {
          "custom_amount": true
        }
      },
      "desktop": {
        "virtual_item_list": {
          "button_with_price": true,
          "layout": "list"
        }
      },
      "size": "medium"
    }
  },
  "user": {
    "country": {
      "allow_modify": true,
      "value": "US"
    },
    "age": 19,
    "email": {
      "value": "john.smith@mail.com"
    },
    "id": {
      "value": "user_2"
    },
    "name": {
      "value": "John Smith"
    }
  }
}

3. Öffnen Sie mithilfe des in Schritt 2 erhaltenen Tokens das Zahlungsportal in einem neuen Fenster, in einem iframe oder mittels Pay Station Embed.

Neuen Nutzer beschenken

1. Implementieren Sie in Ihrer Anwendung eine Oberfläche mitsamt den folgenden Bedienelementen für den Kauf eines Geschenkabonnements:
   • Feld für die Eingabe der E-Mail-Adresse des Geschenkempfängers
   • Feld für die Eingabe einer Nachricht des Absenders (optional)
   • Auswahlmöglichkeit für den anonymen Versand (optional)
   • Bedienelemente zur Auswahl eines Abo-Modells (optional)
2. Implementieren Sie, dass ein neuer Nutzer angelegt und ihm eine ID in Ihrem System zugewiesen wird.
3. Generieren Sie einen Link, über den der neu angelegte Nutzer sein Konto aktivieren kann.

4. Implementieren Sie, dass nach der Eingabe der Geschenkdetails ein Token abgerufen und danach der Bezahlvorgang fortgesetzt wird. Übermitteln Sie dazu das Objekt purchase.subscription.gift mitsamt den folgenden Parametern an den API-Aufruf Token erstellen:
   • recipient – die in Schritt 2 erstellte ID des Abonnementempfängers.
   • email – E-Mail-Adresse des Empfängers.
   • redirect_url – die in Schritt 3 erstellte Aktivierungs-URL.

• Zusätzlich können Sie die folgenden Parameter im Objekt purchase.subscription übermitteln:
  • gift.anonymous – ob das Geschenk anonym verschickt wurde. Wenn true, ist der Name des Absenders in der E-Mail-Benachrichtigung ausgeblendet. false ist voreingestellt.
  • gift.message – Nachricht des Geschenkgebers. Wird der per E-Mail versendeten Geschenkbenachrichtigung angefügt.
  • plan_id – ID des Abo-Modells.

Beispielhafte Anfrage für den Abruf eines Tokens:

{
  "purchase": {
    "checkout": {
      "currency": "USD",
      "amount": 10
    },
    "subscription": {
      "gift": {
        "recipient": "test_recipient_v1",
        "email": "recipient_email@email.com",
        "redirect_url": "https://example.com/",
        "anonymous": true,
        "message": "Happy birthday!"
      }
    }
  },
  "settings": {
    "currency": "USD",
    "language": "en",
    "project_id": 16184,
    "ui": {
      "components": {
        "virtual_currency": {
          "custom_amount": true
        }
      },
      "desktop": {
        "virtual_item_list": {
          "button_with_price": true,
          "layout": "list"
        }
      },
      "size": "medium"
    }
  },
  "user": {
    "country": {
      "allow_modify": true,
      "value": "US"
    },
    "age": 19,
    "email": {
      "value": "john.smith@mail.com"
    },
    "id": {
      "value": "user_2"
    },
    "name": {
      "value": "John Smith"
    }
  }
}

5. Öffnen Sie mithilfe des in Schritt 4 erhaltenen Tokens das Zahlungsportal in einem neuen Fenster, in einem iframe oder mittels Pay Station Embed.