Skip to main content
POST
/
checkout_links
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.checkoutLinks.create({});

  console.log(result);
}

run();
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "success_url": "<string>",
  "allow_discount_codes": true,
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "discount": "<string>",
  "price_variants": [
    {
      "id": "<string>",
      "object": "<string>",
      "name": "<string>",
      "amount": 123,
      "amount_type": "free",
      "billing_type": "subscription",
      "recurring_interval": "day",
      "interval_count": 123,
      "installment_count": 123,
      "setup_fee_amount": 123,
      "trial_period_days": 123,
      "revoke_after_days": 123,
      "quantity_available": 123,
      "archived": true,
      "position": 123,
      "hidden": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "discounted_from_amount": 123,
      "minimum_amount": 123,
      "maximum_amount": 123,
      "preset_amount": 123,
      "waitlist": true,
      "purchase_url": "<string>",
      "product": "<string>",
      "benefits": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
name
string | null
discount
string | null

Discount ID

allow_discount_codes
boolean
success_url
string | null
metadata
object
price_variants
string[]

Response

Checkout link created

id
string
required
object
string
required
name
string | null
required
success_url
string | null
required
allow_discount_codes
boolean
required
metadata
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
url
string
required
discount

ID by default, full object when expanded

price_variants
object[]