---
title: "Create Variant Pay Link URL"
method: GET
path: "/v1/paylinks/generate-variant/{paylinkId}"
tags: ["Paylinks"]
---

# Create Variant Pay Link URL

`GET /v1/paylinks/generate-variant/{paylinkId}`

The **Create Variant Pay Link URL** endpoint enables you to create a customized version of an existing payment link, allowing you to modify key elements such as the amount and currency. This functionality is ideal for scenarios where you need to offer personalized payment options, such as discounts, special pricing, or promotions, while maintaining the original plan’s integrity.

> 📘 Note
> 
> You can use this endpoint to offer discounts or custom pricing by creating a variant of an existing paylink.

## Path parameters

- `paylinkId` string, required

## Query parameters

- `amount` string
- `currency` string
- `customer_ident` string
- `redirect_to` string

## Response `200`

OK

- PaylinksGenerateVariantURLResponse
  - `url` string — The URL of the paylink variant
  - `created_by` string — The ID of the user who created the paylink variant
  - `payment_link` PaylinksPaymentLinkResponse
    - `id` string — The unique identifier for the paylink
    - `plan_id` string — The ID of the associated plan
    - `invoice_id` string — The ID of the associated invoice
    - `source` string — The source of the paylink
    - `customer_ident_collection` boolean — Indicates if customer identification collection is enabled
    - `shipping_address_collection` boolean — Indicates if shipping address collection is enabled
    - `tax_ident_collection` boolean — Indicates if tax identification collection is enabled
    - `enabled` boolean — Indicates if the paylink is enabled
    - `deleted_at` string, date-time — The timestamp when the paylink was deleted
    - `created_by` string — The ID of the user who created the paylink
    - `updated_by` string — The ID of the user who last updated the paylink
    - `created_at` string, date-time — The timestamp when the paylink was created
    - `updated_at` string, date-time — The timestamp when the paylink was last updated
    - `available_quantity` number — The remaining number of times this payment link can be used. `null` indicates unlimited usage. - Decremented on each successful or failed payment. - Restored when a payment is canceled. - When the value reaches zero, the payment link becomes invalid.
    - `expires_at` string, date-time — The expiration date and time of the payment link. Any checkout attempt after this timestamp will fail.
    - `metadata` object — Additional metadata associated with the paylink
    - `properties` object — Additional properties associated with the paylink
      - `short_code` string — The short code associated with the paylink
    - `plan` object — The details of the associated plan
      - `id` string — The unique identifier for the plan
      - `org_id` string — The organization ID associated with the plan
      - `source` string — The source of the plan
      - `name` string — The name of the plan
      - `type` string — The type of the plan
      - `billing_scheme` string — The billing scheme of the plan
      - `price` string — The price of the plan
      - `currency` string — The currency of the plan
      - `available_quantity` integer — The available quantity of the plan
      - `trial_period` string — The trial period of the plan
      - `recurring_interval` string — The recurring interval of the plan
      - `recurring_interval_count` integer — The recurring interval count of the plan
      - `recurring_usage_type` string — The recurring usage type of the plan
      - `reference` string — The reference of the plan
      - `enabled` boolean — Indicates if the plan is enabled
      - `v1` string — Additional information about the plan
      - `created_by` string — The ID of the user who created the plan
      - `created_at` string, date-time — The timestamp when the plan was created
      - `updated_at` string, date-time — The timestamp when the plan was last updated
      - `deleted_at` string, date-time — The timestamp when the plan was deleted
      - `metadata` object — Additional metadata associated with the plan
  - `plan` PlanPlanResponse
    - `id` string — The unique identifier of the plan.
    - `org_id` string — The identifier of the organization associated with the plan.
    - `source` 1 | 2 | 3 | 4 — The source of this billing information. Can be one of the following: - 1 = Lago - 2 = Boomfi - 3 = Stripe - 4 = Chargebee
    - `name` '1' | '2' | '3' — The type of the plan: - **1** = Unknown - **2** = Onetime - **3** = Recurring
    - `type` string — The type of the plan.
    - `billing_scheme` 1 | 2 | 3 | 4 — The billing scheme determines how the charges are calculated for the subscription. - 1 = Flatfee - 2 = Perunit - 3 = Graduated - 4 = Volume
    - `price` string — The price of the plan.
    - `currency` string — The currency of the plan.
    - `available_quantity` integer — The available quantity of the plan.
    - `trial_period` string — The trial period of the plan.
    - `recurring_interval` 'Week' | 'Month' | 'Year' — The recurring interval for the payment link: - **Week** - **Month** - **Year**
    - `recurring_interval_count` integer — The count of recurring intervals for the plan.
    - `recurring_usage_type` 1 | 2 | 3
    - `reference` string — The reference of the plan.
    - `enabled` boolean — Indicates whether the plan is enabled or not.
    - `v1` string — Additional information about the plan.
    - `created_by` string — The identifier of the user who created the plan.
    - `created_at` string, date-time — The timestamp when the plan was created.
    - `updated_at` string, date-time — The timestamp when the plan was last updated.
    - `deleted_at` string, date-time — The timestamp when the plan was deleted, if applicable.
    - `metadata` object — Additional metadata associated with the plan.
    - `properties` object — Additional properties of the plan.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/boomfi/apis/boomfi-merchants-api.md) · [All operations](https://skmtc.net/boomfi/apis/boomfi-merchants-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/boomfi/boomfi-merchants-api/versions/ace3c3df05fe/schema)