Send subscription link
Use a subscription link when you want the customer to activate a subscription without building a checkout flow on your website. Your back office creates the subscription, then asks MONEI to send the activation link by email or SMS. The customer opens the link, completes the initial payment on a MONEI-hosted page, and the subscription becomes active.
This is useful for manual or back-office subscription creation, where you do not need a full customer-facing integration but still want to trigger the activation link from your system.
Before you begin
- Create the subscription first using the create subscription endpoint.
- Make sure the subscription has the customer details you need for your flow.
- Decide how to deliver the link: use
customerEmailto send it by email, orcustomerPhoneto send it by SMS.
Send the activation link
The examples below send the activation link by email. To send the link by SMS, use customerPhone instead of customerEmail.
- cURL
- Node.js
- PHP
- Python
curl --request POST 'https://api.monei.com/v1/subscriptions/YOUR_SUBSCRIPTION_ID/link' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"customerEmail": "john.doe@example.com"
}'
const subscription = await monei.subscriptions.sendLink('YOUR_SUBSCRIPTION_ID', {
customerEmail: 'john.doe@example.com'
});
<?php
use Monei\Model\SendSubscriptionLinkRequest;
$subscription = $monei->subscriptions->sendLink(
'YOUR_SUBSCRIPTION_ID',
new SendSubscriptionLinkRequest([
'customer_email' => 'john.doe@example.com'
])
);
?>
from Monei import SendSubscriptionLinkRequest
subscription = monei.subscriptions.send_link(
"YOUR_SUBSCRIPTION_ID",
SendSubscriptionLinkRequest(
customer_email="john.doe@example.com"
)
)
After the customer opens the link and completes the initial payment, the subscription becomes active and recurring billing starts according to the subscription interval.