Create a checkout | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.checkouts.createCheckout({
        products: [
            {
                id: "string",
            },
        ],
        successUrl: "string",
    });
}
main();

{
  "id": "string",
  "url": "string",
  "status": "active",
  "products": [
    {
      "id": "string",
      "plans": [
        {
          "id": "string",
          "features": [
            "string"
          ]
        }
      ]
    }
  ],
  "customerId": "string",
  "externalCustomerId": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "expiresAt": "2024-01-15T09:30:00Z",
  "metadata": {},
  "collectAddress": true,
  "collectPhone": true,
  "singleUse": true,
  "allowedCurrencies": [
    "string"
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "customCards": [
    {
      "label": "string",
      "priceText": "string",
      "buttonText": "string",
      "buttonUrl": "string"
    }
  ]
}

Creates a checkout link that generates a URL for a customer to complete a purchase

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

productslist of objectsRequired

successUrlstringRequiredformat: "uri"

customerIdstringOptional

externalCustomerIdstringOptional>=1 character

External customer identifier. Creates the customer on first use, resolves to the existing customer on subsequent uses.

cancelUrlstringOptionalformat: "uri"

expiresAtdatetimeOptional

metadatamap from strings to anyOptional

collectAddressbooleanOptionalDefaults to true

collectPhonebooleanOptionalDefaults to false

singleUsebooleanOptionalDefaults to true

currencystringOptional=3 characters

Lock checkout to a specific currency. Omit to allow all currencies supported by the selected plans. If the checkout is for a customer with an active subscription, the currency must match that subscription’s currency — subscriptions cannot change currency.

customCardslist of objectsOptional

Additional informational pricing cards rendered alongside the plans.

Response

201

idstring

urlstring

statusenum

productslist of objects

customerIdstring or null

externalCustomerIdstring or null

successUrlstring

cancelUrlstring or null

expiresAtdatetime or null

metadatamap from strings to any or null

collectAddressboolean

collectPhoneboolean

singleUseboolean

allowedCurrencieslist of strings

createdAtdatetime

updatedAtdatetime

customCardslist of objectsOptional

Additional informational pricing cards rendered alongside the plans.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error