Variable $CheckoutSessionRequestConst

$CheckoutSessionRequest: {
    additionalProperties: false;
    properties: {
        crypto: {
            default: false;
            description: "Instead of using a fiat PSP, use crypto for payments";
            type: "boolean";
        };
        email: {
            description: "Email address of the user making the purchase";
            format: "email";
            type: "string";
        };
        failUrl: {
            description: "URL where to redirect users to after a failed purchase";
            example: "https://cometh.io?fail=true";
            format: "uri";
            type: "string";
        };
        firstName: {
            description: "First name of the buyer";
            example: "John";
            type: "string";
        };
        lastName: {
            description: "Last name of the buyer";
            example: "Doe";
            type: "string";
        };
        metadata: {
            $ref: "#/components/schemas/CheckoutSessionMetadata";
            description: "Extra parameters given back as-is";
        };
        parameters: {
            $ref: "#/components/schemas/CheckoutSessionParameters";
            description: "Parameters required for the smart-contract call";
        };
        price: {
            description: "An optional price overriding the product one, only for this transaction, that can only be specified <strong>when using the secret key</strong>.<br /><br /> A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>\n <li>$12.34 would be <code>1234</code></li>\n <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>\n <li>ETH amounts (18 decimals) would be stored in wei</li>\n</ul>";
            example: "1234";
            pattern: "^[0-9]+$";
            type: "string";
        };
        productId: {
            description: "ID of a previously created product";
            example: 1;
            format: "int64";
            type: "integer";
        };
        successUrl: {
            description: "URL where to redirect users to after a successful purchase";
            example: "https://cometh.io?success=true";
            format: "uri";
            type: "string";
        };
        userAddress: {
            $ref: "#/components/schemas/UserAddress";
            description: "Wallet which would receive the purchased NFT";
        };
    };
    required: readonly ["productId", "userAddress"];
} = ...

Settings

Member Visibility