Abonnement cadeau

Vous pouvez inclure dans votre application une fonctionnalité permettant aux utilisateurs d’offrir des abonnements à d’autres personnes. Cette initiative peut contribuer à augmenter les revenus tout en attirant de nouveaux utilisateurs.

Comment ça marche

Un utilisateur peut offrir un abonnement à un utilisateur existant dans votre système en spécifiant les informations de son compte ou à un nouvel utilisateur en indiquant son adresse e-mail. Si l’utilisateur qui envoie le cadeau le souhaite, il peut masquer son nom ou ajouter un message textuel à la notification par e-mail accompagnant le cadeau. Une fois l’abonnement créé, le destinataire du cadeau en devient le propriétaire. L’abonnement créé est de type de renouvellement à paiement unique.

Flux d’interaction lors de l’offre d’un abonnement à un utilisateur existant :

Flux d’interaction lors de l’offre d’un abonnement à un nouvel utilisateur :

Comment configurer

Vous pouvez configurer la possibilité d’offrir un abonnement dans votre application :

• à un utilisateur existant ;
• à un nouvel utilisateur.

Cadeau à un utilisateur existant

1. Implémentez dans votre application une interface pour l'achat d'un abonnement cadeau avec les éléments suivants :
   • champs pour la saisie des données du destinataire du cadeau ;
   • champ pour la saisie d'un message de l'expéditeur (facultatif) ;
   • option pour sélectionner l'envoi anonyme (facultatif) ;
   • éléments pour sélectionner un plan d'abonnement (facultatif).

2. Implémentez la réception d'un jeton après avoir rempli les détails du cadeau lors du paiement. Pour cela, passez l'objet purchase.subscription.gift à l'appel API Créer un jeton avec les paramètres suivants :
   • recipient — ID du destinataire de l'abonnement. Obligatoire.
   • email — Adresse e-mail du destinataire. Obligatoire.
   • redirect_url — URL de redirection. Fournissez un lien vers une page contenant des informations supplémentaires sur l'abonnement offert ou vers la page principale du projet.

• De plus, vous pouvez passer les paramètres suivants dans l'objet purchase.subscription :
  • gift.anonymous — si le cadeau a été envoyé de manière anonyme. Si true, le nom de l’expéditeur est masqué dans la notification par e-mail. La valeur par défaut est false.
  • gift.message — message de l'expéditeur du cadeau. Envoyé dans la notification par e-mail de l'abonnement offert.
  • plan_id — ID du plan d'abonnement.

Exemple de requête de réception d’un jeton :

{
  "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. À l'aide du token reçu à l'étape 4, ouvrez l'interface de paiement dans une nouvelle fenêtre, dans un iframe ou via Pay Station Embed.

Cadeau à un nouvel utilisateur

1. Implémentez dans votre application une interface pour l'achat d'un abonnement cadeau avec les éléments suivants :
   • champs pour la saisie de l'adresse e-mail du destinataire du cadeau ;
   • champ pour la saisie d'un message de l'expéditeur (facultatif) ;
   • option pour sélectionner l'envoi anonyme (facultatif) ;
   • éléments pour sélectionner un plan d'abonnement (facultatif).
2. Implémentez la création d'un nouvel utilisateur et lui attribuer un identifiant dans votre système.
3. Créez un lien pour activer le compte utilisateur.

4. Implémentez la réception d'un jeton après avoir rempli les détails du cadeau lors du paiement. Pour ce faire, passez l'objet purchase.subscription.gift avec les paramètres de l'API Créer un jeton :
   • recipient — ID du destinataire de l'abonnement créé à l'étape 2 ;
   • email — adresse e-mail du destinataire ;
   • redirect_url — URL d'activation créée à l'étape 3.

• De plus, vous pouvez passer les paramètres suivants dans l'objet purchase.subscription :
  • gift.anonymous — si le cadeau a été envoyé de manière anonyme. Si true, le nom de l’expéditeur est masqué dans la notification par e-mail. La valeur par défaut est false.
  • gift.message — message de l'expéditeur du cadeau. Envoyé dans la notification par e-mail de l'abonnement offert.
  • plan_id — ID du plan d'abonnement.

Exemple de requête de réception d’un jeton :

{
  "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. À l'aide du token reçu à l'étape 4, ouvrez l'interface de paiement dans une nouvelle fenêtre, dans un iframe ou via Pay Station Embed.