@isnap/sdk 2.2.0-next.226 → 2.2.0-next.228

package/dist/generated/openapi.d.ts

@@ -1056,9 +1056,9 @@ export interface paths {
          * Reserve a line
          * @description Reserves one `available` line for your account for 15 minutes, and returns it with `status: reserved`, `expires_at` set and its full phone number. Accepts an API key; any account can reserve. A reserved line is not billed and cannot send.
          *
-         *     Within the 15 minutes, a wholesale partner activates it with `POST /v1/lines/{id}/activate`. For any other account, no operation that an API key can call activates it. After `expires_at`, the line returns to `available` with no owner.
+         *     Within the 15 minutes, a wholesale partner activates it with `POST /v1/lines/{id}/activate`. For any other account, no operation that an API key can call activates the line or pays for it. Once a payment of the line has started, `expires_at` is 24 hours after the start of that payment, and the line becomes `active` when the payment succeeds. The line returns to `available` with no owner after `expires_at`, or earlier when a started payment has not succeeded after 23 hours.
          *
-         *     A reservation cannot be extended: reserving a line that you have already reserved returns `409 conflict`. The API sets no limit on the number of lines that an account has reserved at the same time. The `metadata` of the line is left as it is. This operation sends no event, and neither does the end of a reservation.
+         *     Reserving a line that you have already reserved returns `409 conflict` and does not extend the reservation. The API sets no limit on the number of lines that an account has reserved at the same time. The `metadata` of the line is left as it is. This operation sends no event, and neither does the end of a reservation.
          */
         post: {
             parameters: {
@@ -2380,7 +2380,7 @@ export interface paths {
         put?: never;
         /**
          * Release a reserved line
-         * @description Gives back a line that you have reserved: it returns to `available` immediately and no longer belongs to your account. Accepts an API key. Any other line returns `404 not_found`, an `active` line included: to end a line you use, call `POST /v1/lines/{id}/terminate` or `POST /v1/lines/{id}/cancel`. A release changes no billing and leaves the `metadata` of the line as it is. This operation sends no event.
+         * @description Gives back a line that you have reserved: it returns to `available` immediately and no longer belongs to your account. Accepts an API key. Any other line returns `404 not_found`, an `active` line included: to end a line you use, call `POST /v1/lines/{id}/terminate` or `POST /v1/lines/{id}/cancel`. A release cancels the unpaid subscription of a payment that was started for the line, unless that payment has been submitted. A payment that succeeds after the release activates no line: iSnap cancels its subscription and records the charge as a refund owed to the account. A release changes no other billing and leaves the `metadata` of the line as it is. This operation sends no event.
          */
         post: {
             parameters: {
@@ -2972,7 +2972,7 @@ export interface paths {
             parameters: {
                 query?: {
                     /** @description Keep the pre-orders in this status. */
-                    status?: "draft" | "provisioning" | "fulfilled" | "cancelled";
+                    status?: "draft" | "awaiting_payment" | "provisioning" | "fulfilled" | "cancelled";
                     /** @description The `next_cursor` of the previous page. Omit it for the first page. An unreadable cursor restarts from the first page, without an error. */
                     cursor?: string;
                     /** @description Number of pre-orders per page, from 1 to 100. Default: 25. */
@@ -3036,7 +3036,7 @@ export interface paths {
          * Create a pre-order
          * @description Creates a draft pre-order for one rented iMessage line. Accepts an API key. A line-scoped key is not limited to its list on this operation. A draft has no effect: it creates no line, takes no payment, and never expires. Call `POST /v1/pre-orders/{id}/confirm` to commit it. There is no limit on the number of drafts. `Idempotency-Key` is ignored: a repeated call creates another draft. Creating a draft sends no event.
          *
-         *     `preferred_area_codes` lists up to 5 area codes in order of preference, and `inbound_only` chooses between an inbound-only line and a two-way line. `billing_tier`, when sent, must be `rental_iphone`: `rental_android` returns `400 android_rental_not_purchasable`, and the four other values return `400 tier_not_pre_orderable`. `billing_anchor_at` is stored on the pre-order and carried onto the line at confirmation: a value more than 31 days after the call returns `400 billing_anchor_too_far`, and the confirmation does not check it again. A key that is not listed, `quantity` included, returns `400 validation_failed`: one pre-order is one line.
+         *     `preferred_area_codes` lists up to 5 area codes in order of preference, and `inbound_only` chooses between an inbound-only line and a two-way line. `billing_tier`, when sent, must be `rental_iphone`: `rental_android` returns `400 android_rental_not_purchasable`, and the four other values return `400 tier_not_pre_orderable`. `billing_anchor_at` is stored on the pre-order and carried onto the line when the line is created: a value more than 31 days after the call returns `400 billing_anchor_too_far`, and it is not checked again. A key that is not listed, `quantity` included, returns `400 validation_failed`: one pre-order is one line.
          */
         post: {
             parameters: {
@@ -3162,11 +3162,17 @@ export interface paths {
         put?: never;
         /**
          * Confirm a pre-order
-         * @description Commits a draft pre-order. Accepts an API key. A line-scoped key is not limited to its list on this operation: it can confirm any draft of the account. The call sets `status` to `provisioning` and `estimated_fulfillment` to the time of the call plus 72 hours, and creates on your account a rented iMessage line with `status: provisioning`, with the `inbound_only` and the `billing_anchor_at` of the pre-order. When a number in one of your area codes is in stock, it is assigned to the line immediately. The confirmation sends no event: iSnap sends `pre_order.fulfilled`, which carries the `line_id`, when the line is handed over.
+         * @description Commits a draft pre-order. Accepts an API key. A line-scoped key is not limited to its list on this operation: it can confirm any draft of the account. The confirmation sends no event: iSnap sends `pre_order.fulfilled`, which carries the `line_id`, when the line is handed over.
          *
-         *     A wholesale partner pays nothing at confirmation: `stripe_client_secret` is `null`, and the line is billed on the monthly invoice from the day it is handed over. For a direct account, confirm starts a monthly subscription and returns `stripe_client_secret`, a client secret that your payment page passes to the payment form of Stripe to collect the first month. The line is created whether or not that payment completes. The secret is returned in this response only and confirm cannot be repeated: store the secret before anything else.
+         *     The build of a pre-order sets `status` to `provisioning` and `estimated_fulfillment` to the time the build starts plus 72 hours, and creates on your account a rented iMessage line with `status: provisioning`, with the `inbound_only` and the `billing_anchor_at` of the pre-order. When a number is in stock in one of your area codes, in their order of preference, it is assigned to the line when the build starts. A pre-order with no `preferred_area_codes` takes any number in stock.
          *
-         *     Only a draft can be confirmed: any other pre-order returns `400 pre_order_not_draft`, and a confirmation that runs at the same time as another confirmation or as a cancellation returns `409 pre_order_not_draft`. A confirmed pre-order cannot be canceled through the API.
+         *     For a wholesale partner the build starts with the confirmation. A wholesale partner pays nothing at confirmation: `stripe_client_secret` is `null`, and the line is billed on the monthly invoice from the day it is handed over.
+         *
+         *     For a direct account the build starts when the first month is paid. Confirm starts a monthly subscription, sets `status` to `awaiting_payment` and returns `stripe_client_secret`, a client secret that your payment page passes to the payment form of Stripe to collect the first month. Only card payments are accepted. Until that payment succeeds, no line is created and `estimated_fulfillment` is `null`. After paying, read the pre-order with `GET /v1/pre-orders/{id}` until `status` is `provisioning`. When the first month is not paid within 23 hours of the confirmation, `status` becomes `cancelled` and iSnap sends `pre_order.cancelled`. When a credit balance of the account at Stripe covers the first month, there is nothing to pay: the build starts with the confirmation and `stripe_client_secret` is `null`. The first month starts at the confirmation, not when the line is handed over, and the next invoice is issued one month after the confirmation. The hand-over of the line takes no payment and does not change when the subscription is invoiced.
+         *
+         *     Confirm can be repeated while `status` is `awaiting_payment`: it returns the same client secret and starts no second subscription. Repeated after the payment succeeded, it returns the pre-order in `provisioning`.
+         *
+         *     Any other pre-order returns `400 pre_order_not_draft`, including one that was canceled because its first month was not paid in time. A confirmation that runs at the same time as a cancellation, or for a wholesale partner as another confirmation, returns `409 pre_order_not_draft`. When Stripe cannot be reached, the call returns `503 payment_provider_unavailable`: nothing changed, and the call can be repeated. When Stripe refuses the request for the account, the call returns `409 payment_setup_failed`: nothing changed, and repeating the call does not help. Once its build has started, a pre-order cannot be canceled through the API.
          */
         post: {
             parameters: {
@@ -3180,7 +3186,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description The pre-order, in status `provisioning`. */
+                /** @description The pre-order: in status `awaiting_payment` with its `stripe_client_secret` for a direct account whose first month is due, in status `provisioning` otherwise. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -3200,7 +3206,7 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. It is `pre_order_not_draft` when the pre-order is not a draft. */
+                /** @description Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. It is `pre_order_not_draft` when the pre-order is neither a draft nor in `awaiting_payment`, except a pre-order in `provisioning` whose first month was paid, which a repeated confirm returns. */
                 400: {
                     headers: {
                         [name: string]: unknown;
@@ -3227,6 +3233,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Conflict. `error.code` is `pre_order_not_draft` when a cancellation, or for a wholesale partner another confirmation, ran at the same time and won. It is `payment_setup_failed` when Stripe refused the request for the account: repeating the call does not help. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. */
                 429: {
                     headers: {
@@ -3245,6 +3260,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Service unavailable. `error.code` is `payment_provider_unavailable`: Stripe could not be reached. Nothing changed, and the call can be repeated. */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
             };
         };
         delete?: never;
@@ -3262,7 +3286,7 @@ export interface paths {
         };
         /**
          * Get a pre-order
-         * @description Returns one pre-order of the account. Accepts an API key. A line-scoped key is not limited to its list on this operation. A pre-order carries no line id: the line it produces is announced by `pre_order.fulfilled`, which carries the `line_id`. `stripe_client_secret` is `null` here. A pre-order of another account, or an unknown id, returns `404 not_found`.
+         * @description Returns one pre-order of the account. Accepts an API key. A line-scoped key is not limited to its list on this operation. A pre-order carries no line id: the line it produces is announced by `pre_order.fulfilled`, which carries the `line_id`. `stripe_client_secret` is `null` here. Reading a pre-order in status `awaiting_payment` checks its first-month payment with Stripe: when that payment has succeeded, the build starts and the pre-order is returned in `provisioning`. When Stripe cannot be reached, the read still answers, with the pre-order in `awaiting_payment`. A pre-order of another account, or an unknown id, returns `404 not_found`.
          */
         get: {
             parameters: {
@@ -3448,7 +3472,7 @@ export interface paths {
         put?: never;
         /**
          * Cancel a pre-order
-         * @description Cancels a draft pre-order: nothing was created and nothing was charged. Accepts an API key. A line-scoped key is not limited to its list on this operation. Sets `status` to `cancelled` and sends `pre_order.cancelled`. Only a draft can be canceled: a pre-order that is confirmed, fulfilled or already canceled returns `400 pre_order_already_confirmed`, and a cancellation that runs at the same time as a confirmation or as another cancellation returns `409 pre_order_already_confirmed`. A confirmed pre-order cannot be canceled through the API.
+         * @description Cancels a pre-order in status `draft` or `awaiting_payment`: nothing was created and nothing was charged. Accepts an API key. A line-scoped key is not limited to its list on this operation. Sets `status` to `cancelled` and sends `pre_order.cancelled`. For a pre-order in `awaiting_payment`, the first-month payment is canceled first: the client secret returned by confirm can no longer be used. When that first month is already paid, the call returns `409 pre_order_already_paid` and the build goes on. A pre-order that is `provisioning`, `fulfilled` or already `cancelled` returns `400 pre_order_already_confirmed`, and the cancellation of a draft that runs at the same time as another cancellation, or as the confirmation of a wholesale partner, returns `409 pre_order_already_confirmed`. When Stripe cannot be reached, the call returns `503 payment_provider_unavailable`: nothing changed, and the call can be repeated. When Stripe refuses the request for the account, the call returns `409 payment_setup_failed`: nothing changed, and repeating the call does not help. Once its build has started, a pre-order cannot be canceled through the API.
          */
         post: {
             parameters: {
@@ -3482,7 +3506,7 @@ export interface paths {
                         };
                     };
                 };
-                /** @description Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. It is `pre_order_already_confirmed` when the pre-order is not a draft: it is confirmed, fulfilled or already canceled. */
+                /** @description Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. It is `pre_order_already_confirmed` when the pre-order is `provisioning`, `fulfilled` or already `cancelled`. */
                 400: {
                     headers: {
                         [name: string]: unknown;
@@ -3509,7 +3533,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
-                /** @description Conflict. `error.code` is `pre_order_already_confirmed`: a confirmation or another cancellation of the same pre-order ran at the same time and won. */
+                /** @description Conflict. `error.code` is `pre_order_already_paid` when the first month is already paid. It is `pre_order_already_confirmed` when a confirmation or another cancellation of the same draft ran at the same time and won. It is `payment_setup_failed` when Stripe refused the request for the account: repeating the call does not help. */
                 409: {
                     headers: {
                         [name: string]: unknown;
@@ -3536,6 +3560,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Service unavailable. `error.code` is `payment_provider_unavailable`: Stripe could not be reached. Nothing changed, and the call can be repeated. */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
             };
         };
         delete?: never;
@@ -3555,7 +3588,11 @@ export interface paths {
         put?: never;
         /**
          * Start the payment of a reserved line
-         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Creates a payment page for a rented line that the account reserved with `POST /v1/lines/{id}/reserve`, and returns its URL. The line is activated when the payment completes. Only a rented line in status `reserved` can be paid for here. The response is not wrapped in the standard envelope.
+         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Creates the per-line subscription of a rented line that the account reserved with `POST /v1/lines/{id}/reserve`, and returns `client_secret`, the client secret of its first payment, for the payment form of Stripe. Only a rented line in status `reserved` can be paid for here. A wholesale partner gets `403 wholesale_partner_no_checkout`.
+         *
+         *     The line becomes `active` when the first payment succeeds, and stays `reserved` until then. The call moves the `expires_at` of the line to 24 hours after the creation of the subscription. A subscription whose first payment has not succeeded 23 hours after its creation ends, and the line returns to `available`. A payment that succeeds for a line that the account no longer has reserved activates no line: iSnap cancels the subscription and records the charge as a refund owed to the account. No operation of this API makes that refund.
+         *
+         *     A reserved line has at most one unpaid subscription. A repeated call with the same `inbound_only` returns the same `subscription_id` and `client_secret`. A call with the other value of `inbound_only` cancels the unpaid subscription and creates another one. Once the first payment of a subscription of the reservation has been submitted, and until the line is `active`, every call returns `409 purchase_payment_in_progress`, whatever `inbound_only` it sends, and cancels or creates nothing: read the line with `GET /v1/lines/{id}` until it is `active`. A canceled unpaid subscription can no longer be paid. `POST /v1/lines/{id}/release` cancels the unpaid subscription.
          */
         post: {
             parameters: {
@@ -3581,13 +3618,13 @@ export interface paths {
                 };
             };
             responses: {
-                /** @description The URL of the payment page. */
+                /** @description The subscription and the client secret of its first payment. */
                 200: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["Checkout"];
+                        "application/json": components["schemas"]["CheckoutEnvelope"];
                     };
                 };
                 /** @description Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. It is `bad_request` when the line is not in status `reserved`, `tier_not_checkoutable` when the line is not a rented line, and `android_rental_not_purchasable` for an Android line. */
@@ -3608,6 +3645,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Refused. `error.code` is `wholesale_partner_no_checkout` when the account is a wholesale partner. It is `forbidden` when the request carries no header `X-Requested-With: XMLHttpRequest`. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description Not found. `error.code` is `not_found`: the account reserved no line with this id. */
                 404: {
                     headers: {
@@ -3617,6 +3663,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Conflict. `error.code` is `line_not_reserved` when the reservation of the line has ended. It is `purchase_payment_in_progress` when the first payment of a subscription of the reservation has been submitted and the line is not `active` yet: nothing is canceled or created. It is `purchase_in_progress` when the request has waited 10 seconds for another request that starts a payment for the same account: resend the request. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. */
                 429: {
                     headers: {
@@ -3626,7 +3681,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
-                /** @description Unexpected failure. `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
+                /** @description Unexpected failure. `error.code` is `stripe_payment_not_started` when Stripe returned no payment to confirm: nothing was charged, and the call can be made again. In any other case `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
                 500: {
                     headers: {
                         [name: string]: unknown;
@@ -3654,7 +3709,11 @@ export interface paths {
         put?: never;
         /**
          * Start the payment of BYOD slots
-         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Creates a payment page for a subscription to `device_count` BYOD slots, with the billing period chosen in `billing_cycle`, and returns its URL and its expiry. Each slot allows one BYOD line: `POST /v1/byod/pair` needs a free slot. The customer can change the number of slots on the payment page, from 1 to 50.
+         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Creates a subscription to `device_count` BYOD slots, with the billing period chosen in `billing_cycle`, and returns `client_secret`, the client secret of its first payment, for the payment form of Stripe, with the recurring total for that number of slots. Each slot allows one BYOD line: `POST /v1/byod/pair` needs a free slot. A wholesale partner gets `403 wholesale_partner_no_checkout`.
+         *
+         *     The slots are available when the first payment succeeds. A subscription whose first payment has not succeeded 23 hours after its creation ends without providing a slot.
+         *
+         *     An account has at most one unpaid subscription to BYOD slots. A repeated call with the same `device_count` and `billing_cycle` returns the same `subscription_id` and `client_secret`. A call with another `device_count` or `billing_cycle` cancels the unpaid subscription and creates another one. Once the first payment of a subscription to BYOD slots has been submitted, every call returns `409 purchase_payment_in_progress` and cancels or creates nothing, until `byod_slots.paid` in `GET /v1/billing/coverage` counts its slots and for one hour at most after that payment succeeded. After that, a call creates another subscription. A canceled unpaid subscription can no longer be paid. `DELETE /v1/billing/subscriptions/{id}` cancels an unpaid subscription immediately.
          */
         post: {
             parameters: {
@@ -3669,7 +3728,7 @@ export interface paths {
                 };
             };
             responses: {
-                /** @description The URL of the payment page and its expiry. */
+                /** @description The subscription, the client secret of its first payment and the recurring total. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -3696,6 +3755,24 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Refused. `error.code` is `wholesale_partner_no_checkout` when the account is a wholesale partner. It is `forbidden` when the request carries no header `X-Requested-With: XMLHttpRequest`. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Conflict. `error.code` is `purchase_payment_in_progress` when the first payment of a subscription to the same product has been submitted and what it buys is not counted yet in `GET /v1/billing/coverage`, for one hour at most after that payment succeeded: nothing is canceled or created. It is `purchase_in_progress` when the request has waited 10 seconds for another request that starts a payment for the same account: resend the request. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. */
                 429: {
                     headers: {
@@ -3705,7 +3782,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
-                /** @description Unexpected failure. `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
+                /** @description Unexpected failure. `error.code` is `stripe_payment_not_started` when Stripe returned no payment to confirm: nothing was charged, and the call can be made again. In any other case `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
                 500: {
                     headers: {
                         [name: string]: unknown;
@@ -3733,7 +3810,13 @@ export interface paths {
         put?: never;
         /**
          * Start the payment of hosted macOS sessions
-         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Creates a payment page for a subscription to `quantity` hosted macOS sessions, with the billing period chosen in `billing_cycle`, and returns its URL, its expiry and an estimate of the recurring total. `quantity` must be a whole number of packs, and at least one pack: otherwise the call returns `422 mac_quantity_not_a_pack`, with the size of a pack in `error.issues[0].min`. The account cannot hold more hosted macOS sessions than BYOD lines: otherwise the call returns `422 mac_sessions_exceed_byop_lines`. The quantity cannot be changed on the payment page: change it later with `PATCH /v1/billing/subscriptions/{id}`.
+         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Creates a subscription to `quantity` hosted macOS sessions, with the billing period chosen in `billing_cycle`, and returns `client_secret`, the client secret of its first payment, for the payment form of Stripe, with an estimate of the recurring total. `GET /v1/billing/mac-quote` returns the same estimate and creates nothing. A wholesale partner gets `403 wholesale_partner_no_checkout`.
+         *
+         *     `quantity` must be a whole number of packs, and at least one pack: otherwise the call returns `422 mac_quantity_not_a_pack`, with the size of a pack in `error.issues[0].min`. The account cannot hold more hosted macOS sessions than BYOD lines: otherwise the call returns `422 mac_sessions_exceed_byop_lines`. The sessions of an unpaid subscription count in that comparison for 24 hours at most.
+         *
+         *     The sessions are available when the first payment succeeds. A subscription whose first payment has not succeeded 23 hours after its creation ends without providing a session.
+         *
+         *     An account has at most one unpaid subscription to hosted macOS sessions. A repeated call with the same `quantity` and `billing_cycle` returns the same `subscription_id` and `client_secret`. A call with another `quantity` or `billing_cycle` cancels the unpaid subscription and creates another one. Once the first payment of a subscription to hosted macOS sessions has been submitted, every call returns `409 purchase_payment_in_progress` and cancels or creates nothing, until `mac_sessions.paid` in `GET /v1/billing/coverage` counts its sessions and for one hour at most after that payment succeeded. After that, a call creates another subscription. A canceled unpaid subscription can no longer be paid. `DELETE /v1/billing/subscriptions/{id}` cancels an unpaid subscription immediately. To change the quantity of a subscription whose first payment succeeded, call `PATCH /v1/billing/subscriptions/{id}`.
          */
         post: {
             parameters: {
@@ -3748,7 +3831,7 @@ export interface paths {
                 };
             };
             responses: {
-                /** @description The URL of the payment page, its expiry and the estimated total. */
+                /** @description The subscription, the client secret of its first payment and the estimated total. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -3775,6 +3858,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Refused. `error.code` is `wholesale_partner_no_checkout` when the account is a wholesale partner. It is `forbidden` when the request carries no header `X-Requested-With: XMLHttpRequest`. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description Not found. `error.code` is `not_found`: the account of the session no longer exists. */
                 404: {
                     headers: {
@@ -3784,6 +3876,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Conflict. `error.code` is `purchase_payment_in_progress` when the first payment of a subscription to the same product has been submitted and what it buys is not counted yet in `GET /v1/billing/coverage`, for one hour at most after that payment succeeded: nothing is canceled or created. It is `purchase_in_progress` when the request has waited 10 seconds for another request that starts a payment for the same account: resend the request. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description The request breaks a rule of this operation. `error.code` is `mac_quantity_not_a_pack` when `quantity` is not a whole number of packs or is below one pack. It is `mac_sessions_exceed_byop_lines` when the account would hold more hosted macOS sessions than BYOD lines. */
                 422: {
                     headers: {
@@ -3802,6 +3903,168 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Unexpected failure. `error.code` is `stripe_payment_not_started` when Stripe returned no payment to confirm: nothing was charged, and the call can be made again. `error.code` is `mac_pack_size_unconfigured` or `mac_price_not_graduated` when the price of hosted macOS sessions is misconfigured. In any other case `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/billing/mac-quote": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a quote for hosted macOS sessions
+         * @description Dashboard session only: an API key is refused with `401`. Returns the price tiers of hosted macOS sessions for the billing period chosen in `billing_cycle`, and `estimated_total_cents`, the recurring total for `quantity` sessions. Each tier prices only the sessions that fall inside it. `quantity` must be a whole number of packs, and at least one pack: otherwise the call returns `422 mac_quantity_not_a_pack`, with the size of a pack in `error.issues[0].min`. The call creates nothing and does not compare `quantity` with the number of BYOD lines of the account.
+         */
+        get: {
+            parameters: {
+                query: {
+                    /** @description Number of hosted macOS sessions to price: a whole number of packs, and at least one pack. The size of a pack is returned as `pack_size`, and as `error.issues[0].min` of the `422 mac_quantity_not_a_pack` refusal. */
+                    quantity?: number | null;
+                    /** @description Billing period to price: `monthly`, `quarterly` or `annual`. */
+                    billing_cycle: "monthly" | "quarterly" | "annual";
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description The price tiers and the estimated total. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["MacQuoteEnvelope"];
+                    };
+                };
+                /** @description Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description No valid credential. `error.code` is `unauthorized`. */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description The request breaks a rule of this operation. `error.code` is `mac_quantity_not_a_pack`: `quantity` is not a whole number of packs or is below one pack. */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Unexpected failure. `error.code` is `mac_pack_size_unconfigured` or `mac_price_not_graduated` when the price of hosted macOS sessions is misconfigured. In any other case `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/billing/config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the payment configuration
+         * @description Dashboard session only: an API key is refused with `401`. Returns `publishable_key`, the Stripe publishable key that the payment form of Stripe is loaded with, and `wholesale`, which is `true` for a wholesale partner. A wholesale partner cannot start a payment with this API: for such an account, `publishable_key` is `null` when iSnap has no publishable key to return. Any other account then gets `503 stripe_not_configured`.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description The Stripe publishable key and the type of the account. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["BillingConfigEnvelope"];
+                    };
+                };
+                /** @description Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description No valid credential. `error.code` is `unauthorized`. */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description Unexpected failure. `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
                 500: {
                     headers: {
@@ -3811,8 +4074,94 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Unavailable. `error.code` is `stripe_not_configured`: iSnap has no publishable key to return, and the account is not a wholesale partner. */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
             };
         };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/billing/coverage": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the coverage of the account
+         * @description Dashboard session only: an API key is refused with `401`. Returns the numbers that the purchase and pairing operations compare: the BYOD slots that the account has paid for and the BYOD lines that use them, the hosted macOS sessions that it has paid for and the ones assigned to it, and the sessions of unpaid subscriptions. A subscription counts in `paid` once iSnap has recorded its first payment. The API does not bound the delay between a payment and that record: read this operation until the count changes.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description The coverage of the account. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["BillingCoverageEnvelope"];
+                    };
+                };
+                /** @description Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description No valid credential. `error.code` is `unauthorized`. */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Unexpected failure. `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -3831,7 +4180,9 @@ export interface paths {
         post?: never;
         /**
          * Cancel a subscription
-         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Schedules the subscription of a line to end at the end of the billing period already paid. The line works until then, and `cancel_at_period_end` reads `true` in `GET /v1/billing/subscriptions`. Only the subscription of a line of the account can be canceled here: any other subscription, a subscription to BYOD slots or to hosted macOS sessions included, returns `403 forbidden`. The response is not wrapped in the standard envelope.
+         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Schedules a subscription of the account to end at the end of the billing period already paid: the subscription of a line, a subscription to BYOD slots or a subscription to hosted macOS sessions. The line, the slots or the sessions work until then, and `cancel_at_period_end` reads `true` in `GET /v1/billing/subscriptions`. A subscription to BYOD slots or to hosted macOS sessions whose first payment has not succeeded is canceled immediately instead, and can no longer be paid; when that payment has been submitted, the call returns `409 purchase_payment_in_progress` and cancels nothing.
+         *
+         *     Canceling a subscription to BYOD slots returns `422 byop_reduction_strands_mac_sessions` when the account would hold fewer BYOD slots than hosted macOS sessions at the end of the billing period: cancel the subscription to hosted macOS sessions first. When the subscription to BYOD slots ends, the `active` BYOD lines of the account that its remaining BYOD slots no longer cover take the status `cancelled`, oldest first. A subscription to BYOD slots or to hosted macOS sessions that has already ended returns `409 subscription_already_ended`. Any other subscription, a subscription of another account included, returns `403 forbidden`. The response is not wrapped in the standard envelope.
          */
         delete: {
             parameters: {
@@ -3872,6 +4223,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description Refused. `error.code` is `forbidden`: this operation cannot cancel the subscription, or the subscription belongs to another account, or the request carries no header `X-Requested-With: XMLHttpRequest`. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description Not found. `error.code` is `not_found`: the account has no billing account yet. iSnap creates one when the account starts a payment. */
                 404: {
                     headers: {
@@ -3881,7 +4241,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
-                /** @description Conflict. The resource is not in a state that allows this operation; `error.code` names the reason. */
+                /** @description Conflict. The resource is not in a state that allows this operation; `error.code` names the reason. It is `subscription_already_ended` when a subscription to BYOD slots or to hosted macOS sessions has already ended. It is `purchase_payment_in_progress` when the first payment of an unpaid subscription has been submitted. */
                 409: {
                     headers: {
                         [name: string]: unknown;
@@ -3890,6 +4250,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
+                /** @description The request breaks a rule of this operation. `error.code` is `byop_reduction_strands_mac_sessions`: the account would hold fewer BYOD slots than hosted macOS sessions. */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
                 /** @description Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. */
                 429: {
                     headers: {
@@ -3914,7 +4283,7 @@ export interface paths {
         head?: never;
         /**
          * Change the quantity of a subscription
-         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Sets the quantity of a subscription to hosted macOS sessions, or of a subscription to BYOD slots. A number of hosted macOS sessions must be a whole number of packs (`422 mac_quantity_not_a_pack`) and cannot exceed the number of BYOD lines of the account (`422 mac_sessions_exceed_byop_lines`). A number of BYOD slots cannot fall below the number of hosted macOS sessions that the account holds (`422 byop_reduction_strands_mac_sessions`). Any other subscription, the subscription of a rented line included, returns `409 subscription_not_quantity_adjustable`. A subscription of another account returns `403 forbidden`.
+         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Sets the quantity of a subscription to hosted macOS sessions, or of a subscription to BYOD slots. A number of hosted macOS sessions must be a whole number of packs (`422 mac_quantity_not_a_pack`) and cannot exceed the number of BYOD lines of the account (`422 mac_sessions_exceed_byop_lines`). A number of BYOD slots cannot fall below the number of hosted macOS sessions that the account holds (`422 byop_reduction_strands_mac_sessions`), and cannot be reduced below the number of BYOD lines of the account that are not `cancelled` (`422 byop_reduction_strands_byod_lines`, with that number in `error.issues[0].min`): end BYOD lines first. A subscription that has already ended returns `409 subscription_already_ended`. A subscription whose first payment has not succeeded returns `409 subscription_awaiting_payment`: start the payment again with another quantity instead. Any other subscription, the subscription of a rented line included, returns `409 subscription_not_quantity_adjustable`. A subscription of another account returns `403 forbidden`.
          */
         patch: {
             parameters: {
@@ -3977,7 +4346,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
-                /** @description Conflict. `error.code` is `subscription_not_quantity_adjustable`: the subscription is neither a subscription to hosted macOS sessions nor a subscription to BYOD slots. */
+                /** @description Conflict. `error.code` is `subscription_already_ended` when the subscription has already ended. It is `subscription_awaiting_payment` when the first payment of the subscription has not succeeded. It is `subscription_not_quantity_adjustable` when the subscription is neither a subscription to hosted macOS sessions nor a subscription to BYOD slots. */
                 409: {
                     headers: {
                         [name: string]: unknown;
@@ -3986,7 +4355,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
-                /** @description The request breaks a rule of this operation. `error.code` is `mac_quantity_not_a_pack` when the number of hosted macOS sessions is not a whole number of packs or is below one pack. It is `mac_sessions_exceed_byop_lines` when the account would hold more hosted macOS sessions than BYOD lines. It is `byop_reduction_strands_mac_sessions` when the account would hold fewer BYOD slots than hosted macOS sessions. */
+                /** @description The request breaks a rule of this operation. `error.code` is `mac_quantity_not_a_pack` when the number of hosted macOS sessions is not a whole number of packs or is below one pack. It is `mac_sessions_exceed_byop_lines` when the account would hold more hosted macOS sessions than BYOD lines. It is `byop_reduction_strands_mac_sessions` when the account would hold fewer BYOD slots than hosted macOS sessions. It is `byop_reduction_strands_byod_lines` when a reduction would leave the account with fewer BYOD slots than BYOD lines that are not `cancelled`. */
                 422: {
                     headers: {
                         [name: string]: unknown;
@@ -4004,7 +4373,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorEnvelope"];
                     };
                 };
-                /** @description Unexpected failure. `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
+                /** @description Unexpected failure. `error.code` is `mac_pack_size_unconfigured` or `mac_price_not_graduated` when the price of hosted macOS sessions is misconfigured. In any other case `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. */
                 500: {
                     headers: {
                         [name: string]: unknown;
@@ -4026,7 +4395,7 @@ export interface paths {
         };
         /**
          * List subscriptions
-         * @description Dashboard session only: an API key is refused with `401`. Returns the subscriptions of the account, in every status, ended ones included: the 100 most recent at most, without pagination.
+         * @description Dashboard session only: an API key is refused with `401`. Returns the subscriptions of the account, ended ones included: the 100 most recent at most, without pagination. A subscription whose first payment has not succeeded is returned with `status: incomplete` while it can still be paid. A subscription that expired unpaid, or that an operation of this API canceled while it was unpaid, is not returned.
          */
         get: {
             parameters: {
@@ -4101,7 +4470,7 @@ export interface paths {
         };
         /**
          * List invoices
-         * @description Dashboard session only: an API key is refused with `401`. Returns the invoices of the account, newest first: the 100 most recent at most, without pagination.
+         * @description Dashboard session only: an API key is refused with `401`. Returns the invoices of the account, newest first: the 100 most recent at most, without pagination. The void first invoice of a subscription whose first payment was not made is not returned.
          */
         get: {
             parameters: {
@@ -4176,7 +4545,7 @@ export interface paths {
         };
         /**
          * List payment methods
-         * @description Dashboard session only: an API key is refused with `401`. Returns the cards saved on the account: the brand, the last four digits, the expiry, and which card is the default payment method. The full card number is never returned. Returns `404 not_found` while the account has no billing account.
+         * @description Dashboard session only: an API key is refused with `401`. Returns the cards saved on the account: the brand, the last four digits, the expiry, and which card is the default payment method. The full card number is never returned. An account that has no billing account gets an empty list.
          */
         get: {
             parameters: {
@@ -4237,7 +4606,7 @@ export interface paths {
         put?: never;
         /**
          * Start adding a payment method
-         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Returns `client_secret`, a client secret for the payment form of Stripe: the form saves a new card on the account. The response is not wrapped in the standard envelope. Returns `404 not_found` while the account has no billing account.
+         * @description Dashboard session only: an API key is refused with `401`. The request must carry the header `X-Requested-With: XMLHttpRequest`, or it is refused with `403 forbidden`. Returns `client_secret`, a client secret for the payment form of Stripe: the form saves a new card on the account. Only a card can be saved. The call creates the billing account of an account that has none. The response is not wrapped in the standard envelope.
          */
         post: {
             parameters: {
@@ -8174,7 +8543,7 @@ export interface components {
                     message: string;
                     /** @description Kind of problem. On `validation_failed`, for example `invalid_type`, `invalid_value`, `invalid_format`, `invalid_union`, `invalid_key`, `invalid_element`, `too_small`, `too_big`, `not_multiple_of`, `unrecognized_keys` or `custom`. The list is open: read `path` and `message`. */
                     code: string;
-                    /** @description Smallest accepted value. Present only on `limit_out_of_bounds`, `mac_quantity_not_a_pack` and `byop_reduction_strands_mac_sessions`. */
+                    /** @description Smallest accepted value. Present only on `limit_out_of_bounds`, `mac_quantity_not_a_pack`, `byop_reduction_strands_mac_sessions` and `byop_reduction_strands_byod_lines`. */
                     min?: number;
                     /** @description Largest accepted value. Present only on `limit_out_of_bounds` and `mac_sessions_exceed_byop_lines`, and on the `too_big` issue of an `Idempotency-Key` header longer than 255 characters. */
                     max?: number;
@@ -8811,12 +9180,12 @@ export interface components {
             preferred_area_codes: string[];
             /** @description `true` for an inbound-only line, `false` for a two-way line. */
             inbound_only: boolean;
-            /** @description The billing anchor you set when creating the pre-order, carried onto the line at confirmation. `null` when you set none. */
+            /** @description The billing anchor you set when creating the pre-order, carried onto the line when the line is created. `null` when you set none. */
             billing_anchor_at: string | null;
             status: components["schemas"]["PreOrderStatus"];
-            /** @description Client secret for the payment form of Stripe, to collect the first month. Set only in the response of `POST /v1/pre-orders/{id}/confirm`, for an account that is not a wholesale partner. `null` in every other response. */
+            /** @description Client secret for the payment form of Stripe, to collect the first month. Set only in the response of `POST /v1/pre-orders/{id}/confirm`, when that response carries the pre-order in status `awaiting_payment`: the first time and every time confirm is repeated. `null` in every other response. */
             stripe_client_secret: string | null;
-            /** @description Estimated time of the hand-over of the line: the time of the confirmation plus 72 hours. Set once at confirmation and never revised. `null` until the pre-order is confirmed. */
+            /** @description Estimated time of the hand-over of the line: the time the build starts plus 72 hours. Set once, when the build starts, and never revised. `null` while the pre-order is `draft` or `awaiting_payment`, and on a pre-order canceled before its build started. */
             estimated_fulfillment: string | null;
             device_status?: components["schemas"]["DeviceFulfillmentStatus"];
             /** @description Timestamp of creation, ISO 8601 in UTC. */
@@ -8834,12 +9203,12 @@ export interface components {
             } | null;
         };
         /**
-         * @description `draft`: created, with no effect. `provisioning`: confirmed, and the line is being prepared. `fulfilled`: the line is handed over. `cancelled`: the draft was canceled. A confirmed pre-order never becomes `cancelled`.
+         * @description `draft`: created, with no effect. `awaiting_payment`: confirmed by a direct account, and the first month is due; nothing is built until it is paid. `provisioning`: the build has started, and the line is being prepared. `fulfilled`: the line is handed over. `cancelled`: the pre-order ended with no line. You canceled it, its first month was not paid within 23 hours of the confirmation, or its subscription was canceled before the first payment. A pre-order whose build has started never becomes `cancelled`.
          * @enum {string}
          */
-        PreOrderStatus: "draft" | "provisioning" | "fulfilled" | "cancelled";
+        PreOrderStatus: "draft" | "awaiting_payment" | "provisioning" | "fulfilled" | "cancelled";
         /**
-         * @description Progress of the line. `awaiting_hardware`: the line is not ready; also the value of a draft and of a canceled draft. `ready`: the line is prepared. `deployed`: the line is handed over. `received` and `setup_in_progress` are declared and never returned. Always present on a pre-order, and never `null`.
+         * @description Progress of the line. `awaiting_hardware`: the line is not ready; also the value of a pre-order that has no line: a draft, a pre-order in `awaiting_payment`, a canceled pre-order. `ready`: the line is prepared. `deployed`: the line is handed over. `received` and `setup_in_progress` are declared and never returned. Always present on a pre-order, and never `null`.
          * @enum {string|null}
          */
         DeviceFulfillmentStatus: "awaiting_hardware" | "received" | "setup_in_progress" | "ready" | "deployed" | null;
@@ -8876,13 +9245,24 @@ export interface components {
                 [key: string]: unknown;
             };
         };
-        /** @description The payment page of a reserved line. */
-        Checkout: {
+        CheckoutEnvelope: {
             /**
-             * Format: uri
-             * @description URL of the payment page: redirect the customer to it.
+             * @description Always `true` on a success response.
+             * @enum {boolean}
              */
-            url: string;
+            success: true;
+            data: components["schemas"]["Checkout"];
+            /** @description Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap. */
+            trace_id: string;
+            /** @description Id of the request that produced this response: `req_` followed by 25 letters or digits. */
+            request_id: string;
+        };
+        /** @description The first payment of a reserved line. */
+        Checkout: {
+            /** @description Id of the subscription. The subscription provides nothing until its first payment succeeds, and ends when that payment has not succeeded 23 hours after its creation. */
+            subscription_id: string;
+            /** @description Client secret of the first payment of the subscription, for the payment form of Stripe: the form takes the payment. `null` when the credit balance of the account has paid the first invoice: there is no payment to make. */
+            client_secret: string | null;
         };
         ByodCheckoutEnvelope: {
             /**
@@ -8896,18 +9276,16 @@ export interface components {
             /** @description Id of the request that produced this response: `req_` followed by 25 letters or digits. */
             request_id: string;
         };
-        /** @description The payment page of a purchase of BYOD slots. */
+        /** @description The first payment of a purchase of BYOD slots. */
         ByodCheckoutResponse: {
-            /**
-             * Format: uri
-             * @description URL of the payment page: redirect the customer to it.
-             */
-            checkout_url: string;
-            /**
-             * Format: date-time
-             * @description Timestamp at which the payment page expires.
-             */
-            expires_at: string;
+            /** @description Id of the subscription. The subscription provides nothing until its first payment succeeds, and ends when that payment has not succeeded 23 hours after its creation. */
+            subscription_id: string;
+            /** @description Client secret of the first payment of the subscription, for the payment form of Stripe: the form takes the payment. `null` when the credit balance of the account has paid the first invoice: there is no payment to make. */
+            client_secret: string | null;
+            /** @description Number of BYOD slots ordered. */
+            quantity: number;
+            /** @description Recurring total per billing period, in cents. `null` when it cannot be computed. It excludes tax, proration and discounts. */
+            estimated_total_cents: number | null;
         };
         /** @description A purchase of BYOD slots. */
         ByodCheckoutBody: {
@@ -8935,18 +9313,12 @@ export interface components {
             /** @description Id of the request that produced this response: `req_` followed by 25 letters or digits. */
             request_id: string;
         };
-        /** @description The payment page of a purchase of hosted macOS sessions. */
+        /** @description The first payment of a purchase of hosted macOS sessions. */
         MacCheckoutResponse: {
-            /**
-             * Format: uri
-             * @description URL of the payment page: redirect the customer to it.
-             */
-            checkout_url: string;
-            /**
-             * Format: date-time
-             * @description Timestamp at which the payment page expires.
-             */
-            expires_at: string;
+            /** @description Id of the subscription. The subscription provides nothing until its first payment succeeds, and ends when that payment has not succeeded 23 hours after its creation. */
+            subscription_id: string;
+            /** @description Client secret of the first payment of the subscription, for the payment form of Stripe: the form takes the payment. `null` when the credit balance of the account has paid the first invoice: there is no payment to make. */
+            client_secret: string | null;
             /** @description Number of hosted macOS sessions ordered. */
             quantity: number;
             /** @description Size of a pack: a quantity is a multiple of it, and at least equal to it. */
@@ -8968,6 +9340,90 @@ export interface components {
              */
             billing_cycle: "monthly" | "quarterly" | "annual";
         };
+        MacQuoteEnvelope: {
+            /**
+             * @description Always `true` on a success response.
+             * @enum {boolean}
+             */
+            success: true;
+            data: components["schemas"]["MacQuote"];
+            /** @description Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap. */
+            trace_id: string;
+            /** @description Id of the request that produced this response: `req_` followed by 25 letters or digits. */
+            request_id: string;
+        };
+        /** @description The price of a number of hosted macOS sessions. */
+        MacQuote: {
+            /** @description Number of hosted macOS sessions priced. */
+            quantity: number;
+            /** @description Size of a pack: a quantity is a multiple of it, and at least equal to it. */
+            pack_size: number;
+            /** @description Three-letter currency code of every amount, in lowercase. */
+            currency: string;
+            /** @description The tiers of the price, from the first session up. Each tier prices only the sessions that fall inside it. */
+            tiers: components["schemas"]["MacQuoteTier"][];
+            /** @description Recurring total per billing period, in cents. It excludes tax, proration and discounts. */
+            estimated_total_cents: number;
+        };
+        /** @description A tier of the price of hosted macOS sessions. */
+        MacQuoteTier: {
+            /** @description Highest number of sessions that the tier covers, counted from the first session. `null` for the last tier, which has no upper bound. */
+            up_to: number | null;
+            /** @description Price of one session inside the tier, per billing period, in cents. */
+            unit_amount_cents: number;
+            /** @description Amount added once per billing period when the quantity reaches the tier, in cents. */
+            flat_amount_cents: number;
+        };
+        BillingConfigEnvelope: {
+            /**
+             * @description Always `true` on a success response.
+             * @enum {boolean}
+             */
+            success: true;
+            data: components["schemas"]["BillingConfig"];
+            /** @description Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap. */
+            trace_id: string;
+            /** @description Id of the request that produced this response: `req_` followed by 25 letters or digits. */
+            request_id: string;
+        };
+        /** @description What the payment form needs, and the type of the account. */
+        BillingConfig: {
+            /** @description Stripe publishable key that the payment form of Stripe is loaded with. It starts with `pk_test_` in test mode and with `pk_live_` in live mode. `null` only for a wholesale partner, when iSnap has no publishable key to return. */
+            publishable_key: string | null;
+            /** @description `true` for a wholesale partner. A wholesale partner is billed on the monthly wholesale invoice: it has no card payment to make, and the operations that start a payment return `403 wholesale_partner_no_checkout` to it. */
+            wholesale: boolean;
+        };
+        BillingCoverageEnvelope: {
+            /**
+             * @description Always `true` on a success response.
+             * @enum {boolean}
+             */
+            success: true;
+            data: components["schemas"]["BillingCoverage"];
+            /** @description Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap. */
+            trace_id: string;
+            /** @description Id of the request that produced this response: `req_` followed by 25 letters or digits. */
+            request_id: string;
+        };
+        /** @description What the account has paid for, and what it uses. */
+        BillingCoverage: {
+            /** @description BYOD slots. `POST /v1/byod/pair` needs `paid` to be greater than `in_use`. */
+            byod_slots: {
+                /** @description Number of BYOD slots that the subscriptions of the account provide. A subscription counts once iSnap has recorded its first payment. */
+                paid: number;
+                /** @description Number of BYOD lines of the account that are not `cancelled`. A `suspended` line counts. */
+                in_use: number;
+            };
+            /** @description Hosted macOS sessions. */
+            mac_sessions: {
+                /** @description Number of hosted macOS sessions that the subscriptions of the account provide. A subscription counts once iSnap has recorded its first payment. */
+                paid: number;
+                /** @description Number of hosted macOS sessions assigned to the account, delivered or not. */
+                in_use: number;
+                /** @description Number of hosted macOS sessions of subscriptions whose first payment has not succeeded. They count with `paid` in the comparison with the BYOD lines of the account, for 24 hours at most. */
+                held: number;
+            };
+        };
         SubscriptionQuantityEnvelope: {
             /**
              * @description Always `true` on a success response.
@@ -9014,7 +9470,7 @@ export interface components {
         Subscription: {
             /** @description Id of the subscription. */
             id: string;
-            /** @description Status of the subscription, for example `active`. */
+            /** @description Status of the subscription, for example `active`. It is `incomplete` while the first payment has not succeeded. */
             status: string;
             /** @description Start of the current billing period, in Unix seconds. */
             current_period_start: number;
@@ -9022,14 +9478,26 @@ export interface components {
             current_period_end: number;
             /** @description `true` when the end of this subscription is scheduled for the end of the current billing period. */
             cancel_at_period_end: boolean;
-            /** @description Id of the line that the subscription pays for. It is a UUID, not the `line_` id of the line. `null` on a subscription to BYOD slots or to hosted macOS sessions. It can also be `null` on the subscription of a line: match `id` with the `stripe_subscription_id` of the line instead. */
+            /** @description Id of the line that the subscription pays for, in the `line_` form that the line operations take. `null` on a subscription to BYOD slots or to hosted macOS sessions, and when the line no longer exists or no longer belongs to the account. */
             line_id: string | null;
             /** @description Id of the price. `null` when the subscription has no item. */
             price_id: string | null;
-            /** @description Unit amount of the first item of the subscription, in cents. `null` when the price has no unit amount. */
+            /** @description Unit amount of the first item of the subscription, in cents. `null` when the price has no unit amount: the price of hosted macOS sessions is tiered and has none, and `GET /v1/billing/mac-quote` returns its total for a quantity. */
             amount: number | null;
             /** @description Three-letter currency code, in lowercase. `null` when the subscription has no item. */
             currency: string | null;
+            /**
+             * @description What the subscription sells: `outbound`, `inbound` or `shared` for a line, `byop` for BYOD slots, `mac` for hosted macOS sessions. `null` when the subscription has several items, or an item that is none of these.
+             * @enum {string|null}
+             */
+            product: "outbound" | "inbound" | "shared" | "byop" | "mac" | null;
+            /** @description Quantity of the item of the subscription: the number of BYOD slots for `byop`, the number of hosted macOS sessions for `mac`, and `1` for a line. `null` when the subscription has several items. */
+            quantity: number | null;
+            /**
+             * @description Billing period of the subscription: `monthly`, `quarterly` or `annual`. `null` when `product` is `null`.
+             * @enum {string|null}
+             */
+            billing_cycle: "monthly" | "quarterly" | "annual" | null;
             /** @description Time of creation, in Unix seconds. */
             created_at: number;
         };

package/dist/resources/preorders.d.ts

@@ -28,14 +28,34 @@ export declare class PreOrdersResource extends BaseResource {
     create(body: CreatePreOrderBody, opts?: RequestOptions): Promise<PreOrder>;
     /**
      * `POST /v1/pre-orders/{id}/confirm` — confirm a `draft` pre-order. The
-     * binding step: engages the one-month commitment (full month, no proration)
-     * and triggers procurement (mints the provisioning line + fulfillment task,
-     * notifies ops). Returns the pre-order in `provisioning`; ops procures the
-     * hardware and the partner is notified via the `pre_order.fulfilled` webhook
-     * when a matching line is ready. Direct customers get a Stripe
-     * `stripe_client_secret` to confirm the first-month charge; wholesale
-     * partners are billed EOM (no per-line Stripe sub). Only a draft can be
-     * confirmed.
+     * binding step: engages the one-month commitment (full month, no proration).
+     *
+     * A wholesale partner (billed at the end of the month) gets the pre-order
+     * back in `provisioning`: the line is being built, and the
+     * `pre_order.fulfilled` webhook fires when it is live.
+     *
+     * A direct account gets it back in `awaiting_payment` with
+     * `stripe_client_secret`, the client secret of the first-month payment, to
+     * confirm with the Stripe Payment Element (card only). Nothing is built until
+     * that payment succeeds; the pre-order then moves to `provisioning`: read it
+     * with `get()` until it leaves `awaiting_payment`. Calling `confirm()` again
+     * while it is `awaiting_payment` returns the same secret. When the first
+     * month is already paid (the account's credit balance covers it, or
+     * `confirm()` is repeated after the payment), the pre-order comes back in
+     * `provisioning` with `stripe_client_secret: null`.
+     *
+     * The first month starts at the confirmation, not when the line is handed
+     * over, and the next invoice is issued one month after the confirmation. The
+     * hand-over of the line takes no payment and does not change when the
+     * subscription is invoiced.
+     *
+     * An unpaid first month cancels the pre-order 23 hours after the
+     * confirmation; `confirm()` on it then throws a `BadRequestError` (400
+     * `pre_order_not_draft`), like any confirm of a pre-order that is not a
+     * draft. A 503 `payment_provider_unavailable` means nothing changed and the
+     * call can be repeated (the SDK retries it). A `ConflictError` with 409
+     * `payment_setup_failed` means the payment provider refused the request for
+     * the account: it is not retried, and repeating it does not help.
      */
     confirm(id: string, opts?: RequestOptions): Promise<PreOrder>;
     /**
@@ -51,7 +71,12 @@ export declare class PreOrdersResource extends BaseResource {
      * `has_more` is false.
      */
     list(query?: ListPreOrdersQuery, opts?: RequestOptions): Promise<PreOrderListData>;
-    /** `GET /v1/pre-orders/{id}` — fetch a single pre-order by id. */
+    /**
+     * `GET /v1/pre-orders/{id}` — fetch a single pre-order by id. Reading a
+     * pre-order that is `awaiting_payment` checks its first-month payment: once
+     * it has succeeded, the pre-order comes back in `provisioning`.
+     * `stripe_client_secret` is always `null` here.
+     */
     get(id: string, opts?: RequestOptions): Promise<PreOrder>;
     /**
      * `PATCH /v1/pre-orders/{id}` — merge `metadata` into the pre-order's tags.
@@ -64,9 +89,13 @@ export declare class PreOrdersResource extends BaseResource {
      */
     update(id: string, body: PatchPreOrderBody, opts?: RequestOptions): Promise<PreOrder>;
     /**
-     * `POST /v1/pre-orders/{id}/cancel` — cancel a pre-order before it is
-     * fulfilled. Refunds the Stripe payment intent (if charged) and releases the
-     * procurement task. No-op on an already-cancelled / fulfilled pre-order.
+     * `POST /v1/pre-orders/{id}/cancel` — cancel a `draft` or `awaiting_payment`
+     * pre-order. Free: nothing is charged or built in either status. For an
+     * `awaiting_payment` pre-order the first-month payment is voided first, so
+     * its client secret can no longer charge; a first month already paid throws
+     * a `ConflictError` (409 `pre_order_already_paid`). A pre-order that is
+     * `provisioning`, `fulfilled` or already `cancelled` is refused (400
+     * `pre_order_already_confirmed`).
      */
     cancel(id: string, opts?: RequestOptions): Promise<PreOrder>;
 }

package/dist/resources/preorders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preorders.d.ts","sourceRoot":"","sources":["../../src/resources/preorders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAA;AACxD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAA;AAIpE,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE5E,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAC1C,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAC/C,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAChC,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;AACnG,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAA;AAEtE,qBAAa,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI1E;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS7D;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAK,GAAE,kBAAuB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOtF,kEAAkE;IAClE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IASzD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IASrF;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQ7D"}
+{"version":3,"file":"preorders.d.ts","sourceRoot":"","sources":["../../src/resources/preorders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAA;AACxD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAA;AAIpE,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE5E,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAC1C,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAC/C,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAChC,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;AACnG,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAA;AAEtE,qBAAa,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS7D;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAK,GAAE,kBAAuB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOtF;;;;;OAKG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IASzD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IASrF;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQ7D"}

package/dist/resources/preorders.js

@@ -22,14 +22,34 @@ export class PreOrdersResource extends BaseResource {
     }
     /**
      * `POST /v1/pre-orders/{id}/confirm` — confirm a `draft` pre-order. The
-     * binding step: engages the one-month commitment (full month, no proration)
-     * and triggers procurement (mints the provisioning line + fulfillment task,
-     * notifies ops). Returns the pre-order in `provisioning`; ops procures the
-     * hardware and the partner is notified via the `pre_order.fulfilled` webhook
-     * when a matching line is ready. Direct customers get a Stripe
-     * `stripe_client_secret` to confirm the first-month charge; wholesale
-     * partners are billed EOM (no per-line Stripe sub). Only a draft can be
-     * confirmed.
+     * binding step: engages the one-month commitment (full month, no proration).
+     *
+     * A wholesale partner (billed at the end of the month) gets the pre-order
+     * back in `provisioning`: the line is being built, and the
+     * `pre_order.fulfilled` webhook fires when it is live.
+     *
+     * A direct account gets it back in `awaiting_payment` with
+     * `stripe_client_secret`, the client secret of the first-month payment, to
+     * confirm with the Stripe Payment Element (card only). Nothing is built until
+     * that payment succeeds; the pre-order then moves to `provisioning`: read it
+     * with `get()` until it leaves `awaiting_payment`. Calling `confirm()` again
+     * while it is `awaiting_payment` returns the same secret. When the first
+     * month is already paid (the account's credit balance covers it, or
+     * `confirm()` is repeated after the payment), the pre-order comes back in
+     * `provisioning` with `stripe_client_secret: null`.
+     *
+     * The first month starts at the confirmation, not when the line is handed
+     * over, and the next invoice is issued one month after the confirmation. The
+     * hand-over of the line takes no payment and does not change when the
+     * subscription is invoiced.
+     *
+     * An unpaid first month cancels the pre-order 23 hours after the
+     * confirmation; `confirm()` on it then throws a `BadRequestError` (400
+     * `pre_order_not_draft`), like any confirm of a pre-order that is not a
+     * draft. A 503 `payment_provider_unavailable` means nothing changed and the
+     * call can be repeated (the SDK retries it). A `ConflictError` with 409
+     * `payment_setup_failed` means the payment provider refused the request for
+     * the account: it is not retried, and repeating it does not help.
      */
     confirm(id, opts) {
         return this.client.request('POST', `/v1/pre-orders/${encodeURIComponent(id)}/confirm`, undefined, opts);
@@ -52,7 +72,12 @@ export class PreOrdersResource extends BaseResource {
             query: { ...opts?.query, ...query }
         });
     }
-    /** `GET /v1/pre-orders/{id}` — fetch a single pre-order by id. */
+    /**
+     * `GET /v1/pre-orders/{id}` — fetch a single pre-order by id. Reading a
+     * pre-order that is `awaiting_payment` checks its first-month payment: once
+     * it has succeeded, the pre-order comes back in `provisioning`.
+     * `stripe_client_secret` is always `null` here.
+     */
     get(id, opts) {
         return this.client.request('GET', `/v1/pre-orders/${encodeURIComponent(id)}`, undefined, opts);
     }
@@ -69,9 +94,13 @@ export class PreOrdersResource extends BaseResource {
         return this.client.request('PATCH', `/v1/pre-orders/${encodeURIComponent(id)}`, body, opts);
     }
     /**
-     * `POST /v1/pre-orders/{id}/cancel` — cancel a pre-order before it is
-     * fulfilled. Refunds the Stripe payment intent (if charged) and releases the
-     * procurement task. No-op on an already-cancelled / fulfilled pre-order.
+     * `POST /v1/pre-orders/{id}/cancel` — cancel a `draft` or `awaiting_payment`
+     * pre-order. Free: nothing is charged or built in either status. For an
+     * `awaiting_payment` pre-order the first-month payment is voided first, so
+     * its client secret can no longer charge; a first month already paid throws
+     * a `ConflictError` (409 `pre_order_already_paid`). A pre-order that is
+     * `provisioning`, `fulfilled` or already `cancelled` is refused (400
+     * `pre_order_already_confirmed`).
      */
     cancel(id, opts) {
         return this.client.request('POST', `/v1/pre-orders/${encodeURIComponent(id)}/cancel`, undefined, opts);

package/dist/resources/preorders.js.map

@@ -1 +1 @@
-{"version":3,"file":"preorders.js","sourceRoot":"","sources":["../../src/resources/preorders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAexC,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,IAAqB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAClD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,QAA4B,EAAE,EAAE,IAAqB;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAmB,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE;YAC/E,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAA;IACJ,CAAC;IAED,kEAAkE;IAClE,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,IAAuB,EAAE,IAAqB;QAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACjD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;CACF"}
+{"version":3,"file":"preorders.js","sourceRoot":"","sources":["../../src/resources/preorders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAexC,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,IAAqB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAW,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,OAAO,CAAC,EAAU,EAAE,IAAqB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAClD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,QAA4B,EAAE,EAAE,IAAqB;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAmB,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE;YAC/E,GAAG,IAAI;YACP,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,EAAU,EAAE,IAAqB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,KAAK,EACL,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1C,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,IAAuB,EAAE,IAAqB;QAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,OAAO,EACP,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1C,IAAI,EACJ,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,IAAqB;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB,MAAM,EACN,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACjD,SAAS,EACT,IAAI,CACL,CAAA;IACH,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isnap/sdk",
-  "version": "2.2.0-next.226",
+  "version": "2.2.0-next.228",
   "description": "Official TypeScript SDK for the iSnap P2P telephony API",
   "license": "MIT",
   "type": "module",