Create a Purchase Link

POST

/v1/subscriptions/purchase-links

Create a link to the account's purchase page in the Leadfeeder app, with the product, tier, billing option and payment method the user chose preselected. The purchase itself is made in the app, not through the API, by a user who can manage billing on the account. Every preselection is optional, and a request without a body creates a plain link.

Take every value to preselect from the account's GET /v1/subscriptions/purchase-options response, which lists what the account can buy.

Credit Note: Creating a purchase link does not consume credits.

INFO

Requires the accounts:read OAuth2 scope.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Body Params application/json

Example

{
    "data": {
        "attributes": {
            "billing_interval_months": 12,
            "initial_contract_term_months": 12,
            "payment_method": "invoiced",
            "product_feature": "leadfeeder_activate",
            "tier_id": "1000_1000"
        },
        "type": "purchase_link"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.leadfeeder.com/v1/subscriptions/purchase-links?account_id=123456' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "data": {
        "attributes": {
            "billing_interval_months": 12,
            "initial_contract_term_months": 12,
            "payment_method": "invoiced",
            "product_feature": "leadfeeder_activate",
            "tier_id": "1000_1000"
        },
        "type": "purchase_link"
    }
}'

Responses

🟢201Created

application/json

Created

Bodyapplication/json

Examples

A plain link, with the defaults filled inA product, tier, billing option and payment method preselected

{
    "data": {
        "attributes": {
            "billing_interval_months": 12,
            "expires_at": "2026-11-03T10:15:00Z",
            "initial_contract_term_months": 12,
            "payment_method": "credit_card",
            "product_feature": null,
            "tier_id": null,
            "url": "https://app.leadfeeder.com/f/settings/purchase/123456?purchaseLink=pl_Hq7nC4wY1sK6dPeR"
        },
        "id": "pl_Hq7nC4wY1sK6dPeR",
        "type": "purchase_link"
    },
    "meta": {
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error

🟠429

🔴500Server Error

🔴504Gateway Timeout

Modified at 2026-11-05 14:40:01

Get Enrich CRM Record Job

Get Purchase Options