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

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: {
@@ -3555,7 +3555,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 +3585,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 +3612,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 +3630,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 +3648,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 +3676,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 +3695,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 +3722,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 +3749,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 +3777,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 +3798,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 +3825,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 +3843,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 +3870,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 +4041,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 +4147,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 +4190,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 +4208,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 +4217,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 +4250,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 +4313,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 +4322,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 +4340,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 +4362,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 +4437,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 +4512,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 +4573,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 +8510,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;
@@ -8876,13 +9212,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 +9243,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 +9280,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 +9307,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 +9437,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 +9445,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/package.json

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