@vertracloud/api-types 0.2.4 → 0.3.0

package/payloads/v1/index.mjs

@@ -382,9 +382,32 @@ var API_ERROR_CODES = {
   APP_NOT_FOUND_IN_WORKSPACE: "APP_NOT_FOUND_IN_WORKSPACE",
   BUILD_FAILED: "BUILD_FAILED",
   BUILD_TIMEOUT: "BUILD_TIMEOUT",
+  /** 400 — billing details failed validation; the field is in `details.path`. */
+  BILLING_DETAILS_INVALID: "BILLING_DETAILS_INVALID",
+  /** 402 — the bank refused the card charge. */
+  CARD_DECLINED: "CARD_DECLINED",
+  /** 400 — the plan can only be paid by PIX. */
+  CARD_NOT_ALLOWED_FOR_PLAN: "CARD_NOT_ALLOWED_FOR_PLAN",
+  CARD_NOT_FOUND: "CARD_NOT_FOUND",
   CERTIFICATE_NOT_FOUND: "CERTIFICATE_NOT_FOUND",
   CLEANUP_LANGUAGE_SAME_AS_CURRENT: "CLEANUP_LANGUAGE_SAME_AS_CURRENT",
   CONTAINER_ALREADY_RUNNING: "CONTAINER_ALREADY_RUNNING",
+  /** 400 — no active coupon with this code. */
+  COUPON_INVALID: "COUPON_INVALID",
+  COUPON_INACTIVE: "COUPON_INACTIVE",
+  COUPON_NOT_STARTED: "COUPON_NOT_STARTED",
+  COUPON_EXPIRED: "COUPON_EXPIRED",
+  /** 400 — the coupon reached its total number of uses. */
+  COUPON_EXHAUSTED: "COUPON_EXHAUSTED",
+  /** 400 — the account already used this coupon as many times as allowed. */
+  COUPON_USER_LIMIT: "COUPON_USER_LIMIT",
+  /** 400 — the coupon is not available to this account. */
+  COUPON_AUDIENCE: "COUPON_AUDIENCE",
+  /** 400 — the coupon does not apply to this plan. */
+  COUPON_PLAN: "COUPON_PLAN",
+  /** 400 — the coupon does not apply to this billing period. */
+  COUPON_DURATION: "COUPON_DURATION",
+  COUPON_PAYMENT_METHOD: "COUPON_PAYMENT_METHOD",
   CUSTOM_DOMAIN_RECORD_NOT_FOUND: "CUSTOM_DOMAIN_RECORD_NOT_FOUND",
   CUSTOM_DOMAIN_REGISTRATION_FAILED: "CUSTOM_DOMAIN_REGISTRATION_FAILED",
   DAILY_QUOTA_EXCEEDED: "DAILY_QUOTA_EXCEEDED",
@@ -410,6 +433,8 @@ var API_ERROR_CODES = {
   FORBIDDEN_KEY: "FORBIDDEN_KEY",
   FORCED_SNAPSHOT_RATE_LIMIT: "FORCED_SNAPSHOT_RATE_LIMIT",
   FREE_PLAN_NO_WEB_PUBLISH: "FREE_PLAN_NO_WEB_PUBLISH",
+  /** 403 — the Free plan can no longer create applications or databases; a paid plan is required. */
+  FREE_PLAN_SUSPENDED: "FREE_PLAN_SUSPENDED",
   INSTALLATION_NOT_FOUND: "INSTALLATION_NOT_FOUND",
   INSTALL_SHIELD_BLOCKED: "INSTALL_SHIELD_BLOCKED",
   INSTALL_TIMEOUT: "INSTALL_TIMEOUT",
@@ -458,9 +483,12 @@ var API_ERROR_CODES = {
   ORDER_NOT_PAID: "ORDER_NOT_PAID",
   ORDER_NOT_PAYABLE: "ORDER_NOT_PAYABLE",
   ORDER_NOT_REFUNDED: "ORDER_NOT_REFUNDED",
+  /** 404 — the order has no payment receipt (unpaid, redeemed code or paid before receipts existed). */
+  ORDER_RECEIPT_UNAVAILABLE: "ORDER_RECEIPT_UNAVAILABLE",
   OWNER_APP_WITHOUT_LIMITS: "OWNER_APP_WITHOUT_LIMITS",
   PAYLOAD_TOO_LARGE: "PAYLOAD_TOO_LARGE",
   PENDING_ORDER_LIMIT_REACHED: "PENDING_ORDER_LIMIT_REACHED",
+  PAYMENT_METHOD_UNAVAILABLE: "PAYMENT_METHOD_UNAVAILABLE",
   PLAN_DOES_NOT_SUPPORT_CUSTOM_DOMAIN: "PLAN_DOES_NOT_SUPPORT_CUSTOM_DOMAIN",
   PLAN_DOES_NOT_SUPPORT_CUSTOM_SUBDOMAIN: "PLAN_DOES_NOT_SUPPORT_CUSTOM_SUBDOMAIN",
   PLAN_DOES_NOT_SUPPORT_WEB_PUBLISH: "PLAN_DOES_NOT_SUPPORT_WEB_PUBLISH",
@@ -480,10 +508,11 @@ var API_ERROR_CODES = {
   SOURCE_CONFLICT: "SOURCE_CONFLICT",
   SOURCE_REQUIRED: "SOURCE_REQUIRED",
   STORAGE_ABOVE_NEW_LIMIT: "STORAGE_ABOVE_NEW_LIMIT",
-  SUBDOMAIN_ALREADY_IN_USE: "SUBDOMAIN_ALREADY_IN_USE",
   SUBDOMAIN_CHANGE_RATE_LIMITED: "SUBDOMAIN_CHANGE_RATE_LIMITED",
   SUBDOMAIN_FORBIDDEN: "SUBDOMAIN_FORBIDDEN",
   SUBDOMAIN_TAKEN: "SUBDOMAIN_TAKEN",
+  /** 400 — the CPF or CNPJ is not valid. */
+  TAX_ID_INVALID: "TAX_ID_INVALID",
   TYPE_MISMATCH: "TYPE_MISMATCH",
   USER_LIMITS_NOT_FOUND: "USER_LIMITS_NOT_FOUND",
   USER_NOT_FOUND: "USER_NOT_FOUND",
@@ -558,6 +587,12 @@ var ApplicationRealtimeEventType = {
   HEARTBEAT: "heartbeat"
 };
 
+// payloads/v1/billing.ts
+var BillingTaxIdType = {
+  CPF: "cpf",
+  CNPJ: "cnpj"
+};
+
 // payloads/v1/database.ts
 var DatabaseType = {
   POSTGRESQL: 1,
@@ -634,8 +669,14 @@ var OrderType = {
 };
 var OrderProvider = {
   PIX: "pix",
+  CARD: "card",
   REDEEM_CODE: "redeem_code"
 };
+var OrderCardPaymentStatus = {
+  SUCCEEDED: "succeeded",
+  REQUIRES_ACTION: "requires_action",
+  PROCESSING: "processing"
+};
 
 // payloads/v1/snapshot.ts
 var ResourceType = {
@@ -685,6 +726,7 @@ export {
   ApplicationStatus,
   ApplicationType,
   ApplicationVersion,
+  BillingTaxIdType,
   DatabaseCluster,
   DatabaseFilterOperator,
   DatabaseRedisKeyType,
@@ -694,6 +736,7 @@ export {
   DatabaseType,
   NotificationImportance,
   NotificationType,
+  OrderCardPaymentStatus,
   OrderProvider,
   OrderStatus,
   OrderType,

package/payloads/v1/orders.d.ts

@@ -23,9 +23,10 @@ declare const OrderType: {
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
  */
-type OrderProvider = "pix" | "redeem_code";
+type OrderProvider = "pix" | "card" | "redeem_code";
 declare const OrderProvider: {
     readonly PIX: "pix";
+    readonly CARD: "card";
     readonly REDEEM_CODE: "redeem_code";
 };
 /**
@@ -43,6 +44,28 @@ interface APIOrderCreateResponse {
     /** Final price, after the discount. */
     price: number;
     expires_at: ISODateString | null;
+    /**
+     * Payment methods the order accepts. The Economy plan and a coupon restricted to one method narrow
+     * the list; otherwise `["pix", "card"]` when card payments are available, `["pix"]` when not.
+     * Starting a payment with a method outside the list returns 400 `COUPON_PAYMENT_METHOD` (coupon) or
+     * 400 `CARD_NOT_ALLOWED_FOR_PLAN` (Economy).
+     */
+    allowed_payment_methods: OrderProvider[];
+}
+/**
+ * Price an order would have with a coupon, without creating the order or using the coupon.
+ * Prices already include the billing-period discount (3 months −5%, 12 −15%).
+ */
+interface APIOrderCouponPreview {
+    /** The coupon code as registered. */
+    coupon: string;
+    /** Price for the plan and period before the coupon. */
+    price_before_discount: number;
+    discount_amount: number;
+    /** Final price with the coupon. */
+    price: number;
+    /** Payment methods the coupon allows, same rule as `APIOrderCreateResponse.allowed_payment_methods`. */
+    allowed_payment_methods: OrderProvider[];
 }
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
@@ -67,6 +90,8 @@ interface APIOrderStatus {
             months: number;
         };
     };
+    /** Same semantics as in {@link APIOrderCreateResponse.allowed_payment_methods}. */
+    allowed_payment_methods: OrderProvider[];
 }
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders
@@ -86,6 +111,15 @@ interface APIOrderListItem {
     };
     created_at: ISODateString;
     paid_at: ISODateString | null;
+    /** A payment receipt exists for this order (`GET /v1/orders/:orderId/receipt`). */
+    has_receipt: boolean;
+}
+/**
+ * Payment receipt of a paid order (`GET /v1/orders/:orderId/receipt`). Dashboard session only.
+ */
+interface APIOrderReceipt {
+    /** Public page of the receipt, hosted by the payment processor. */
+    url: string;
 }
 /**
  * PIX charge of an order (`POST /v1/orders/:orderId/initiate/pix`).
@@ -101,5 +135,21 @@ interface APIOrderPixPayment {
         base64: string | null;
     };
 }
+/**
+ * Card charge of an order (`POST /v1/orders/:orderId/pay/card`). Dashboard session only.
+ * - `succeeded`: paid; the plan is delivered in a few seconds.
+ * - `requires_action`: the bank asks the customer to confirm (3-D Secure) in the browser with `client_secret`.
+ * - `processing`: the bank is still confirming; poll the order status.
+ */
+interface APIOrderCardPayment {
+    client_secret: string;
+    status: OrderCardPaymentStatus;
+}
+type OrderCardPaymentStatus = "succeeded" | "requires_action" | "processing";
+declare const OrderCardPaymentStatus: {
+    readonly SUCCEEDED: "succeeded";
+    readonly REQUIRES_ACTION: "requires_action";
+    readonly PROCESSING: "processing";
+};
 
-export { type APIOrderCreateResponse, type APIOrderDiscount, type APIOrderListItem, type APIOrderPixPayment, type APIOrderStatus, OrderProvider, OrderStatus, OrderType };
+export { type APIOrderCardPayment, type APIOrderCouponPreview, type APIOrderCreateResponse, type APIOrderDiscount, type APIOrderListItem, type APIOrderPixPayment, type APIOrderReceipt, type APIOrderStatus, OrderCardPaymentStatus, OrderProvider, OrderStatus, OrderType };

package/payloads/v1/orders.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // payloads/v1/orders.ts
 var orders_exports = {};
 __export(orders_exports, {
+  OrderCardPaymentStatus: () => OrderCardPaymentStatus,
   OrderProvider: () => OrderProvider,
   OrderStatus: () => OrderStatus,
   OrderType: () => OrderType
@@ -38,10 +39,17 @@ var OrderType = {
 };
 var OrderProvider = {
   PIX: "pix",
+  CARD: "card",
   REDEEM_CODE: "redeem_code"
 };
+var OrderCardPaymentStatus = {
+  SUCCEEDED: "succeeded",
+  REQUIRES_ACTION: "requires_action",
+  PROCESSING: "processing"
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  OrderCardPaymentStatus,
   OrderProvider,
   OrderStatus,
   OrderType

package/payloads/v1/orders.js.map

@@ -1 +1 @@
-{"version":3,"sources":["orders.ts"],"sourcesContent":["import type { ISODateString } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderStatus = \"unpaid\" | \"paid\" | \"cancelled\" | \"expired\";\nexport const OrderStatus = {\n\tUNPAID: \"unpaid\",\n\tPAID: \"paid\",\n\tCANCELLED: \"cancelled\",\n\tEXPIRED: \"expired\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderType = \"purchase\" | \"renew\" | \"upgrade\";\nexport const OrderType = {\n\tPURCHASE: \"purchase\",\n\tRENEW: \"renew\",\n\tUPGRADE: \"upgrade\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderProvider = \"pix\" | \"redeem_code\";\nexport const OrderProvider = {\n\tPIX: \"pix\",\n\tREDEEM_CODE: \"redeem_code\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface APIOrderCreateResponse {\n\tid: string;\n\tcode: string | null;\n\t/** Usually `\"unpaid\"`; `\"paid\"` right away when a coupon brings the price to zero. */\n\tstatus: OrderStatus;\n\tplan: string;\n\t/** Duration in days. */\n\tduration: number;\n\tdiscount: APIOrderDiscount;\n\t/** Final price, after the discount. */\n\tprice: number;\n\texpires_at: ISODateString | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface APIOrderDiscount {\n\t/** `null` when no coupon was applied. */\n\tpercent: number | null;\n\tcoupon: string | null;\n\t/** Price before the discount. */\n\tprice: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status\n */\nexport interface APIOrderStatus {\n\tid: string;\n\tstatus: OrderStatus;\n\tprice: number;\n\trelated_to: { plan: { name: string; months: number } };\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport interface APIOrderListItem {\n\tid: string;\n\tstatus: OrderStatus;\n\tprice: number;\n\tprovider: OrderProvider;\n\ttype: OrderType;\n\trelated_to: { plan: { name: string; duration: number; months: number } };\n\tcreated_at: ISODateString;\n\tpaid_at: ISODateString | null;\n}\n\n/**\n * PIX charge of an order (`POST /v1/orders/:orderId/initiate/pix`).\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix\n */\nexport interface APIOrderPixPayment {\n\t/** Amount charged, in BRL. */\n\ttransaction_amount: number;\n\texternal_reference: string | null;\n\ttxid: string;\n\tqrcode: { copy: string | null; base64: string | null };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,cAAc;AAAA,EAC1B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,WAAW;AAAA,EACX,SAAS;AACV;AAMO,IAAM,YAAY;AAAA,EACxB,UAAU;AAAA,EACV,OAAO;AAAA,EACP,SAAS;AACV;AAMO,IAAM,gBAAgB;AAAA,EAC5B,KAAK;AAAA,EACL,aAAa;AACd;","names":[]}
+{"version":3,"sources":["orders.ts"],"sourcesContent":["import type { ISODateString } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderStatus = \"unpaid\" | \"paid\" | \"cancelled\" | \"expired\";\nexport const OrderStatus = {\n\tUNPAID: \"unpaid\",\n\tPAID: \"paid\",\n\tCANCELLED: \"cancelled\",\n\tEXPIRED: \"expired\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderType = \"purchase\" | \"renew\" | \"upgrade\";\nexport const OrderType = {\n\tPURCHASE: \"purchase\",\n\tRENEW: \"renew\",\n\tUPGRADE: \"upgrade\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type OrderProvider = \"pix\" | \"card\" | \"redeem_code\";\nexport const OrderProvider = {\n\tPIX: \"pix\",\n\tCARD: \"card\",\n\tREDEEM_CODE: \"redeem_code\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface APIOrderCreateResponse {\n\tid: string;\n\tcode: string | null;\n\t/** Usually `\"unpaid\"`; `\"paid\"` right away when a coupon brings the price to zero. */\n\tstatus: OrderStatus;\n\tplan: string;\n\t/** Duration in days. */\n\tduration: number;\n\tdiscount: APIOrderDiscount;\n\t/** Final price, after the discount. */\n\tprice: number;\n\texpires_at: ISODateString | null;\n\t/**\n\t * Payment methods the order accepts. The Economy plan and a coupon restricted to one method narrow\n\t * the list; otherwise `[\"pix\", \"card\"]` when card payments are available, `[\"pix\"]` when not.\n\t * Starting a payment with a method outside the list returns 400 `COUPON_PAYMENT_METHOD` (coupon) or\n\t * 400 `CARD_NOT_ALLOWED_FOR_PLAN` (Economy).\n\t */\n\tallowed_payment_methods: OrderProvider[];\n}\n\n/**\n * Price an order would have with a coupon, without creating the order or using the coupon.\n * Prices already include the billing-period discount (3 months −5%, 12 −15%).\n */\nexport interface APIOrderCouponPreview {\n\t/** The coupon code as registered. */\n\tcoupon: string;\n\t/** Price for the plan and period before the coupon. */\n\tprice_before_discount: number;\n\tdiscount_amount: number;\n\t/** Final price with the coupon. */\n\tprice: number;\n\t/** Payment methods the coupon allows, same rule as `APIOrderCreateResponse.allowed_payment_methods`. */\n\tallowed_payment_methods: OrderProvider[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface APIOrderDiscount {\n\t/** `null` when no coupon was applied. */\n\tpercent: number | null;\n\tcoupon: string | null;\n\t/** Price before the discount. */\n\tprice: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status\n */\nexport interface APIOrderStatus {\n\tid: string;\n\tstatus: OrderStatus;\n\tprice: number;\n\trelated_to: { plan: { name: string; months: number } };\n\t/** Same semantics as in {@link APIOrderCreateResponse.allowed_payment_methods}. */\n\tallowed_payment_methods: OrderProvider[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport interface APIOrderListItem {\n\tid: string;\n\tstatus: OrderStatus;\n\tprice: number;\n\tprovider: OrderProvider;\n\ttype: OrderType;\n\trelated_to: { plan: { name: string; duration: number; months: number } };\n\tcreated_at: ISODateString;\n\tpaid_at: ISODateString | null;\n\t/** A payment receipt exists for this order (`GET /v1/orders/:orderId/receipt`). */\n\thas_receipt: boolean;\n}\n\n/**\n * Payment receipt of a paid order (`GET /v1/orders/:orderId/receipt`). Dashboard session only.\n */\nexport interface APIOrderReceipt {\n\t/** Public page of the receipt, hosted by the payment processor. */\n\turl: string;\n}\n\n/**\n * PIX charge of an order (`POST /v1/orders/:orderId/initiate/pix`).\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix\n */\nexport interface APIOrderPixPayment {\n\t/** Amount charged, in BRL. */\n\ttransaction_amount: number;\n\texternal_reference: string | null;\n\ttxid: string;\n\tqrcode: { copy: string | null; base64: string | null };\n}\n\n/**\n * Card charge of an order (`POST /v1/orders/:orderId/pay/card`). Dashboard session only.\n * - `succeeded`: paid; the plan is delivered in a few seconds.\n * - `requires_action`: the bank asks the customer to confirm (3-D Secure) in the browser with `client_secret`.\n * - `processing`: the bank is still confirming; poll the order status.\n */\nexport interface APIOrderCardPayment {\n\tclient_secret: string;\n\tstatus: OrderCardPaymentStatus;\n}\n\nexport type OrderCardPaymentStatus = \"succeeded\" | \"requires_action\" | \"processing\";\nexport const OrderCardPaymentStatus = {\n\tSUCCEEDED: \"succeeded\",\n\tREQUIRES_ACTION: \"requires_action\",\n\tPROCESSING: \"processing\",\n} as const;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,cAAc;AAAA,EAC1B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,WAAW;AAAA,EACX,SAAS;AACV;AAMO,IAAM,YAAY;AAAA,EACxB,UAAU;AAAA,EACV,OAAO;AAAA,EACP,SAAS;AACV;AAMO,IAAM,gBAAgB;AAAA,EAC5B,KAAK;AAAA,EACL,MAAM;AAAA,EACN,aAAa;AACd;AAiHO,IAAM,yBAAyB;AAAA,EACrC,WAAW;AAAA,EACX,iBAAiB;AAAA,EACjB,YAAY;AACb;","names":[]}

package/payloads/v1/orders.mjs

@@ -12,9 +12,16 @@ var OrderType = {
 };
 var OrderProvider = {
   PIX: "pix",
+  CARD: "card",
   REDEEM_CODE: "redeem_code"
 };
+var OrderCardPaymentStatus = {
+  SUCCEEDED: "succeeded",
+  REQUIRES_ACTION: "requires_action",
+  PROCESSING: "processing"
+};
 export {
+  OrderCardPaymentStatus,
   OrderProvider,
   OrderStatus,
   OrderType

package/rest/v1/billing.d.ts

@@ -0,0 +1,53 @@
+import { APIPayload } from '../../common/v1.js';
+import { APIBillingCard, APIBillingDetails, APIBillingRenewal, APIBillingAddress, BillingTaxIdType } from '../../payloads/v1/billing.js';
+import '../../payloads/v1/api-error.js';
+
+/** `GET /v1/users/me/billing` — Dashboard session only. `response` is `null` until details are saved. */
+type RESTGetAPIBillingDetailsResponse = APIPayload<APIBillingDetails | null>;
+/**
+ * `PUT /v1/users/me/billing` — Dashboard session only. Replaces the billing details.
+ * Fails with 400 `BILLING_DETAILS_INVALID` (the field in `details.path`), 400 `TAX_ID_INVALID` and
+ * 400 `PAYMENT_METHOD_UNAVAILABLE` when online payments are not available.
+ */
+interface RESTPutAPIBillingDetailsBody {
+    name: string;
+    address: APIBillingAddress;
+    phone: string;
+    /** Optional. `null` removes the saved document; omitting it keeps the saved one. */
+    tax_id?: {
+        type: BillingTaxIdType;
+        value: string;
+    } | null;
+}
+/** `PUT /v1/users/me/billing` — Dashboard session only. */
+type RESTPutAPIBillingDetailsResponse = APIPayload<APIBillingDetails>;
+/** `GET /v1/users/me/cards` — Dashboard session only. Default card first. */
+type RESTGetAPIBillingCardsResponse = APIPayload<APIBillingCard[]>;
+/**
+ * `POST /v1/users/me/cards/setup` — Dashboard session only. Secret that saves a new card in the
+ * browser. The card shows up in `GET /v1/users/me/cards` once confirmed; the first card becomes the default.
+ * 400 `PAYMENT_METHOD_UNAVAILABLE` when online payments are not available.
+ */
+type RESTPostAPIBillingCardSetupResponse = APIPayload<{
+    client_secret: string;
+}>;
+/** `POST /v1/users/me/cards/:cardId/default` — Dashboard session only. 404 `CARD_NOT_FOUND`. */
+type RESTPostAPIBillingCardDefaultResponse = APIPayload<APIBillingCard[]>;
+/**
+ * `DELETE /v1/users/me/cards/:cardId` — Dashboard session only. 404 `CARD_NOT_FOUND`.
+ * Removing the default card makes the most recent remaining card the default; without cards,
+ * the plan no longer renews automatically. 400 `PAYMENT_METHOD_UNAVAILABLE` when online payments are
+ * not available.
+ */
+type RESTDeleteAPIBillingCardResponse = APIPayload<null>;
+/** `GET /v1/users/me/billing/renewal` — Dashboard session only. */
+type RESTGetAPIBillingRenewalResponse = APIPayload<APIBillingRenewal>;
+/** `PATCH /v1/users/me/billing/renewal` — Dashboard session only. 400 `INVALID_PAYLOAD` for a malformed body. */
+interface RESTPatchAPIBillingRenewalBody {
+    /** `false` cancels the automatic renewal (no charge is made later); `true` turns it back on. */
+    auto_renew: boolean;
+}
+/** `PATCH /v1/users/me/billing/renewal` — Dashboard session only. */
+type RESTPatchAPIBillingRenewalResponse = APIPayload<APIBillingRenewal>;
+
+export type { RESTDeleteAPIBillingCardResponse, RESTGetAPIBillingCardsResponse, RESTGetAPIBillingDetailsResponse, RESTGetAPIBillingRenewalResponse, RESTPatchAPIBillingRenewalBody, RESTPatchAPIBillingRenewalResponse, RESTPostAPIBillingCardDefaultResponse, RESTPostAPIBillingCardSetupResponse, RESTPutAPIBillingDetailsBody, RESTPutAPIBillingDetailsResponse };

package/rest/v1/billing.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// rest/v1/billing.ts
+var billing_exports = {};
+module.exports = __toCommonJS(billing_exports);
+//# sourceMappingURL=billing.js.map

package/rest/v1/billing.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["billing.ts"],"sourcesContent":["import type { APIBillingAddress, APIBillingCard, APIBillingDetails, APIBillingRenewal, APIPayload, BillingTaxIdType } from \"../../v1\";\n\n/** `GET /v1/users/me/billing` — Dashboard session only. `response` is `null` until details are saved. */\nexport type RESTGetAPIBillingDetailsResponse = APIPayload<APIBillingDetails | null>;\n\n/**\n * `PUT /v1/users/me/billing` — Dashboard session only. Replaces the billing details.\n * Fails with 400 `BILLING_DETAILS_INVALID` (the field in `details.path`), 400 `TAX_ID_INVALID` and\n * 400 `PAYMENT_METHOD_UNAVAILABLE` when online payments are not available.\n */\nexport interface RESTPutAPIBillingDetailsBody {\n\tname: string;\n\taddress: APIBillingAddress;\n\tphone: string;\n\t/** Optional. `null` removes the saved document; omitting it keeps the saved one. */\n\ttax_id?: { type: BillingTaxIdType; value: string } | null;\n}\n\n/** `PUT /v1/users/me/billing` — Dashboard session only. */\nexport type RESTPutAPIBillingDetailsResponse = APIPayload<APIBillingDetails>;\n\n/** `GET /v1/users/me/cards` — Dashboard session only. Default card first. */\nexport type RESTGetAPIBillingCardsResponse = APIPayload<APIBillingCard[]>;\n\n/**\n * `POST /v1/users/me/cards/setup` — Dashboard session only. Secret that saves a new card in the\n * browser. The card shows up in `GET /v1/users/me/cards` once confirmed; the first card becomes the default.\n * 400 `PAYMENT_METHOD_UNAVAILABLE` when online payments are not available.\n */\nexport type RESTPostAPIBillingCardSetupResponse = APIPayload<{ client_secret: string }>;\n\n/** `POST /v1/users/me/cards/:cardId/default` — Dashboard session only. 404 `CARD_NOT_FOUND`. */\nexport type RESTPostAPIBillingCardDefaultResponse = APIPayload<APIBillingCard[]>;\n\n/**\n * `DELETE /v1/users/me/cards/:cardId` — Dashboard session only. 404 `CARD_NOT_FOUND`.\n * Removing the default card makes the most recent remaining card the default; without cards,\n * the plan no longer renews automatically. 400 `PAYMENT_METHOD_UNAVAILABLE` when online payments are\n * not available.\n */\nexport type RESTDeleteAPIBillingCardResponse = APIPayload<null>;\n\n/** `GET /v1/users/me/billing/renewal` — Dashboard session only. */\nexport type RESTGetAPIBillingRenewalResponse = APIPayload<APIBillingRenewal>;\n\n/** `PATCH /v1/users/me/billing/renewal` — Dashboard session only. 400 `INVALID_PAYLOAD` for a malformed body. */\nexport interface RESTPatchAPIBillingRenewalBody {\n\t/** `false` cancels the automatic renewal (no charge is made later); `true` turns it back on. */\n\tauto_renew: boolean;\n}\n\n/** `PATCH /v1/users/me/billing/renewal` — Dashboard session only. */\nexport type RESTPatchAPIBillingRenewalResponse = APIPayload<APIBillingRenewal>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/billing.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=billing.mjs.map

package/rest/v1/index.d.ts

@@ -1,11 +1,12 @@
 export { RESTGetAPIActivitiesQuery, RESTGetAPIActivitiesResponse } from './activity.js';
 export { RESTDeleteAPIUserApiKeyResponse, RESTGetAPIUserApiKeysResponse, RESTPatchAPIUserApiKeyBody, RESTPatchAPIUserApiKeyResponse, RESTPostAPIUserApiKeyCreateBody, RESTPostAPIUserApiKeyCreateResponse, RESTPostAPIUserApiKeyRotateResponse } from './api-key.js';
 export { RESTDeleteAPIApplicationCustomDomainResponse, RESTDeleteAPIApplicationEnvironmentResponse, RESTDeleteAPIApplicationFileBody, RESTDeleteAPIApplicationFileResponse, RESTDeleteAPIApplicationResponse, RESTDeleteAPIApplicationWebPublishResponse, RESTDeleteAPIApplicationWebhookResponse, RESTGetAPIApplicationCustomDomainResponse, RESTGetAPIApplicationDeploymentsResponse, RESTGetAPIApplicationDnsRecordsResponse, RESTGetAPIApplicationDownloadResponse, RESTGetAPIApplicationEnvironmentResponse, RESTGetAPIApplicationFileContentQuery, RESTGetAPIApplicationFileContentResponse, RESTGetAPIApplicationFileTreeResponse, RESTGetAPIApplicationFilesQuery, RESTGetAPIApplicationFilesResponse, RESTGetAPIApplicationLogsResponse, RESTGetAPIApplicationMetricsQuery, RESTGetAPIApplicationMetricsResponse, RESTGetAPIApplicationRealtimeQuery, RESTGetAPIApplicationRealtimeResponse, RESTGetAPIApplicationResponse, RESTGetAPIApplicationRuntimesResponse, RESTGetAPIApplicationStatusResponse, RESTGetAPIApplicationStatusShortResponse, RESTGetAPIApplicationWebhookUrlResponse, RESTPatchAPIApplicationFileMoveBody, RESTPatchAPIApplicationFileMoveResponse, RESTPatchAPIApplicationSubdomainBody, RESTPatchAPIApplicationSubdomainResponse, RESTPatchAPIApplicationUpdateConfigBody, RESTPatchAPIApplicationUpdateConfigResponse, RESTPostAPIApplicationCreateBody, RESTPostAPIApplicationCreateResponse, RESTPostAPIApplicationCustomDomainBody, RESTPostAPIApplicationCustomDomainResponse, RESTPostAPIApplicationEnvironmentBody, RESTPostAPIApplicationEnvironmentResponse, RESTPostAPIApplicationEnvironmentVariableBody, RESTPostAPIApplicationFileUploadQuery, RESTPostAPIApplicationFileUploadResponse, RESTPostAPIApplicationPurgeCacheBody, RESTPostAPIApplicationPurgeCacheResponse, RESTPostAPIApplicationRestartBody, RESTPostAPIApplicationRestartResponse, RESTPostAPIApplicationScanBody, RESTPostAPIApplicationScanResponse, RESTPostAPIApplicationStartResponse, RESTPostAPIApplicationStopResponse, RESTPostAPIApplicationWebPublishBody, RESTPostAPIApplicationWebPublishResponse, RESTPostAPIApplicationWebhookCreateBody, RESTPostAPIApplicationWebhookCreateResponse, RESTPutAPIApplicationFileBody, RESTPutAPIApplicationFileResponse } from './application.js';
+export { RESTDeleteAPIBillingCardResponse, RESTGetAPIBillingCardsResponse, RESTGetAPIBillingDetailsResponse, RESTGetAPIBillingRenewalResponse, RESTPatchAPIBillingRenewalBody, RESTPatchAPIBillingRenewalResponse, RESTPostAPIBillingCardDefaultResponse, RESTPostAPIBillingCardSetupResponse, RESTPutAPIBillingDetailsBody, RESTPutAPIBillingDetailsResponse } from './billing.js';
 export { RESTDeleteAPIDatabaseResponse, RESTGetAPIDatabaseCertificateResponse, RESTGetAPIDatabaseMetricsResponse, RESTGetAPIDatabaseResponse, RESTGetAPIDatabaseStatusResponse, RESTGetAPIDatabaseStatusShortResponse, RESTPostAPIDatabaseCreateBody, RESTPostAPIDatabaseCreateResponse, RESTPostAPIDatabaseResetCertificateResponse, RESTPostAPIDatabaseResetPasswordResponse, RESTPostAPIDatabaseResetResponse, RESTPostAPIDatabaseStartResponse, RESTPostAPIDatabaseStopResponse, RESTPutAPIDatabaseUpdateBody, RESTPutAPIDatabaseUpdateResponse } from './database.js';
 export { RESTDeleteAPIDatabaseDocumentsBody, RESTDeleteAPIDatabaseRedisKeysBody, RESTDeleteAPIDatabaseRowsBody, RESTGetAPIDatabaseCollectionIndexesResult, RESTGetAPIDatabaseCollectionsResult, RESTGetAPIDatabaseDataOverviewResult, RESTGetAPIDatabaseDocumentsResult, RESTGetAPIDatabaseRedisInfoResult, RESTGetAPIDatabaseRedisKeyValueResult, RESTGetAPIDatabaseRedisKeysResult, RESTGetAPIDatabaseSchemasResult, RESTGetAPIDatabaseTableColumnsResult, RESTGetAPIDatabaseTableRowsResult, RESTGetAPIDatabaseTablesResult, RESTMutateAPIDatabaseDocumentsResult, RESTMutateAPIDatabaseRedisKeysResult, RESTMutateAPIDatabaseRowsResult, RESTPostAPIDatabaseDocumentCreateBody, RESTPostAPIDatabaseQueryBody, RESTPostAPIDatabaseQueryResult, RESTPostAPIDatabaseRowCreateBody, RESTPutAPIDatabaseDocumentUpdateBody, RESTPutAPIDatabaseRedisKeyBody, RESTPutAPIDatabaseRedisKeyExpireBody, RESTPutAPIDatabaseRowUpdateBody } from './database-data.js';
 export { RESTGetAPINotificationsResponse } from './notification.js';
 export { RESTGetAPIOAuthClientResponse, RESTPostAPIOAuthConsentBody, RESTPostAPIOAuthConsentResponse, RESTPostAPIOAuthRegisterBody, RESTPostAPIOAuthRegisterResponse, RESTPostAPIOAuthTokenBody, RESTPostAPIOAuthTokenResponse } from './oauth.js';
-export { RESTGetAPIOrderListQuery, RESTGetAPIOrderListResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCreateBody, RESTPostAPIOrderCreateResponse, RESTPostAPIOrderPixPaymentResponse } from './orders.js';
+export { RESTGetAPIOrderListQuery, RESTGetAPIOrderListResponse, RESTGetAPIOrderReceiptResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCardPaymentBody, RESTPostAPIOrderCardPaymentResponse, RESTPostAPIOrderCouponPreviewBody, RESTPostAPIOrderCouponPreviewResponse, RESTPostAPIOrderCreateBody, RESTPostAPIOrderCreateResponse, RESTPostAPIOrderPixPaymentResponse } from './orders.js';
 export { RESTPostAPIRedeemResponse } from './redeem.js';
 export { RESTGetAPIGroupedSnapshotsQuery, RESTGetAPIGroupedSnapshotsResponse, RESTGetAPISnapshotDownloadQuery, RESTGetAPISnapshotDownloadResponse, RESTGetAPISnapshotsQuery, RESTGetAPISnapshotsResponse, RESTPostAPISnapshotCreateQuery, RESTPostAPISnapshotCreateResponse, RESTPostAPISnapshotRestoreBody, RESTPostAPISnapshotRestoreQuery, RESTPostAPISnapshotRestoreResponse } from './snapshot.js';
 export { RESTGetAPIStatusResponse } from './status.js';
@@ -17,6 +18,7 @@ import '../../payloads/v1/activity.js';
 import '../../payloads/v1/notification.js';
 import '../../payloads/v1/api-key.js';
 import '../../payloads/v1/application.js';
+import '../../payloads/v1/billing.js';
 import '../../payloads/v1/database.js';
 import '../../payloads/v1/database-data.js';
 import '../../payloads/v1/oauth.js';

package/rest/v1/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["index.ts"],"sourcesContent":["export * from \"./activity\";\nexport * from \"./api-key\";\nexport * from \"./application\";\nexport * from \"./database\";\nexport * from \"./database-data\";\nexport * from \"./notification\";\nexport * from \"./oauth\";\nexport * from \"./orders\";\nexport * from \"./redeem\";\nexport * from \"./snapshot\";\nexport * from \"./status\";\nexport * from \"./user\";\nexport * from \"./workspace\";\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["index.ts"],"sourcesContent":["export * from \"./activity\";\nexport * from \"./api-key\";\nexport * from \"./application\";\nexport * from \"./billing\";\nexport * from \"./database\";\nexport * from \"./database-data\";\nexport * from \"./notification\";\nexport * from \"./oauth\";\nexport * from \"./orders\";\nexport * from \"./redeem\";\nexport * from \"./snapshot\";\nexport * from \"./status\";\nexport * from \"./user\";\nexport * from \"./workspace\";\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/rest/v1/orders.d.ts

@@ -1,5 +1,5 @@
 import { APIPayload } from '../../common/v1.js';
-import { OrderProvider, APIOrderListItem, APIOrderStatus, OrderType, APIOrderCreateResponse, APIOrderPixPayment } from '../../payloads/v1/orders.js';
+import { OrderProvider, APIOrderListItem, APIOrderReceipt, APIOrderStatus, APIOrderCardPayment, APIOrderCouponPreview, OrderType, APIOrderCreateResponse, APIOrderPixPayment } from '../../payloads/v1/orders.js';
 import '../../payloads/v1/api-error.js';
 
 /**
@@ -8,7 +8,7 @@ import '../../payloads/v1/api-error.js';
  */
 interface RESTPostAPIOrderCreateBody {
     plan: string;
-    /** 1, 3, 6 or 12. */
+    /** 1, 3 or 12. The Economy plan only accepts 1. Anything else returns 400 `INVALID_MONTHS`. */
     months: number;
     coupon?: string;
     /** Defaults to `"purchase"`. */
@@ -19,6 +19,19 @@ interface RESTPostAPIOrderCreateBody {
  * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order
  */
 type RESTPostAPIOrderCreateResponse = APIPayload<APIOrderCreateResponse>;
+/**
+ * `POST /v1/orders/coupon-preview` — Dashboard session only. Checks a coupon against a plan and
+ * period for the signed-in account without creating an order or using the coupon. Fails with 400
+ * `INVALID_PAYLOAD`, 400 `INVALID_PLAN`, 400 `INVALID_MONTHS` and the `COUPON_*` codes that
+ * `POST /v1/orders` returns for the same coupon.
+ */
+interface RESTPostAPIOrderCouponPreviewBody {
+    coupon: string;
+    plan: string;
+    /** 1, 3 or 12. */
+    months: number;
+}
+type RESTPostAPIOrderCouponPreviewResponse = APIPayload<APIOrderCouponPreview>;
 /**
  * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status
  */
@@ -34,9 +47,40 @@ interface RESTGetAPIOrderListQuery {
  */
 type RESTGetAPIOrderListResponse = APIPayload<APIOrderListItem[]>;
 /**
- * `POST /v1/orders/:orderId/initiate/pix`.
+ * `GET /v1/orders/:orderId/receipt`. Dashboard session only. `ORDER_RECEIPT_UNAVAILABLE` when the
+ * order has no receipt (`has_receipt: false`).
+ */
+type RESTGetAPIOrderReceiptResponse = APIPayload<APIOrderReceipt>;
+/**
+ * `POST /v1/orders/:orderId/initiate/pix`. Calling it again returns the same QR code while it is valid;
+ * it expires with the order (`expires_at`).
+ * Fails with 404 `ORDER_NOT_FOUND`, 403 `FORBIDDEN` when the order belongs to another account,
+ * 400 `ORDER_NOT_PAYABLE` when the order is paid, cancelled or expired, 400 `COUPON_PAYMENT_METHOD`
+ * when the order's coupon excludes PIX, 409 `ORDER_NOT_PAYABLE` while a card payment of the order is
+ * being confirmed, 400 `PAYMENT_METHOD_UNAVAILABLE` when online payments are not available, 400
+ * `INVALID_PARAMS` for a malformed `orderId`, and 429 `RATE_LIMIT_EXCEEDED` while another payment of the
+ * account is being started.
+ * Starting a PIX cancels a card payment of the same order that was not completed.
  * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix
  */
 type RESTPostAPIOrderPixPaymentResponse = APIPayload<APIOrderPixPayment>;
+/** `POST /v1/orders/:orderId/pay/card` — Dashboard session only. */
+interface RESTPostAPIOrderCardPaymentBody {
+    /** Saved card (`GET /v1/users/me/cards`). */
+    card_id: string;
+}
+/**
+ * `POST /v1/orders/:orderId/pay/card` — Dashboard session only. Charges a saved card. Paying by card
+ * keeps the plan renewing automatically on the default card.
+ * Fails with 403 `WEBSITE_ONLY` for API keys, 400 `INVALID_PARAMS` for a malformed `orderId`, 400
+ * `INVALID_PAYLOAD` without a `card_id`, 404 `ORDER_NOT_FOUND`, 403 `FORBIDDEN` when the order belongs to
+ * another account, 404 `CARD_NOT_FOUND`, 400 `ORDER_NOT_PAYABLE` when the order is paid, cancelled or expired,
+ * 400 `CARD_NOT_ALLOWED_FOR_PLAN` for the Economy plan, 400 `COUPON_PAYMENT_METHOD` when the order's
+ * coupon excludes card, 400 `PAYMENT_METHOD_UNAVAILABLE` when card payments are not available,
+ * 402 `CARD_DECLINED` when the bank refuses the charge, 409 `ORDER_NOT_PAYABLE` while a PIX payment of
+ * the order is being confirmed, and 429 `RATE_LIMIT_EXCEEDED` while another payment of the account is
+ * being started.
+ */
+type RESTPostAPIOrderCardPaymentResponse = APIPayload<APIOrderCardPayment>;
 
-export type { RESTGetAPIOrderListQuery, RESTGetAPIOrderListResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCreateBody, RESTPostAPIOrderCreateResponse, RESTPostAPIOrderPixPaymentResponse };
+export type { RESTGetAPIOrderListQuery, RESTGetAPIOrderListResponse, RESTGetAPIOrderReceiptResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCardPaymentBody, RESTPostAPIOrderCardPaymentResponse, RESTPostAPIOrderCouponPreviewBody, RESTPostAPIOrderCouponPreviewResponse, RESTPostAPIOrderCreateBody, RESTPostAPIOrderCreateResponse, RESTPostAPIOrderPixPaymentResponse };

package/rest/v1/orders.js.map

@@ -1 +1 @@
-{"version":3,"sources":["orders.ts"],"sourcesContent":["import type { APIOrderCreateResponse, APIOrderListItem, APIOrderPixPayment, APIOrderStatus, APIPayload, OrderProvider, OrderType } from \"../../v1\";\n\n/**\n * A missing `plan` or `months` returns 400 `MISSING_PLAN_OR_MONTHS`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface RESTPostAPIOrderCreateBody {\n\tplan: string;\n\t/** 1, 3, 6 or 12. */\n\tmonths: number;\n\tcoupon?: string;\n\t/** Defaults to `\"purchase\"`. */\n\ttype?: OrderType;\n\tsource?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type RESTPostAPIOrderCreateResponse = APIPayload<APIOrderCreateResponse>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status\n */\nexport type RESTGetAPIOrderStatusResponse = APIPayload<APIOrderStatus>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport interface RESTGetAPIOrderListQuery {\n\tprovider?: OrderProvider;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport type RESTGetAPIOrderListResponse = APIPayload<APIOrderListItem[]>;\n\n/**\n * `POST /v1/orders/:orderId/initiate/pix`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix\n */\nexport type RESTPostAPIOrderPixPaymentResponse = APIPayload<APIOrderPixPayment>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["orders.ts"],"sourcesContent":["import type { APIOrderCardPayment, APIOrderCouponPreview, APIOrderCreateResponse, APIOrderListItem, APIOrderPixPayment, APIOrderReceipt, APIOrderStatus, APIPayload, OrderProvider, OrderType } from \"../../v1\";\n\n/**\n * A missing `plan` or `months` returns 400 `MISSING_PLAN_OR_MONTHS`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport interface RESTPostAPIOrderCreateBody {\n\tplan: string;\n\t/** 1, 3 or 12. The Economy plan only accepts 1. Anything else returns 400 `INVALID_MONTHS`. */\n\tmonths: number;\n\tcoupon?: string;\n\t/** Defaults to `\"purchase\"`. */\n\ttype?: OrderType;\n\tsource?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/create-order\n */\nexport type RESTPostAPIOrderCreateResponse = APIPayload<APIOrderCreateResponse>;\n\n/**\n * `POST /v1/orders/coupon-preview` — Dashboard session only. Checks a coupon against a plan and\n * period for the signed-in account without creating an order or using the coupon. Fails with 400\n * `INVALID_PAYLOAD`, 400 `INVALID_PLAN`, 400 `INVALID_MONTHS` and the `COUPON_*` codes that\n * `POST /v1/orders` returns for the same coupon.\n */\nexport interface RESTPostAPIOrderCouponPreviewBody {\n\tcoupon: string;\n\tplan: string;\n\t/** 1, 3 or 12. */\n\tmonths: number;\n}\n\nexport type RESTPostAPIOrderCouponPreviewResponse = APIPayload<APIOrderCouponPreview>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/order-status\n */\nexport type RESTGetAPIOrderStatusResponse = APIPayload<APIOrderStatus>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport interface RESTGetAPIOrderListQuery {\n\tprovider?: OrderProvider;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/list-orders\n */\nexport type RESTGetAPIOrderListResponse = APIPayload<APIOrderListItem[]>;\n\n/**\n * `GET /v1/orders/:orderId/receipt`. Dashboard session only. `ORDER_RECEIPT_UNAVAILABLE` when the\n * order has no receipt (`has_receipt: false`).\n */\nexport type RESTGetAPIOrderReceiptResponse = APIPayload<APIOrderReceipt>;\n\n/**\n * `POST /v1/orders/:orderId/initiate/pix`. Calling it again returns the same QR code while it is valid;\n * it expires with the order (`expires_at`).\n * Fails with 404 `ORDER_NOT_FOUND`, 403 `FORBIDDEN` when the order belongs to another account,\n * 400 `ORDER_NOT_PAYABLE` when the order is paid, cancelled or expired, 400 `COUPON_PAYMENT_METHOD`\n * when the order's coupon excludes PIX, 409 `ORDER_NOT_PAYABLE` while a card payment of the order is\n * being confirmed, 400 `PAYMENT_METHOD_UNAVAILABLE` when online payments are not available, 400\n * `INVALID_PARAMS` for a malformed `orderId`, and 429 `RATE_LIMIT_EXCEEDED` while another payment of the\n * account is being started.\n * Starting a PIX cancels a card payment of the same order that was not completed.\n * @see https://docs.vertracloud.app/api-reference/endpoint/billing/initiate-pix\n */\nexport type RESTPostAPIOrderPixPaymentResponse = APIPayload<APIOrderPixPayment>;\n\n/** `POST /v1/orders/:orderId/pay/card` — Dashboard session only. */\nexport interface RESTPostAPIOrderCardPaymentBody {\n\t/** Saved card (`GET /v1/users/me/cards`). */\n\tcard_id: string;\n}\n\n/**\n * `POST /v1/orders/:orderId/pay/card` — Dashboard session only. Charges a saved card. Paying by card\n * keeps the plan renewing automatically on the default card.\n * Fails with 403 `WEBSITE_ONLY` for API keys, 400 `INVALID_PARAMS` for a malformed `orderId`, 400\n * `INVALID_PAYLOAD` without a `card_id`, 404 `ORDER_NOT_FOUND`, 403 `FORBIDDEN` when the order belongs to\n * another account, 404 `CARD_NOT_FOUND`, 400 `ORDER_NOT_PAYABLE` when the order is paid, cancelled or expired,\n * 400 `CARD_NOT_ALLOWED_FOR_PLAN` for the Economy plan, 400 `COUPON_PAYMENT_METHOD` when the order's\n * coupon excludes card, 400 `PAYMENT_METHOD_UNAVAILABLE` when card payments are not available,\n * 402 `CARD_DECLINED` when the bank refuses the charge, 409 `ORDER_NOT_PAYABLE` while a PIX payment of\n * the order is being confirmed, and 429 `RATE_LIMIT_EXCEEDED` while another payment of the account is\n * being started.\n */\nexport type RESTPostAPIOrderCardPaymentResponse = APIPayload<APIOrderCardPayment>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/v1.d.ts

@@ -3,11 +3,12 @@ export { APIActivity, ActivityOrigin, ActivityStatus, ActivityTargetType } from
 export { APIApiKey, APIApiKeyCreated, APIApiKeyPreset, APIApiKeyRoute, APIApiKeyRouteMethod, APIApiKeyScope, APIApiKeyScopeEntry, API_KEY_MAX_ALLOWED_IPS, API_KEY_MAX_PER_USER, API_KEY_NAME_MAX_LENGTH, API_KEY_SCOPES, API_KEY_SCOPE_LIST, apiKeyPresetScopes } from './payloads/v1/api-key.js';
 export { APIErrorCode, API_ERROR_CODES } from './payloads/v1/api-error.js';
 export { APIApplication, APIApplicationConfig, APIApplicationCustomDomain, APIApplicationDeployment, APIApplicationDnsRecord, APIApplicationEnvironment, APIApplicationFile, APIApplicationFileContent, APIApplicationFileTree, APIApplicationFileUpload, APIApplicationGithub, APIApplicationMetric, APIApplicationNetwork, APIApplicationOperationResponse, APIApplicationRealtimeEvent, APIApplicationRuntime, APIApplicationRuntimes, APIApplicationScanSuggestions, APIApplicationShieldCooldown, APIApplicationStatus, APIApplicationStatusShort, APIApplicationSubdomain, APIApplicationWebPublish, APIApplicationWebhook, APIApplicationWebhookUrl, ApplicationCluster, ApplicationDnsRecordStatus, ApplicationDnsRecordType, ApplicationFileContentType, ApplicationFileType, ApplicationLanguage, ApplicationRealtimeEventType, ApplicationStatus, ApplicationType, ApplicationVersion, ShieldIncidentDirection, ShieldIncidentReason } from './payloads/v1/application.js';
+export { APIBillingAddress, APIBillingCard, APIBillingDetails, APIBillingRenewal, APIBillingTaxId, BillingTaxIdType } from './payloads/v1/billing.js';
 export { APIDatabase, APIDatabaseCertificate, APIDatabaseMetrics, APIDatabaseNetwork, APIDatabaseOperationResponse, APIDatabasePasswordReset, APIDatabaseStatus, APIDatabaseStatusShort, DatabaseCluster, DatabaseStatus, DatabaseType } from './payloads/v1/database.js';
 export { APIDatabaseCollection, APIDatabaseColumn, APIDatabaseColumnReference, APIDatabaseDataError, APIDatabaseDataOverview, APIDatabaseDocumentListParams, APIDatabaseDocumentsPage, APIDatabaseIndex, APIDatabaseListParams, APIDatabaseMongoIndex, APIDatabaseQueryResult, APIDatabaseRedisInfo, APIDatabaseRedisKey, APIDatabaseRedisKeyValue, APIDatabaseRedisKeysPage, APIDatabaseRedisScanParams, APIDatabaseRedisZSetMember, APIDatabaseRowFilter, APIDatabaseRowsPage, APIDatabaseSchema, APIDatabaseTable, DatabaseFilterOperator, DatabaseRedisKeyType, DatabaseSortDirection, DatabaseTableKind } from './payloads/v1/database-data.js';
 export { APINotification, LocalizedContent, NotificationImportance, NotificationType } from './payloads/v1/notification.js';
 export { APIOAuthClient, APIOAuthCodeChallengeMethod, APIOAuthConsentDecision } from './payloads/v1/oauth.js';
-export { APIOrderCreateResponse, APIOrderDiscount, APIOrderListItem, APIOrderPixPayment, APIOrderStatus, OrderProvider, OrderStatus, OrderType } from './payloads/v1/orders.js';
+export { APIOrderCardPayment, APIOrderCouponPreview, APIOrderCreateResponse, APIOrderDiscount, APIOrderListItem, APIOrderPixPayment, APIOrderReceipt, APIOrderStatus, OrderCardPaymentStatus, OrderProvider, OrderStatus, OrderType } from './payloads/v1/orders.js';
 export { APIRedeemResponse } from './payloads/v1/redeem.js';
 export { APIGroupedResourceSnapshots, APIResourceSnapshot, APISnapshotRestoreResponse, ResourceType, SnapshotResourceType, SnapshotScope } from './payloads/v1/snapshot.js';
 export { APIStatus, StatusType } from './payloads/v1/status.js';
@@ -16,11 +17,12 @@ export { APIWorkspace, APIWorkspaceActionRequest, APIWorkspaceFavorite, APIWorks
 export { RESTGetAPIActivitiesQuery, RESTGetAPIActivitiesResponse } from './rest/v1/activity.js';
 export { RESTDeleteAPIUserApiKeyResponse, RESTGetAPIUserApiKeysResponse, RESTPatchAPIUserApiKeyBody, RESTPatchAPIUserApiKeyResponse, RESTPostAPIUserApiKeyCreateBody, RESTPostAPIUserApiKeyCreateResponse, RESTPostAPIUserApiKeyRotateResponse } from './rest/v1/api-key.js';
 export { RESTDeleteAPIApplicationCustomDomainResponse, RESTDeleteAPIApplicationEnvironmentResponse, RESTDeleteAPIApplicationFileBody, RESTDeleteAPIApplicationFileResponse, RESTDeleteAPIApplicationResponse, RESTDeleteAPIApplicationWebPublishResponse, RESTDeleteAPIApplicationWebhookResponse, RESTGetAPIApplicationCustomDomainResponse, RESTGetAPIApplicationDeploymentsResponse, RESTGetAPIApplicationDnsRecordsResponse, RESTGetAPIApplicationDownloadResponse, RESTGetAPIApplicationEnvironmentResponse, RESTGetAPIApplicationFileContentQuery, RESTGetAPIApplicationFileContentResponse, RESTGetAPIApplicationFileTreeResponse, RESTGetAPIApplicationFilesQuery, RESTGetAPIApplicationFilesResponse, RESTGetAPIApplicationLogsResponse, RESTGetAPIApplicationMetricsQuery, RESTGetAPIApplicationMetricsResponse, RESTGetAPIApplicationRealtimeQuery, RESTGetAPIApplicationRealtimeResponse, RESTGetAPIApplicationResponse, RESTGetAPIApplicationRuntimesResponse, RESTGetAPIApplicationStatusResponse, RESTGetAPIApplicationStatusShortResponse, RESTGetAPIApplicationWebhookUrlResponse, RESTPatchAPIApplicationFileMoveBody, RESTPatchAPIApplicationFileMoveResponse, RESTPatchAPIApplicationSubdomainBody, RESTPatchAPIApplicationSubdomainResponse, RESTPatchAPIApplicationUpdateConfigBody, RESTPatchAPIApplicationUpdateConfigResponse, RESTPostAPIApplicationCreateBody, RESTPostAPIApplicationCreateResponse, RESTPostAPIApplicationCustomDomainBody, RESTPostAPIApplicationCustomDomainResponse, RESTPostAPIApplicationEnvironmentBody, RESTPostAPIApplicationEnvironmentResponse, RESTPostAPIApplicationEnvironmentVariableBody, RESTPostAPIApplicationFileUploadQuery, RESTPostAPIApplicationFileUploadResponse, RESTPostAPIApplicationPurgeCacheBody, RESTPostAPIApplicationPurgeCacheResponse, RESTPostAPIApplicationRestartBody, RESTPostAPIApplicationRestartResponse, RESTPostAPIApplicationScanBody, RESTPostAPIApplicationScanResponse, RESTPostAPIApplicationStartResponse, RESTPostAPIApplicationStopResponse, RESTPostAPIApplicationWebPublishBody, RESTPostAPIApplicationWebPublishResponse, RESTPostAPIApplicationWebhookCreateBody, RESTPostAPIApplicationWebhookCreateResponse, RESTPutAPIApplicationFileBody, RESTPutAPIApplicationFileResponse } from './rest/v1/application.js';
+export { RESTDeleteAPIBillingCardResponse, RESTGetAPIBillingCardsResponse, RESTGetAPIBillingDetailsResponse, RESTGetAPIBillingRenewalResponse, RESTPatchAPIBillingRenewalBody, RESTPatchAPIBillingRenewalResponse, RESTPostAPIBillingCardDefaultResponse, RESTPostAPIBillingCardSetupResponse, RESTPutAPIBillingDetailsBody, RESTPutAPIBillingDetailsResponse } from './rest/v1/billing.js';
 export { RESTDeleteAPIDatabaseResponse, RESTGetAPIDatabaseCertificateResponse, RESTGetAPIDatabaseMetricsResponse, RESTGetAPIDatabaseResponse, RESTGetAPIDatabaseStatusResponse, RESTGetAPIDatabaseStatusShortResponse, RESTPostAPIDatabaseCreateBody, RESTPostAPIDatabaseCreateResponse, RESTPostAPIDatabaseResetCertificateResponse, RESTPostAPIDatabaseResetPasswordResponse, RESTPostAPIDatabaseResetResponse, RESTPostAPIDatabaseStartResponse, RESTPostAPIDatabaseStopResponse, RESTPutAPIDatabaseUpdateBody, RESTPutAPIDatabaseUpdateResponse } from './rest/v1/database.js';
 export { RESTDeleteAPIDatabaseDocumentsBody, RESTDeleteAPIDatabaseRedisKeysBody, RESTDeleteAPIDatabaseRowsBody, RESTGetAPIDatabaseCollectionIndexesResult, RESTGetAPIDatabaseCollectionsResult, RESTGetAPIDatabaseDataOverviewResult, RESTGetAPIDatabaseDocumentsResult, RESTGetAPIDatabaseRedisInfoResult, RESTGetAPIDatabaseRedisKeyValueResult, RESTGetAPIDatabaseRedisKeysResult, RESTGetAPIDatabaseSchemasResult, RESTGetAPIDatabaseTableColumnsResult, RESTGetAPIDatabaseTableRowsResult, RESTGetAPIDatabaseTablesResult, RESTMutateAPIDatabaseDocumentsResult, RESTMutateAPIDatabaseRedisKeysResult, RESTMutateAPIDatabaseRowsResult, RESTPostAPIDatabaseDocumentCreateBody, RESTPostAPIDatabaseQueryBody, RESTPostAPIDatabaseQueryResult, RESTPostAPIDatabaseRowCreateBody, RESTPutAPIDatabaseDocumentUpdateBody, RESTPutAPIDatabaseRedisKeyBody, RESTPutAPIDatabaseRedisKeyExpireBody, RESTPutAPIDatabaseRowUpdateBody } from './rest/v1/database-data.js';
 export { RESTGetAPINotificationsResponse } from './rest/v1/notification.js';
 export { RESTGetAPIOAuthClientResponse, RESTPostAPIOAuthConsentBody, RESTPostAPIOAuthConsentResponse, RESTPostAPIOAuthRegisterBody, RESTPostAPIOAuthRegisterResponse, RESTPostAPIOAuthTokenBody, RESTPostAPIOAuthTokenResponse } from './rest/v1/oauth.js';
-export { RESTGetAPIOrderListQuery, RESTGetAPIOrderListResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCreateBody, RESTPostAPIOrderCreateResponse, RESTPostAPIOrderPixPaymentResponse } from './rest/v1/orders.js';
+export { RESTGetAPIOrderListQuery, RESTGetAPIOrderListResponse, RESTGetAPIOrderReceiptResponse, RESTGetAPIOrderStatusResponse, RESTPostAPIOrderCardPaymentBody, RESTPostAPIOrderCardPaymentResponse, RESTPostAPIOrderCouponPreviewBody, RESTPostAPIOrderCouponPreviewResponse, RESTPostAPIOrderCreateBody, RESTPostAPIOrderCreateResponse, RESTPostAPIOrderPixPaymentResponse } from './rest/v1/orders.js';
 export { RESTPostAPIRedeemResponse } from './rest/v1/redeem.js';
 export { RESTGetAPIGroupedSnapshotsQuery, RESTGetAPIGroupedSnapshotsResponse, RESTGetAPISnapshotDownloadQuery, RESTGetAPISnapshotDownloadResponse, RESTGetAPISnapshotsQuery, RESTGetAPISnapshotsResponse, RESTPostAPISnapshotCreateQuery, RESTPostAPISnapshotCreateResponse, RESTPostAPISnapshotRestoreBody, RESTPostAPISnapshotRestoreQuery, RESTPostAPISnapshotRestoreResponse } from './rest/v1/snapshot.js';
 export { RESTGetAPIStatusResponse } from './rest/v1/status.js';