TypeScript - Elapse

@elapse/sdk is a TypeScript client for Node 20 and newer. It is the whole surface: if a method is not here, it is not in the API for merchants. Every call maps to one operation in the API reference; a CI check keeps this page, the package, and the reference in step.

npm install @elapse/sdk

import { Elapse } from "@elapse/sdk";

const elapse = new Elapse({
  secretKey: process.env.ELAPSE_SECRET_KEY,
  baseUrl: process.env.ELAPSE_API_URL,
});

# Every call below: bearer secret key, JSON in, JSON out.
curl "$ELAPSE_API_URL/v1/…" -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

This package does not put React in your frontend. It runs on your server, where your secret key belongs. On the page, the subscriber signs in a window Elapse opens — with the React components, or with one script tag and no framework at all if your app is Vue, Rails, Django or plain HTML.

Parameters are camelCase in TypeScript and snake_case on the wire; the SDK maps them. Rates and amounts are decimal strings in both. Errors throw typed classes that all extend ElapseError: ElapseAuthenticationError, ElapseInvalidRequestError (a 404 is one of these with type: "not_found"), ElapseRateLimitError, ElapseAPIError, and ElapseSignatureVerificationError from constructEvent.

Products

`products.create`

const product = await elapse.products.create({
  name: "GPU · 4090",
  rateUsdPerSecond: "0.004",
  allowPause: false,
});

curl "$ELAPSE_API_URL/v1/products" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"GPU · 4090","rate_usd_per_second":"0.004","allow_pause":false}'

`products.retrieve`

const product = await elapse.products.retrieve("prod_…");

curl "$ELAPSE_API_URL/v1/products/prod_…" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

`products.list`

const { data, has_more } = await elapse.products.list({ limit: 20 });

curl "$ELAPSE_API_URL/v1/products?limit=20" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

Checkout

`checkout.sessions.create`

const session = await elapse.checkout.sessions.create({
  product: "prod_…",
  successUrl: "https://yourapp.example/ok",
  cancelUrl: "https://yourapp.example/cancel",
  maxDurationSeconds: 3600,
});
// send the subscriber to session.url

curl "$ELAPSE_API_URL/v1/checkout/sessions" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product":"prod_…","success_url":"https://yourapp.example/ok","cancel_url":"https://yourapp.example/cancel","max_duration_seconds":3600}'

Subscriptions

`subscriptions.retrieve`

const sub = await elapse.subscriptions.retrieve("sub_…");

curl "$ELAPSE_API_URL/v1/subscriptions/sub_…" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

`subscriptions.list`

const { data } = await elapse.subscriptions.list({ customer: "cus_…", status: "active" });

curl "$ELAPSE_API_URL/v1/subscriptions?customer=cus_…&status=active" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

`subscriptions.cancel`

await elapse.subscriptions.cancel("sub_…");
// 202: the chain confirms in about a second; subscription.canceled follows with the totals.

curl -X POST "$ELAPSE_API_URL/v1/subscriptions/sub_…/cancel" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

`subscriptions.start`

Starts the meter for a Subscription the subscriber has already authorised. Use it when billing should begin once your resource is ready rather than at checkout; active arrives by webhook once the chain confirms.

await elapse.subscriptions.start("sub_…");
// 202: the meter starts when the chain confirms; subscription.updated follows with status active.

curl -X POST "$ELAPSE_API_URL/v1/subscriptions/sub_…/start" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

`subscriptions.pause`

Pauses the meter without ending the subscription, for merchants that bill only while their resource is working. Paused seconds are never billed; paused arrives by webhook once the chain confirms.

await elapse.subscriptions.pause("sub_…");
// 202: subscription.updated follows with status paused.

curl -X POST "$ELAPSE_API_URL/v1/subscriptions/sub_…/pause" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

`subscriptions.resume`

Resumes a paused meter. Billing starts again when the chain confirms, and the paused time costs the subscriber nothing.

await elapse.subscriptions.resume("sub_…");
// 202: subscription.updated follows with status active.

curl -X POST "$ELAPSE_API_URL/v1/subscriptions/sub_…/resume" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

Customers

`customers.retrieve`

const customer = await elapse.customers.retrieve("cus_…");

curl "$ELAPSE_API_URL/v1/customers/cus_…" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

Invoices

`invoices.list`

const { data } = await elapse.invoices.list({ subscription: "sub_…" });

curl "$ELAPSE_API_URL/v1/invoices?subscription=sub_…" \
  -H "Authorization: Bearer $ELAPSE_SECRET_KEY"

Webhooks

`webhooks.constructEvent`

const event = elapse.webhooks.constructEvent(rawBody, signatureHeader, process.env.ELAPSE_WEBHOOK_SECRET);

# Not an HTTP call: recompute HMAC-SHA256(secret, "{t}.{raw_body}") and compare to v1. See Signatures.

Also exported as a standalone constructEvent for handlers that never construct a client.

Options

new Elapse({ secretKey, baseUrl, maxRetries, timeoutMs }). Retries apply to network errors, 429 and 5xx, with exponential backoff and Retry-After honoured; maxRetries defaults to 2 and timeoutMs to 30 seconds. Pass { idempotencyKey } as the second argument to any create call to make it safe to repeat.

​Products

​products.create

​products.retrieve

​products.list

​Checkout

​checkout.sessions.create

​Subscriptions

​subscriptions.retrieve

​subscriptions.list

​subscriptions.cancel

​subscriptions.start

​subscriptions.pause

​subscriptions.resume

​Customers

​customers.retrieve

​Invoices

​invoices.list

​Webhooks

​webhooks.constructEvent

​Options

Products

`products.create`

`products.retrieve`

`products.list`

Checkout

`checkout.sessions.create`

Subscriptions

`subscriptions.retrieve`

`subscriptions.list`

`subscriptions.cancel`

`subscriptions.start`

`subscriptions.pause`

`subscriptions.resume`

Customers

`customers.retrieve`

Invoices

`invoices.list`

Webhooks

`webhooks.constructEvent`

Options