Vale-assinatura

Você pode incluir um recurso no seu aplicativo que permite aos usuários dar vale-assinaturas. Isso pode ajudar a aumentar a receita e atrair novos usuários.

Como funciona

Um usuário pode dar uma assinatura a um usuário existente no sistema especificando as informações de conta, ou a um novo usuário especificando o endereço de e-mail. Nesse caso, remetente pode ocultar seu nome ou adicionar uma mensagem de texto à notificação por e-mail. Após criar uma assinatura, o destinatário vira proprietário da assinatura. A assinatura criada é do tipo de renovação de pagamento único.

Fluxo de interação ao dar uma assinatura a um usuário existente:

Fluxo de interação ao dar uma assinatura a um novo usuário:

Como configurar

Você pode configurar a possibilidade de dar uma assinatura no seu aplicativo:

• para um usuário existente
• para um novo usuário

Presentear um usuário existente

1. Implemente no seu aplicativo uma interface de compra de vale-assinaturas com os seguintes elementos:
   • campos para inserção de dados do destinatário
   • campo para inserção de mensagem do remetente (opcional)
   • opção para seleção de envio anônimo (opcional)
   • elementos para selecionar um plano de assinatura (opcional)

2. Implemente o recebimento de um token após o preenchimento dos dados do vale ao prosseguir ao pagamento. Para fazer isso, passe o purchase.subscription.gift objeto para a chamada de API Create token com os seguintes parâmetros:
   • recipient — ID do destinatário da assinatura. Obrigatório.
   • email — endereço de e-mail do destinatário. Obrigatório.
   • redirect_url — URL de redirecionamento. Forneça um link para uma página com informações adicionais sobre a assinatura oferecida ou para a página principal do projeto.

• Além disso, você pode passar os seguintes parâmetros no purchase.subscription objeto:
  • gift.anonymous — se o presente foi enviado anonimamente. Se true, o nome do remetente está oculto na notificação por e-mail. O padrão é false.
  • gift.message — mensagem do remetente. Enviado em uma notificação por e-mail sobre o vale-assinatura.
  • plan_id — ID do plano de assinatura.

Exemplo de solicitação para receber um token:

{
  "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. Usando o token recebido no passo 2, abra a interface de pagamento em uma nova janela, em um Iframe ou usando Pay Station Embed.

Presentear um novo usuário

1. Implemente no seu aplicativo uma interface para compra de vale-assinatura com os seguintes elementos:
   • campos para inserir o endereço de e-mail do destinatário
   • campo para inserir um mensagem do remetente (opcional)
   • opção para selecionar envio anônimo (opcional)
   • elementos para selecionar um plano de assinatura (opcional)
2. Implemente a criação do novo usuário e atribua um ID a ele em seu sistema.
3. Crie um link para ativar a conta do usuário.

4. Implemente o recebimento de um token após o preenchimento dos dados do vale no ato de pagamento. Para fazer isso, passe o purchase.subscription.gift objeto com os parâmetros para a chamada de API Create token:
   • recipient — ID do destinatário da assinatura criado no passo 2.
   • email — endereço de e-mail do destinatário.
   • redirect_url — URL de ativação criado no passo 3.

• Além disso, você pode passar os seguintes parâmetros no purchase.subscription objeto:
  • gift.anonymous — se o presente foi enviado anonimamente. Se true, o nome do remetente está oculto na notificação por e-mail. O padrão é false.
  • gift.message — mensagem do remetente. Enviado em uma notificação por e-mail sobre o vale-assinatura.
  • plan_id — ID do plano de assinatura.

Exemplo de solicitação para receber um token:

{
  "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. Usando o token recebido no passo 4, abra a interface de pagamento em uma nova janela, em um Iframe ou usando Pay Station Embed.