Create a subscription signup link | Afternoon

import { AfternoonClient } from "afternoon-sdk";
async function main() {
    const client = new AfternoonClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.subscriptionSignupLinks.create({
        customerId: "cm5x9z8nv0001h85r7l9p2k2m",
        planCode: "starter_plan",
    });
}
main();

{
  "success": true,
  "subscription_signup_link": {
    "id": "cm5x9z8nv0000h85r7l9p2k1m",
    "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
    "plan_id": "cm5x9z8nv0002h85r7l9p2k3m",
    "plan_code": "starter_plan",
    "url": "https://app.afternoon.co/subscribe/dGhpcyBpcyBhIHRva2VuIGV4YW1wbGU",
    "token_expiration": "2024-01-16T00:00:00.000Z",
    "success_url": "https://example.com/welcome",
    "back_url": "https://example.com/pricing",
    "previous_subscription_id": "cm5x9z8nv0009h85r7l9p2k9m",
    "change_timing_mode": "now",
    "cancel_now_prepaid_refund_policy": "no_refund_prepaid_fixed_fees",
    "created_at": "2024-01-15T10:30:00.000Z"
  },
  "request_id": "req_abc123"
}

Generates a tokenised signup link that allows a specific customer to subscribe to a plan. Use plan_code to identify the plan. The returned token can be appended to your subscribe page URL (e.g. /subscribe/{token}). The token expires after 24 hours.

Request

This endpoint expects an object.

Authentication

Request

Response

Errors