Skip to content

Stripe.Files reference

Section titled “CreateFileLink”

Source: src/Stripe/CreateFileLink.ts

Create a Stripe File Link over HTTP. Account-scoped — binds the API key onto the host, not a specific file link resource.

Section titled “CreateFileLink: Creating a File Link at runtime”
const create = yield* Stripe.CreateFileLink();
const link = yield* create({
  file: "file_123",
});

CreateFileLinkHttp

Section titled “CreateFileLinkHttp”

Source: src/Stripe/CreateFileLinkHttp.ts Kind: Layer · Provides: Stripe.CreateFileLink

HTTP implementation of CreateFileLink. Provide it on the Function or Worker Effect.

Section titled “FileLink”

Source: src/Stripe/FileLink.ts

A Stripe File Link — a public URL for a File that does not require Stripe authentication. file is create-only; changing it replaces the link. expiresAt and metadata update in place. Expired links cannot be updated. Destroy expires the link (expires_at: "now") rather than deleting it — Stripe has no file-link delete API.

Section titled “FileLink: Creating a File Link”

Link a file

const link = yield* Stripe.FileLink("report", {
  file: "file_123",
});

Expiring link with metadata

const link = yield* Stripe.FileLink("report", {
  file: "file_123",
  expiresAt: 1900000000,
  metadata: { kind: "report" },
});
Section titled “FileLink: Updating a File Link”
const link = yield* Stripe.FileLink("report", {
  file: "file_123",
  expiresAt: 1920000000,
  metadata: { kind: "report", env: "prod" },
});
Section titled “FileLink: Expiring a File Link”
const link = yield* Stripe.FileLink("report", {
  file: "file_123",
});
// stack.destroy() sets expires_at to now
Section titled “RetrieveFileLink”

Source: src/Stripe/RetrieveFileLink.ts

Retrieve a bound Stripe File Link over HTTP.

Section titled “RetrieveFileLink: Reading a File Link”
const retrieve = yield* Stripe.RetrieveFileLink(link);
const live = yield* retrieve();

RetrieveFileLinkHttp

Section titled “RetrieveFileLinkHttp”

Source: src/Stripe/RetrieveFileLinkHttp.ts Kind: Layer · Provides: Stripe.RetrieveFileLink

HTTP implementation of RetrieveFileLink. Provide it on the Function or Worker Effect.

Section titled “UpdateFileLink”

Source: src/Stripe/UpdateFileLink.ts

Update a bound Stripe File Link over HTTP. Expired links cannot be updated.

Section titled “UpdateFileLink: Updating a File Link”
const update = yield* Stripe.UpdateFileLink(link);
const live = yield* update({ expires_at: "now" });

UpdateFileLinkHttp

Section titled “UpdateFileLinkHttp”

Source: src/Stripe/UpdateFileLinkHttp.ts Kind: Layer · Provides: Stripe.UpdateFileLink

HTTP implementation of UpdateFileLink. Provide it on the Function or Worker Effect.