> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.trygrant.com/api-reference/grant-events-api/subscription-signup-links/create/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.trygrant.com/_mcp/server.

# Create a subscription signup link

POST https://api.trygrant.com/v1/subscription-signup-links
Content-Type: application/json

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.

Reference: https://docs.trygrant.com/api-reference/grant-events-api/subscription-signup-links/create

## Authentication

- `Authorization` header (bearer token, required) — API key obtained from the Grant dashboard

## Servers

- `https://api.trygrant.com` (Production, default)
- `http://localhost:8787` (Local development)

## Request

### Body (application/json)

This endpoint expects a CreateSubscriptionSignupLinkRequest.

- `customer_id` (string, required) — Customer ID
- `plan_code` (string, required) — Plan code
- `success_url` (string, optional) — URL to redirect to after successful signup
- `back_url` (string, optional) — URL to go back to when customer clicks Back
- `previous_subscription_id` (string, optional) — Existing subscription ID to change from. If omitted, link creates a new subscription.
- `change_timing_mode` (enum, optional) — Required when previous_subscription_id is provided. Use "now" or "end_of_period".
  - Allowed values: `now`, `end_of_period`
- `cancel_now_prepaid_refund_policy` (enum, optional) — Only allowed when change_timing_mode is "now". Controls prepaid fixed-fee refunds.
  - Allowed values: `no_refund_prepaid_fixed_fees`, `refund_prorated_prepaid_fixed_fees`

## Response

### 201

Signup link created

- `success` (boolean, required)
- `subscription_signup_link` (SubscriptionSignupLink, required)
- `request_id` (string, required)

## Errors

### 400 Bad Request Error

Invalid request

- `success` (boolean, required)
- `error` (ErrorResponseError, required)
- `request_id` (string, optional) — Request ID for tracing

### 401 Unauthorized Error

Unauthorized

- `success` (boolean, required)
- `error` (ErrorResponseError, required)
- `request_id` (string, optional) — Request ID for tracing

### 404 Not Found Error

Subscription Signup Link not found

- `success` (boolean, required)
- `error` (ErrorResponseError, required)
- `request_id` (string, optional) — Request ID for tracing

### 500 Internal Server Error

Internal server error

- `success` (boolean, required)
- `error` (ErrorResponseError, required)
- `request_id` (string, optional) — Request ID for tracing

## Types

### SubscriptionSignupLink

- `id` (string, required)
- `customer_id` (string, required)
- `plan_id` (string, required)
- `plan_code` (string, required, nullable) — Human-readable plan code
- `url` (string, required) — Full subscribe page URL for the customer. Share this link with the customer to allow them to sign up for the plan.
- `token_expiration` (string, required) — ISO 8601 expiration timestamp for the token
- `success_url` (string, required, nullable) — URL to redirect to after successful signup
- `back_url` (string, required, nullable) — URL to go back to when customer clicks Back
- `previous_subscription_id` (string, required, nullable) — Existing subscription to change from. When provided, the checkout flow updates this subscription to the target plan instead of creating a net-new subscription.
- `change_timing_mode` (string, required, nullable) — Plan-change timing mode. "now" changes immediately. "end_of_period" schedules a transition at period end.
- `cancel_now_prepaid_refund_policy` (string, required, nullable) — When `change_timing_mode` is "now", controls how prepaid fixed fees are handled.
- `created_at` (string, required) — ISO 8601 creation timestamp

### ErrorResponseError

- `code` (string, required)
- `message` (string, required)
- `details` (any, optional)

## Examples

**Request**

```json
{
  "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
  "plan_code": "starter_plan"
}
```

**Response**

```json
{
  "success": true,
  "subscription_signup_link": {
    "id": "cm5x9z8nv0000h85r7l9p2k1m",
    "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
    "plan_id": "cm5x9z8nv0002h85r7l9p2k3m",
    "plan_code": "starter_plan",
    "url": "https://www.trygrant.com/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"
}
```

**SDK Code**

```python
import requests

url = "https://api.trygrant.com/v1/subscription-signup-links"

payload = {
    "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
    "plan_code": "starter_plan"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.trygrant.com/v1/subscription-signup-links';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"customer_id":"cm5x9z8nv0001h85r7l9p2k2m","plan_code":"starter_plan"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trygrant.com/v1/subscription-signup-links"

	payload := strings.NewReader("{\n  \"customer_id\": \"cm5x9z8nv0001h85r7l9p2k2m\",\n  \"plan_code\": \"starter_plan\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.trygrant.com/v1/subscription-signup-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"cm5x9z8nv0001h85r7l9p2k2m\",\n  \"plan_code\": \"starter_plan\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.trygrant.com/v1/subscription-signup-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"cm5x9z8nv0001h85r7l9p2k2m\",\n  \"plan_code\": \"starter_plan\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.trygrant.com/v1/subscription-signup-links', [
  'body' => '{
  "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
  "plan_code": "starter_plan"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.trygrant.com/v1/subscription-signup-links");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"customer_id\": \"cm5x9z8nv0001h85r7l9p2k2m\",\n  \"plan_code\": \"starter_plan\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
  "plan_code": "starter_plan"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.trygrant.com/v1/subscription-signup-links")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> API documentation for Grant — billing infrastructure for usage-based pricing