hanzoai 8.5.699 → 8.5.704

package/dist/api/billing-api.d.ts

@@ -215,7 +215,7 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      */
     getBillingPayouts: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -373,7 +373,7 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      */
     postBillingRechargeRunAll: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -604,7 +604,7 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      */
     getBillingPayouts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BillingPayout>>>;
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -762,7 +762,7 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      */
     postBillingRechargeRunAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BillingRecharge>>;
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -985,7 +985,7 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      */
     getBillingPayouts(options?: RawAxiosRequestConfig): AxiosPromise<Array<BillingPayout>>;
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1140,7 +1140,7 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      */
     postBillingRechargeRunAll(options?: RawAxiosRequestConfig): AxiosPromise<BillingRecharge>;
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1804,7 +1804,7 @@ export declare class BillingApi extends BaseAPI {
      */
     getBillingPayouts(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<BillingPayout[], any, {}>>;
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1980,7 +1980,7 @@ export declare class BillingApi extends BaseAPI {
      */
     postBillingRechargeRunAll(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<BillingRecharge, any, {}>>;
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api/billing-api.js

@@ -667,7 +667,7 @@ const BillingApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1303,7 +1303,7 @@ const BillingApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1842,7 +1842,7 @@ const BillingApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2105,7 +2105,7 @@ const BillingApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2412,7 +2412,7 @@ const BillingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getBillingPayouts(options).then((request) => request(axios, basePath));
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2609,7 +2609,7 @@ const BillingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.postBillingRechargeRunAll(options).then((request) => request(axios, basePath));
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2909,7 +2909,7 @@ class BillingApi extends base_1.BaseAPI {
         return (0, exports.BillingApiFp)(this.configuration).getBillingPayouts(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3127,7 +3127,7 @@ class BillingApi extends base_1.BaseAPI {
         return (0, exports.BillingApiFp)(this.configuration).postBillingRechargeRunAll(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/esm/api/billing-api.d.ts

@@ -214,7 +214,7 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      */
     getBillingPayouts: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -372,7 +372,7 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      */
     postBillingRechargeRunAll: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -603,7 +603,7 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      */
     getBillingPayouts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BillingPayout>>>;
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -761,7 +761,7 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      */
     postBillingRechargeRunAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BillingRecharge>>;
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -984,7 +984,7 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      */
     getBillingPayouts(options?: RawAxiosRequestConfig): AxiosPromise<Array<BillingPayout>>;
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1139,7 +1139,7 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      */
     postBillingRechargeRunAll(options?: RawAxiosRequestConfig): AxiosPromise<BillingRecharge>;
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1803,7 +1803,7 @@ export declare class BillingApi extends BaseAPI {
      */
     getBillingPayouts(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingPayout[], any, {}>>;
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1979,7 +1979,7 @@ export declare class BillingApi extends BaseAPI {
      */
     postBillingRechargeRunAll(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BillingRecharge, any, {}>>;
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/esm/api/billing-api.js

@@ -661,7 +661,7 @@ export const BillingApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1297,7 +1297,7 @@ export const BillingApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1835,7 +1835,7 @@ export const BillingApiFp = function (configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2098,7 +2098,7 @@ export const BillingApiFp = function (configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2404,7 +2404,7 @@ export const BillingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getBillingPayouts(options).then((request) => request(axios, basePath));
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2601,7 +2601,7 @@ export const BillingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.postBillingRechargeRunAll(options).then((request) => request(axios, basePath));
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2900,7 +2900,7 @@ export class BillingApi extends BaseAPI {
         return BillingApiFp(this.configuration).getBillingPayouts(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -3118,7 +3118,7 @@ export class BillingApi extends BaseAPI {
         return BillingApiFp(this.configuration).postBillingRechargeRunAll(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/esm/models/billing-subscription.d.ts

@@ -118,6 +118,12 @@ export interface BillingSubscription {
      * @memberof BillingSubscription
      */
     'status'?: string;
+    /**
+     * Test marks a sandbox subscription: sold while its org was in test mode, paid with sandbox money. It is listed and never revenue.
+     * @type {boolean}
+     * @memberof BillingSubscription
+     */
+    'test'?: boolean;
     /**
      * TrialEnd is when that trial ends; absent when there was none.
      * @type {string}

package/dist/models/billing-subscription.d.ts

@@ -118,6 +118,12 @@ export interface BillingSubscription {
      * @memberof BillingSubscription
      */
     'status'?: string;
+    /**
+     * Test marks a sandbox subscription: sold while its org was in test mode, paid with sandbox money. It is listed and never revenue.
+     * @type {boolean}
+     * @memberof BillingSubscription
+     */
+    'test'?: boolean;
     /**
      * TrialEnd is when that trial ends; absent when there was none.
      * @type {string}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hanzoai",
-  "version": "8.5.699",
+  "version": "8.5.704",
   "description": "The official TypeScript library for the Hanzo API",
   "author": "Hanzo <dev@hanzo.ai>",
   "license": "Apache-2.0",

package/src/api/billing-api.ts

@@ -872,7 +872,7 @@ export const BillingApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1641,7 +1641,7 @@ export const BillingApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2234,7 +2234,7 @@ export const BillingApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2497,7 +2497,7 @@ export const BillingApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2804,7 +2804,7 @@ export const BillingApiFactory = function (configuration?: Configuration, basePa
             return localVarFp.getBillingPayouts(options).then((request) => request(axios, basePath));
         },
         /**
-         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+         * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
          * @summary The plan catalog, priced with whatever offer is in force
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -3001,7 +3001,7 @@ export const BillingApiFactory = function (configuration?: Configuration, basePa
             return localVarFp.postBillingRechargeRunAll(options).then((request) => request(axios, basePath));
         },
         /**
-         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+         * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
          * @summary Buy a plan with a card
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -3783,7 +3783,7 @@ export class BillingApi extends BaseAPI {
     }
 
     /**
-     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
+     * Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.  The prices are what the CHECKOUT will charge: any active promotion is applied before they leave the store, so a reader never applies a discount a second time and a quote can never disagree with the sale.  `?coupon=` quotes the catalog under a plan coupon code: each paid plan it covers carries `couponCode`, `couponPercent`, `couponFirstCents` (the first month\'s charge under it) and `couponEnds`; every other row carries `couponError` — `unknown`, `expired`, `exhausted` or `not_applicable`. Nothing is reserved by a quote. Without the parameter the catalog is unchanged.  It is public and needs no tenant, and it is the catalog of the brand the request\'s host resolves to — the same brand `/v1/commerce/org` answers there. A brand that publishes no plans answers an empty list.
      * @summary The plan catalog, priced with whatever offer is in force
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -4022,7 +4022,7 @@ export class BillingApi extends BaseAPI {
     }
 
     /**
-     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
+     * Vaults the card (or reuses one already on file), charges the plan\'s FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.  There is NO AMOUNT in the request. `level` picks which of the plan\'s published prices to buy at — an index, never a number — so what the card is charged is decided by the catalog and underpaying cannot be expressed.  `interval` picks the term: \"month\" (the default) or \"year\", which charges the plan\'s annual total now and renews yearly. A plan with no annual price refuses \"year\".  `coupon` is a plan coupon code (case-insensitive) for a percent off the FIRST month only; renewals bill the catalog price. It is a code, never an amount. A code that is unknown, expired, used up, not for this plan, or sent with annual billing or prepaid credit is 400, and one this org or this card has already redeemed is 409 — before any card is charged, never a silent full-price sale. The receipt names the coupon and its percent.  A fresh sale answers 201 with the receipt. An identical retry answers 200 with the FIRST sale\'s body, byte for byte, so a client cannot read a replay as a second subscription having been opened. A caller already on a paid plan is 409 rather than charged again.
      * @summary Buy a plan with a card
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/src/models/billing-subscription.ts

@@ -125,6 +125,12 @@ export interface BillingSubscription {
      * @memberof BillingSubscription
      */
     'status'?: string;
+    /**
+     * Test marks a sandbox subscription: sold while its org was in test mode, paid with sandbox money. It is listed and never revenue.
+     * @type {boolean}
+     * @memberof BillingSubscription
+     */
+    'test'?: boolean;
     /**
      * TrialEnd is when that trial ends; absent when there was none.
      * @type {string}