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: "prod_987654321",
            },
        ],
        successUrl: "https://example.com/checkout/success",
    });
}
main();

{
  "id": "chk_123456789abcdef",
  "url": "https://checkout.agentpaid.io/checkout/chk_123456789abcdef",
  "status": "active",
  "products": [
    {
      "id": "prod_987654321"
    }
  ],
  "customerId": "cust_abc123xyz",
  "successUrl": "https://example.com/checkout/success",
  "cancelUrl": "https://example.com/checkout/cancel",
  "expiresAt": "2024-01-15T09:30:00Z",
  "metadata": {},
  "createdAt": "2024-01-10T12:00:00Z",
  "updatedAt": "2024-01-10T12:00:00Z"
}

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

cancelUrlstringOptionalformat: "uri"

expiresAtdatetimeOptional

metadatamap from strings to anyOptional

Response

201

idstring

urlstring

statusenum

Allowed values:

productslist of objects

customerIdstring or null

successUrlstring

cancelUrlstring or null

expiresAtdatetime or null

metadatamap from strings to any or null

createdAtdatetime

updatedAtdatetime

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error