velirapay 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this library are documented here. It follows [Semantic Versioning](https://semver.org).
 
+## 0.2.1 - 2026-11-12
+
+- `invoices.create()` takes `success_url` and `cancel_url`, public https:// addresses the invoice's page and its charges' checkout offer the customer a way back to: a button once they have paid, and a link while it is open. `invoice.successUrl` and `invoice.cancelUrl` read them back, and are `null` in webhooks, which leave them out.
+
 ## 0.2.0 - 2026-11-12
 
 ### Breaking

package/README.md

@@ -243,6 +243,7 @@ const invoice = await velirapay.invoices.create({
         { description: 'Hosting', quantity: '1', unit_amount: '250.00' },
     ],
     due_at: '2026-12-01', // a day, as YYYY-MM-DD
+    success_url: 'https://example.com/orders/1042',
     send_email: true,
 });
 
@@ -469,7 +470,7 @@ The charge and invoice in a delivery are not quite the ones the API answers with
 
 - A charge's coin amounts and exchange rate carry all 18 decimal places (`"0.002500000000000000"` rather than `"0.0025"`). Compare amounts as numbers, not as strings.
 - A charge has no `timeline`, `refunds`, `checkoutUrl`, `receiptUrl`, `successUrl`, `cancelUrl` or `successMessage`. It names its payment link with its title and its invoice with its number: `charge.paymentLink` and `charge.invoice` hold the codes, and `charge.paymentLinkTitle` and `charge.invoiceNumber` the rest, which are `null` on the API's charges.
-- An invoice has no `overdue` or `documentUrl`; both are `null`.
+- An invoice has no `overdue`, `documentUrl`, `successUrl` or `cancelUrl`; all four are `null`.
 - `charge.refunded` carries no refund. Read its amount, txid and reason from the event: `(await velirapay.events.retrieve(eventId)).details`.
 
 Fetch the object when you need what a delivery leaves out.

package/dist/cjs/client.d.ts

@@ -36,7 +36,7 @@ export interface ClientOptions {
 export declare class VeliraPayClient {
     #private;
     /** The version of this library. */
-    static readonly VERSION = "0.2.0";
+    static readonly VERSION = "0.2.1";
     /** The address of the VeliraPay API. */
     static readonly DEFAULT_BASE_URL = "https://api.velirapay.com";
     /** The account the API key belongs to. */

package/dist/cjs/params.d.ts

@@ -93,6 +93,10 @@ export interface InvoiceCreateParams {
     memo?: string | null;
     /** The day it is due, as YYYY-MM-DD. */
     due_at?: string | null;
+    /** A public https:// address the customer is offered a button back to once they have paid. */
+    success_url?: string | null;
+    /** A public https:// address the customer can go back to from the invoice without paying. */
+    cancel_url?: string | null;
     send_email?: boolean;
 }
 export interface InvoiceListParams extends PageParams {

package/dist/cjs/resources/invoice.d.ts

@@ -46,6 +46,10 @@ export declare class Invoice extends ApiResource {
     readonly voidedAt: Date | null;
     /** When it was created. */
     readonly createdAt: Date | null;
+    /** The page the customer is offered a button back to once they have paid; absent from webhooks. */
+    readonly successUrl: string | null;
+    /** The page the customer can go back to from the invoice without paying; absent from webhooks. */
+    readonly cancelUrl: string | null;
     constructor(attributes: Attributes);
     /** Whether the invoice can still be paid. */
     isOpen(): boolean;

package/dist/cjs/resources/invoice.js

@@ -43,6 +43,10 @@ class Invoice extends api_resource_ts_1.ApiResource {
     voidedAt;
     /** When it was created. */
     createdAt;
+    /** The page the customer is offered a button back to once they have paid; absent from webhooks. */
+    successUrl;
+    /** The page the customer can go back to from the invoice without paying; absent from webhooks. */
+    cancelUrl;
     constructor(attributes) {
         super(attributes);
         this.id = (0, api_resource_ts_1.string)(attributes, 'id', (0, api_resource_ts_1.string)(attributes, 'code'));
@@ -68,6 +72,8 @@ class Invoice extends api_resource_ts_1.ApiResource {
         this.paidAt = (0, api_resource_ts_1.date)(attributes, 'paid_at');
         this.voidedAt = (0, api_resource_ts_1.date)(attributes, 'voided_at');
         this.createdAt = (0, api_resource_ts_1.date)(attributes, 'created_at');
+        this.successUrl = (0, api_resource_ts_1.nullableString)(attributes, 'success_url');
+        this.cancelUrl = (0, api_resource_ts_1.nullableString)(attributes, 'cancel_url');
     }
     /** Whether the invoice can still be paid. */
     isOpen() {

package/dist/cjs/version.d.ts

@@ -1,2 +1,2 @@
 /** The version of this library. */
-export declare const VERSION = "0.2.0";
+export declare const VERSION = "0.2.1";

package/dist/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 /** The version of this library. */
-exports.VERSION = '0.2.0';
+exports.VERSION = '0.2.1';

package/dist/esm/client.d.ts

@@ -36,7 +36,7 @@ export interface ClientOptions {
 export declare class VeliraPayClient {
     #private;
     /** The version of this library. */
-    static readonly VERSION = "0.2.0";
+    static readonly VERSION = "0.2.1";
     /** The address of the VeliraPay API. */
     static readonly DEFAULT_BASE_URL = "https://api.velirapay.com";
     /** The account the API key belongs to. */

package/dist/esm/params.d.ts

@@ -93,6 +93,10 @@ export interface InvoiceCreateParams {
     memo?: string | null;
     /** The day it is due, as YYYY-MM-DD. */
     due_at?: string | null;
+    /** A public https:// address the customer is offered a button back to once they have paid. */
+    success_url?: string | null;
+    /** A public https:// address the customer can go back to from the invoice without paying. */
+    cancel_url?: string | null;
     send_email?: boolean;
 }
 export interface InvoiceListParams extends PageParams {

package/dist/esm/resources/invoice.d.ts

@@ -46,6 +46,10 @@ export declare class Invoice extends ApiResource {
     readonly voidedAt: Date | null;
     /** When it was created. */
     readonly createdAt: Date | null;
+    /** The page the customer is offered a button back to once they have paid; absent from webhooks. */
+    readonly successUrl: string | null;
+    /** The page the customer can go back to from the invoice without paying; absent from webhooks. */
+    readonly cancelUrl: string | null;
     constructor(attributes: Attributes);
     /** Whether the invoice can still be paid. */
     isOpen(): boolean;

package/dist/esm/resources/invoice.js

@@ -40,6 +40,10 @@ export class Invoice extends ApiResource {
     voidedAt;
     /** When it was created. */
     createdAt;
+    /** The page the customer is offered a button back to once they have paid; absent from webhooks. */
+    successUrl;
+    /** The page the customer can go back to from the invoice without paying; absent from webhooks. */
+    cancelUrl;
     constructor(attributes) {
         super(attributes);
         this.id = string(attributes, 'id', string(attributes, 'code'));
@@ -65,6 +69,8 @@ export class Invoice extends ApiResource {
         this.paidAt = date(attributes, 'paid_at');
         this.voidedAt = date(attributes, 'voided_at');
         this.createdAt = date(attributes, 'created_at');
+        this.successUrl = nullableString(attributes, 'success_url');
+        this.cancelUrl = nullableString(attributes, 'cancel_url');
     }
     /** Whether the invoice can still be paid. */
     isOpen() {

package/dist/esm/version.d.ts

@@ -1,2 +1,2 @@
 /** The version of this library. */
-export declare const VERSION = "0.2.0";
+export declare const VERSION = "0.2.1";

package/dist/esm/version.js

@@ -1,2 +1,2 @@
 /** The version of this library. */
-export const VERSION = '0.2.0';
+export const VERSION = '0.2.1';

package/package.json

@@ -1,7 +1,7 @@
 {
     "$schema": "https://www.schemastore.org/package.json",
     "name": "velirapay",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "description": "The official Node.js library for VeliraPay crypto payments: charges, payment links, invoices, payouts, events and webhook verification.",
     "keywords": [
         "velirapay",