Checkout Intents TypeScript API Library

This library provides convenient access to the Checkout Intents REST API from server-side TypeScript or JavaScript.

The REST API documentation can be found on docs.rye.com. The full API of this library can be found in api.md.

It is generated with Stainless.

Installation

npm install checkout-intents

Usage

The full API of this library can be found in api.md.

import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted
});

const checkoutIntent = await client.checkoutIntents.create({
  buyer: {
    address1: '123 Main St',
    city: 'New York',
    country: 'US',
    email: '[email protected]',
    firstName: 'John',
    lastName: 'Doe',
    phone: '1234567890',
    postalCode: '10001',
    province: 'NY',
  },
  productUrl: 'https://rye-protocol.myshopify.com/products/rye-sticker',
  quantity: 1,
});

Polling Helpers

This SDK includes helper methods for the asynchronous checkout flow. The recommended pattern follows Rye's two-phase checkout:

// Phase 1: Create and wait for offer
const intent = await client.checkoutIntents.createAndPoll({
  buyer: {
    address1: '123 Main St',
    city: 'New York',
    country: 'US',
    email: '[email protected]',
    firstName: 'John',
    lastName: 'Doe',
    phone: '1234567890',
    postalCode: '10001',
    province: 'NY',
  },
  productUrl: 'https://example.com/product',
  quantity: 1,
});

// Handle failure during offer retrieval
if (intent.state === 'failed') {
  console.log('Failed:', intent.failureReason);
  return;
}

// Review pricing with user
console.log('Total:', intent.offer.cost.total);

// Phase 2: Confirm and wait for completion
const completed = await client.checkoutIntents.confirmAndPoll(intent.id, {
  paymentMethod: {
    type: 'stripe_token',
    stripeToken: 'tok_visa',
  },
});

console.log('Status:', completed.state);

Polling Helpers

This SDK includes helper methods for the asynchronous checkout flow. The recommended pattern follows Rye's two-phase checkout:

// Phase 1: Create and wait for offer
const intent = await client.checkoutIntents.createAndPoll({
  buyer: {
    address1: '123 Main St',
    city: 'New York',
    country: 'US',
    email: '[email protected]',
    firstName: 'John',
    lastName: 'Doe',
    phone: '1234567890',
    postalCode: '10001',
    province: 'NY',
  },
  productUrl: 'https://example.com/product',
  quantity: 1,
});

// Handle failure during offer retrieval
if (intent.state === 'failed') {
  console.log('Failed:', intent.failureReason);
  return;
}

// Review pricing with user
console.log('Total:', intent.offer.cost.total);

// Phase 2: Confirm and wait for completion
const completed = await client.checkoutIntents.confirmAndPoll(intent.id, {
  paymentMethod: {
    type: 'stripe_token',
    stripeToken: 'tok_visa',
  },
});

console.log('Status:', completed.state);

For more examples, see the examples/ directory:

• complete-checkout-intent.ts - Recommended two-phase flow
• error-handling.ts - Timeout and error handling with PollTimeoutError

Available polling methods:

• createAndPoll() - Create and poll until offer is ready (awaiting_confirmation or failed)
• confirmAndPoll() - Confirm and poll until completion (completed or failed)
• pollUntilCompleted() - Poll until completed or failed
• pollUntilAwaitingConfirmation() - Poll until offer is ready or failed

All polling methods support customizable timeouts:

// Configure polling behavior
const intent = await client.checkoutIntents.pollUntilCompleted(intentId, {
  pollIntervalMs: 5000, // Poll every 5 seconds (default)
  maxAttempts: 120, // Try up to 120 times, ~10 minutes (default)
});

Handling Polling Timeouts

When polling operations exceed maxAttempts, a PollTimeoutError is raised with helpful context:

import CheckoutIntents, { PollTimeoutError } from 'checkout-intents';

const client = new CheckoutIntents();

try {
  const intent = await client.checkoutIntents.pollUntilCompleted(intentId, {
    pollIntervalMs: 5000,
    maxAttempts: 60,
  });
} catch (error) {
  if (error instanceof PollTimeoutError) {
    console.log(`Polling timed out for intent: ${error.intentId}`);
    console.log(`Attempted ${error.attempts} times over ${(error.attempts * error.pollIntervalMs) / 1000}s`);
    
    // You can retrieve the current state manually
    const currentIntent = await client.checkoutIntents.retrieve(error.intentId);
    console.log(`Current state: ${currentIntent.state}`);
  }
}

Request & Response types

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted
});

const params: CheckoutIntents.CheckoutIntentCreateParams = {
  buyer: {
    address1: '123 Main St',
    city: 'New York',
    country: 'US',
    email: '[email protected]',
    firstName: 'John',
    lastName: 'Doe',
    phone: '1234567890',
    postalCode: '10001',
    province: 'NY',
  },
  productUrl: 'https://rye-protocol.myshopify.com/products/rye-sticker',
  quantity: 1,
};
const checkoutIntent: CheckoutIntents.CheckoutIntent = await client.checkoutIntents.create(params);

Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.

Handling errors

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of APIError will be thrown:

const checkoutIntent = await client.checkoutIntents
  .create({
    buyer: {
      address1: '123 Main St',
      city: 'New York',
      country: 'US',
      email: '[email protected]',
      firstName: 'John',
      lastName: 'Doe',
      phone: '1234567890',
      postalCode: '10001',
      province: 'NY',
    },
    productUrl: 'https://rye-protocol.myshopify.com/products/rye-sticker',
    quantity: 1,
  })
  .catch(async (err) => {
    if (err instanceof CheckoutIntents.APIError) {
      console.log(err.status); // 400
      console.log(err.name); // BadRequestError
      console.log(err.headers); // {server: 'nginx', ...}
    } else {
      throw err;
    }
  });

Error codes are as follows:

| Status Code | Error Type | | ----------- | -------------------------- | | 400 | BadRequestError | | 401 | AuthenticationError | | 403 | PermissionDeniedError | | 404 | NotFoundError | | 422 | UnprocessableEntityError | | 429 | RateLimitError | | >=500 | InternalServerError | | N/A | APIConnectionError | | N/A | PollTimeoutError |

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default.

You can use the maxRetries option to configure or disable this:

// Configure the default for all requests:
const client = new CheckoutIntents({
  maxRetries: 0, // default is 2
});

// Or, configure per-request:
await client.checkoutIntents.create({ buyer: { address1: '123 Main St', city: 'New York', country: 'US', email: '[email protected]', firstName: 'John', lastName: 'Doe', phone: '1234567890', postalCode: '10001', province: 'NY' }, productUrl: 'https://rye-protocol.myshopify.com/products/rye-sticker', quantity: 1 }, {
  maxRetries: 5,
});

Timeouts

Requests time out after 1 minute by default. You can configure this with a timeout option:

// Configure the default for all requests:
const client = new CheckoutIntents({
  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});

// Override per-request:
await client.checkoutIntents.create({ buyer: { address1: '123 Main St', city: 'New York', country: 'US', email: '[email protected]', firstName: 'John', lastName: 'Doe', phone: '1234567890', postalCode: '10001', province: 'NY' }, productUrl: 'https://rye-protocol.myshopify.com/products/rye-sticker', quantity: 1 }, {
  timeout: 5 * 1000,
});

On timeout, an APIConnectionTimeoutError is thrown.

Note that requests which time out will be retried twice by default.

Auto-pagination

List methods in the CheckoutIntents API are paginated. You can use the for await … of syntax to iterate through items across all pages:

async function fetchAllCheckoutIntents(params) {
  const allCheckoutIntents = [];
  // Automatically fetches more pages as needed.
  for await (const checkoutIntent of client.checkoutIntents.list({ limit: 20 })) {
    allCheckoutIntents.push(checkoutIntent);
  }
  return allCheckoutIntents;
}

Alternatively, you can request a single page at a time:

let page = await client.checkoutIntents.list({ limit: 20 });
for (const checkoutIntent of page.data) {
  console.log(checkoutIntent);
}

// Convenience methods are provided for manually paginating:
while (page.hasNextPage()) {
  page = await page.getNextPage();
  // ...
}

Advanced Usage

Accessing raw Response data (e.g., headers)

The "raw" Response returned by fetch() can be accessed through the .asResponse() method on the APIPromise type that all methods return. This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.

You can also use the .withResponse() method to get the raw Response along with the parsed data. Unlike .asResponse() this method consumes the body, returning once it is parsed.

const client = new CheckoutIntents();

const response = await client.checkoutIntents
  .create({
    buyer: {
      address1: '123 Main St',
      city: 'New York',
      country: 'US',
      email: '[email protected]',
      firstName: 'John',
      lastName: 'Doe',
      phone: '1234567890',
      postalCode: '10001',
      province: 'NY',
    },
    productUrl: 'https://rye-protocol.myshopify.com/products/rye-sticker',
    quantity: 1,
  })
  .asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object

const { data: checkoutIntent, response: raw } = await client.checkoutIntents
  .create({
    buyer: {
      address1: '123 Main St',
      city: 'New York',
      country: 'US',
      email: '[email protected]',
      firstName: 'John',
      lastName: 'Doe',
      phone: '1234567890',
      postalCode: '10001',
      province: 'NY',
    },
    productUrl: 'https://rye-protocol.myshopify.com/products/rye-sticker',
    quantity: 1,
  })
  .withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(checkoutIntent);

Logging

[!IMPORTANT] All log messages are intended for debugging only. The format and content of log messages may change between releases.

Log levels

The log level can be configured in two ways:

1. Via the CHECKOUT_INTENTS_LOG environment variable
2. Using the logLevel client option (overrides the environment variable if set)

import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  logLevel: 'debug', // Show all log messages
});

Available log levels, from most to least verbose:

• 'debug' - Show debug messages, info, warnings, and errors
• 'info' - Show info messages, warnings, and errors
• 'warn' - Show warnings and errors (default)
• 'error' - Show only errors
• 'off' - Disable all logging

At the 'debug' level, all HTTP requests and responses are logged, including headers and bodies. Some authentication-related headers are redacted, but sensitive data in request and response bodies may still be visible.

Custom logger

By default, this library logs to globalThis.console. You can also provide a custom logger. Most logging libraries are supported, including pino, winston, bunyan, consola, signale, and @std/log. If your logger doesn't work, please open an issue.

When providing a custom logger, the logLevel option still controls which messages are emitted, messages below the configured level will not be sent to your logger.

import CheckoutIntents from 'checkout-intents';
import pino from 'pino';

const logger = pino();

const client = new CheckoutIntents({
  logger: logger.child({ name: 'CheckoutIntents' }),
  logLevel: 'debug', // Send all messages to pino, allowing it to filter
});

Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.get, client.post, and other HTTP verbs. Options on the client, such as retries, will be respected when making these requests.

await client.post('/some/path', {
  body: { some_prop: 'foo' },
  query: { some_query_arg: 'bar' },
});

Undocumented request params

To make requests using undocumented parameters, you may use // @ts-expect-error on the undocumented parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you send will be sent as-is.

client.checkoutIntents.create({
  // ...
  // @ts-expect-error baz is not yet public
  baz: 'undocumented option',
});

For requests with the GET verb, any extra params will be in the query, all other requests will send the extra param in the body.

If you want to explicitly send an extra argument, you can do so with the query, body, and headers request options.

Undocumented response properties

To access undocumented response properties, you may access the response object with // @ts-expect-error on the response object, or cast the response object to the requisite type. Like the request params, we do not validate or strip extra properties from the response from the API.

Customizing the fetch client

By default, this library expects a global fetch function is defined.

If you want to use a different fetch function, you can either polyfill the global:

import fetch from 'my-fetch';

globalThis.fetch = fetch;

Or pass it to the client:

import CheckoutIntents from 'checkout-intents';
import fetch from 'my-fetch';

const client = new CheckoutIntents({ fetch });

Fetch options

If you want to set custom fetch options without overriding the fetch function, you can provide a fetchOptions object when instantiating the client or making a request. (Request-specific options override client options.)

import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  fetchOptions: {
    // `RequestInit` options
  },
});

Configuring proxies

To modify proxy behavior, you can provide custom fetchOptions that add runtime-specific proxy options to requests:

Node [docs]

import CheckoutIntents from 'checkout-intents';
import * as undici from 'undici';

const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
const client = new CheckoutIntents({
  fetchOptions: {
    dispatcher: proxyAgent,
  },
});

Bun [docs]

import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  fetchOptions: {
    proxy: 'http://localhost:8888',
  },
});

Deno [docs]

import CheckoutIntents from 'npm:checkout-intents';

const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
const client = new CheckoutIntents({
  fetchOptions: {
    client: httpClient,
  },
});

Frequently Asked Questions

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
3. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Requirements

TypeScript >= 4.9 is supported.

The following runtimes are supported:

• Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
• Node.js 20 LTS or later (non-EOL) versions.
• Deno v1.28.0 or higher.
• Bun 1.0 or later.
• Cloudflare Workers.
• Vercel Edge Runtime.
• Jest 28 or greater with the "node" environment ("jsdom" is not supported at this time).
• Nitro v2.6 or greater.

Note that React Native is not supported at this time.

If you are interested in other runtime environments, please open or upvote an issue on GitHub.

Contributing

See the contributing documentation.