drjones/hydro-builder-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial project import

Browse Source
This commit is contained in:
drjones
2026-06-13 17:36:44 -07:00
commit ad2a18cc8d
18471 changed files with 4497570 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

728
node_modules/stripe/cjs/resources/BillingPortal/Configurations.d.ts generated vendored Normal file
View File

@@ -0,0 +1,728 @@
import { StripeResource } from '../../StripeResource.js';
import { Application, DeletedApplication } from './../Applications.js';
import { Emptyable, MetadataParam, PaginationParams, Metadata } from '../../shared.js';
import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
export declare class ConfigurationResource extends StripeResource {
/**
* Returns a list of configurations that describe the functionality of the customer portal.
*/
list(params?: BillingPortal.ConfigurationListParams, options?: RequestOptions): ApiListPromise<Configuration>;
/**
* Creates a configuration that describes the functionality and behavior of a PortalSession
*/
create(params: BillingPortal.ConfigurationCreateParams, options?: RequestOptions): Promise<Response<Configuration>>;
/**
* Retrieves a configuration that describes the functionality of the customer portal.
*/
retrieve(id: string, params?: BillingPortal.ConfigurationRetrieveParams, options?: RequestOptions): Promise<Response<Configuration>>;
/**
* Updates a configuration that describes the functionality of the customer portal.
*/
update(id: string, params?: BillingPortal.ConfigurationUpdateParams, options?: RequestOptions): Promise<Response<Configuration>>;
}
export interface Configuration {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'billing_portal.configuration';
/**
* Whether the configuration is active and can be used to create portal sessions.
*/
active: boolean;
/**
* ID of the Connect Application that created the configuration.
*/
application: string | Application | DeletedApplication | null;
business_profile: BillingPortal.Configuration.BusinessProfile;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: number;
/**
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
*/
default_return_url: string | null;
features: BillingPortal.Configuration.Features;
/**
* Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
*/
is_default: boolean;
/**
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
*/
livemode: boolean;
login_page: BillingPortal.Configuration.LoginPage;
/**
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*/
metadata: Metadata | null;
/**
* The name of the configuration.
*/
name: string | null;
/**
* Time at which the object was last updated. Measured in seconds since the Unix epoch.
*/
updated: number;
}
export declare namespace BillingPortal {
namespace Configuration {
interface BusinessProfile {
/**
* The messaging shown to customers in the portal.
*/
headline: string | null;
/**
* A link to the business's publicly available privacy policy.
*/
privacy_policy_url: string | null;
/**
* A link to the business's publicly available terms of service.
*/
terms_of_service_url: string | null;
}
interface Features {
customer_update: Features.CustomerUpdate;
invoice_history: Features.InvoiceHistory;
payment_method_update: Features.PaymentMethodUpdate;
subscription_cancel: Features.SubscriptionCancel;
subscription_update: Features.SubscriptionUpdate;
}
interface LoginPage {
/**
* If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.
*
* If `false`, the previously generated `url`, if any, will be deactivated.
*/
enabled: boolean;
/**
* A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal.
*/
url: string | null;
}
namespace Features {
interface CustomerUpdate {
/**
* The types of customer updates that are supported. When empty, customers are not updateable.
*/
allowed_updates: Array<CustomerUpdate.AllowedUpdate>;
/**
* Whether the feature is enabled.
*/
enabled: boolean;
}
interface InvoiceHistory {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
}
interface PaymentMethodUpdate {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* The [Payment Method Configuration](https://docs.stripe.com/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
*/
payment_method_configuration: string | null;
}
interface SubscriptionCancel {
cancellation_reason: SubscriptionCancel.CancellationReason;
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* Whether to cancel subscriptions immediately or at the end of the billing period.
*/
mode: SubscriptionCancel.Mode;
/**
* Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.
*/
proration_behavior: SubscriptionCancel.ProrationBehavior;
}
interface SubscriptionUpdate {
/**
* Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
*/
billing_cycle_anchor: SubscriptionUpdate.BillingCycleAnchor | null;
/**
* The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
*/
default_allowed_updates: Array<SubscriptionUpdate.DefaultAllowedUpdate>;
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* The list of up to 10 products that support subscription updates.
*/
products?: Array<SubscriptionUpdate.Product> | null;
/**
* Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.
*/
proration_behavior: SubscriptionUpdate.ProrationBehavior;
schedule_at_period_end: SubscriptionUpdate.ScheduleAtPeriodEnd;
/**
* Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation.
*/
trial_update_behavior: SubscriptionUpdate.TrialUpdateBehavior;
}
namespace CustomerUpdate {
type AllowedUpdate = 'address' | 'email' | 'name' | 'phone' | 'shipping' | 'tax_id';
}
namespace SubscriptionCancel {
interface CancellationReason {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* Which cancellation reasons will be given as options to the customer.
*/
options: Array<CancellationReason.Option>;
}
type Mode = 'at_period_end' | 'immediately';
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
namespace CancellationReason {
type Option = 'customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused';
}
}
namespace SubscriptionUpdate {
type BillingCycleAnchor = 'now' | 'unchanged';
type DefaultAllowedUpdate = 'price' | 'promotion_code' | 'quantity';
interface Product {
adjustable_quantity: Product.AdjustableQuantity;
/**
* The list of price IDs which, when subscribed to, a subscription can be updated.
*/
prices: Array<string>;
/**
* The product ID.
*/
product: string;
}
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
interface ScheduleAtPeriodEnd {
/**
* List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
*/
conditions: Array<ScheduleAtPeriodEnd.Condition>;
}
type TrialUpdateBehavior = 'continue_trial' | 'end_trial';
namespace Product {
interface AdjustableQuantity {
/**
* If true, the quantity can be adjusted to any non-negative integer.
*/
enabled: boolean;
/**
* The maximum quantity that can be set for the product.
*/
maximum: number | null;
/**
* The minimum quantity that can be set for the product.
*/
minimum: number;
}
}
namespace ScheduleAtPeriodEnd {
interface Condition {
/**
* The type of condition.
*/
type: Condition.Type;
}
namespace Condition {
type Type = 'decreasing_item_amount' | 'shortening_interval';
}
}
}
}
}
}
export declare namespace BillingPortal {
interface ConfigurationCreateParams {
/**
* Information about the features available in the portal.
*/
features: ConfigurationCreateParams.Features;
/**
* The business information shown to customers in the portal.
*/
business_profile?: ConfigurationCreateParams.BusinessProfile;
/**
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
*/
default_return_url?: Emptyable<string>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
*/
login_page?: ConfigurationCreateParams.LoginPage;
/**
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: MetadataParam;
/**
* The name of the configuration.
*/
name?: Emptyable<string>;
}
namespace ConfigurationCreateParams {
interface Features {
/**
* Information about updating the customer details in the portal.
*/
customer_update?: Features.CustomerUpdate;
/**
* Information about showing the billing history in the portal.
*/
invoice_history?: Features.InvoiceHistory;
/**
* Information about updating payment methods in the portal.
*/
payment_method_update?: Features.PaymentMethodUpdate;
/**
* Information about canceling subscriptions in the portal.
*/
subscription_cancel?: Features.SubscriptionCancel;
/**
* Information about updating subscriptions in the portal.
*/
subscription_update?: Features.SubscriptionUpdate;
}
interface BusinessProfile {
/**
* The messaging shown to customers in the portal.
*/
headline?: Emptyable<string>;
/**
* A link to the business's publicly available privacy policy.
*/
privacy_policy_url?: string;
/**
* A link to the business's publicly available terms of service.
*/
terms_of_service_url?: string;
}
interface LoginPage {
/**
* Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
*/
enabled: boolean;
}
namespace Features {
interface CustomerUpdate {
/**
* The types of customer updates that are supported. When empty, customers are not updateable.
*/
allowed_updates?: Emptyable<Array<CustomerUpdate.AllowedUpdate>>;
/**
* Whether the feature is enabled.
*/
enabled: boolean;
}
interface InvoiceHistory {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
}
interface PaymentMethodUpdate {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* The [Payment Method Configuration](https://docs.stripe.com/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set or set to an empty string, the default payment method configuration is used.
*/
payment_method_configuration?: Emptyable<string>;
}
interface SubscriptionCancel {
/**
* Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
*/
cancellation_reason?: SubscriptionCancel.CancellationReason;
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* Whether to cancel subscriptions immediately or at the end of the billing period.
*/
mode?: SubscriptionCancel.Mode;
/**
* Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
*/
proration_behavior?: SubscriptionCancel.ProrationBehavior;
}
interface SubscriptionUpdate {
/**
* Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
*/
billing_cycle_anchor?: SubscriptionUpdate.BillingCycleAnchor;
/**
* The types of subscription updates that are supported. When empty, subscriptions are not updateable.
*/
default_allowed_updates?: Emptyable<Array<SubscriptionUpdate.DefaultAllowedUpdate>>;
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* The list of up to 10 products that support subscription updates.
*/
products?: Emptyable<Array<SubscriptionUpdate.Product>>;
/**
* Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
*/
proration_behavior?: SubscriptionUpdate.ProrationBehavior;
/**
* Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
*/
schedule_at_period_end?: SubscriptionUpdate.ScheduleAtPeriodEnd;
/**
* The behavior when updating a subscription that is trialing.
*/
trial_update_behavior?: SubscriptionUpdate.TrialUpdateBehavior;
}
namespace CustomerUpdate {
type AllowedUpdate = 'address' | 'email' | 'name' | 'phone' | 'shipping' | 'tax_id';
}
namespace SubscriptionCancel {
interface CancellationReason {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* Which cancellation reasons will be given as options to the customer.
*/
options: Emptyable<Array<CancellationReason.Option>>;
}
type Mode = 'at_period_end' | 'immediately';
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
namespace CancellationReason {
type Option = 'customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused';
}
}
namespace SubscriptionUpdate {
type BillingCycleAnchor = 'now' | 'unchanged';
type DefaultAllowedUpdate = 'price' | 'promotion_code' | 'quantity';
interface Product {
/**
* Control whether the quantity of the product can be adjusted.
*/
adjustable_quantity?: Product.AdjustableQuantity;
/**
* The list of price IDs for the product that a subscription can be updated to.
*/
prices: Array<string>;
/**
* The product id.
*/
product: string;
}
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
interface ScheduleAtPeriodEnd {
/**
* List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
*/
conditions?: Array<ScheduleAtPeriodEnd.Condition>;
}
type TrialUpdateBehavior = 'continue_trial' | 'end_trial';
namespace Product {
interface AdjustableQuantity {
/**
* Set to true if the quantity can be adjusted to any non-negative integer.
*/
enabled: boolean;
/**
* The maximum quantity that can be set for the product.
*/
maximum?: number;
/**
* The minimum quantity that can be set for the product.
*/
minimum?: number;
}
}
namespace ScheduleAtPeriodEnd {
interface Condition {
/**
* The type of condition.
*/
type: Condition.Type;
}
namespace Condition {
type Type = 'decreasing_item_amount' | 'shortening_interval';
}
}
}
}
}
}
export declare namespace BillingPortal {
interface ConfigurationRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
}
export declare namespace BillingPortal {
interface ConfigurationUpdateParams {
/**
* Whether the configuration is active and can be used to create portal sessions.
*/
active?: boolean;
/**
* The business information shown to customers in the portal.
*/
business_profile?: ConfigurationUpdateParams.BusinessProfile;
/**
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
*/
default_return_url?: Emptyable<string>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Information about the features available in the portal.
*/
features?: ConfigurationUpdateParams.Features;
/**
* The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
*/
login_page?: ConfigurationUpdateParams.LoginPage;
/**
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Emptyable<MetadataParam>;
/**
* The name of the configuration.
*/
name?: Emptyable<string>;
}
namespace ConfigurationUpdateParams {
interface BusinessProfile {
/**
* The messaging shown to customers in the portal.
*/
headline?: Emptyable<string>;
/**
* A link to the business's publicly available privacy policy.
*/
privacy_policy_url?: Emptyable<string>;
/**
* A link to the business's publicly available terms of service.
*/
terms_of_service_url?: Emptyable<string>;
}
interface Features {
/**
* Information about updating the customer details in the portal.
*/
customer_update?: Features.CustomerUpdate;
/**
* Information about showing the billing history in the portal.
*/
invoice_history?: Features.InvoiceHistory;
/**
* Information about updating payment methods in the portal.
*/
payment_method_update?: Features.PaymentMethodUpdate;
/**
* Information about canceling subscriptions in the portal.
*/
subscription_cancel?: Features.SubscriptionCancel;
/**
* Information about updating subscriptions in the portal.
*/
subscription_update?: Features.SubscriptionUpdate;
}
interface LoginPage {
/**
* Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
*
* Set to `false` to deactivate the `login_page.url`.
*/
enabled: boolean;
}
namespace Features {
interface CustomerUpdate {
/**
* The types of customer updates that are supported. When empty, customers are not updateable.
*/
allowed_updates?: Emptyable<Array<CustomerUpdate.AllowedUpdate>>;
/**
* Whether the feature is enabled.
*/
enabled?: boolean;
}
interface InvoiceHistory {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
}
interface PaymentMethodUpdate {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* The [Payment Method Configuration](https://docs.stripe.com/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set or set to an empty string, the default payment method configuration is used.
*/
payment_method_configuration?: Emptyable<string>;
}
interface SubscriptionCancel {
/**
* Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
*/
cancellation_reason?: SubscriptionCancel.CancellationReason;
/**
* Whether the feature is enabled.
*/
enabled?: boolean;
/**
* Whether to cancel subscriptions immediately or at the end of the billing period.
*/
mode?: SubscriptionCancel.Mode;
/**
* Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
*/
proration_behavior?: SubscriptionCancel.ProrationBehavior;
}
interface SubscriptionUpdate {
/**
* Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
*/
billing_cycle_anchor?: SubscriptionUpdate.BillingCycleAnchor;
/**
* The types of subscription updates that are supported. When empty, subscriptions are not updateable.
*/
default_allowed_updates?: Emptyable<Array<SubscriptionUpdate.DefaultAllowedUpdate>>;
/**
* Whether the feature is enabled.
*/
enabled?: boolean;
/**
* The list of up to 10 products that support subscription updates.
*/
products?: Emptyable<Array<SubscriptionUpdate.Product>>;
/**
* Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
*/
proration_behavior?: SubscriptionUpdate.ProrationBehavior;
/**
* Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
*/
schedule_at_period_end?: SubscriptionUpdate.ScheduleAtPeriodEnd;
/**
* The behavior when updating a subscription that is trialing.
*/
trial_update_behavior?: SubscriptionUpdate.TrialUpdateBehavior;
}
namespace CustomerUpdate {
type AllowedUpdate = 'address' | 'email' | 'name' | 'phone' | 'shipping' | 'tax_id';
}
namespace SubscriptionCancel {
interface CancellationReason {
/**
* Whether the feature is enabled.
*/
enabled: boolean;
/**
* Which cancellation reasons will be given as options to the customer.
*/
options?: Emptyable<Array<CancellationReason.Option>>;
}
type Mode = 'at_period_end' | 'immediately';
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
namespace CancellationReason {
type Option = 'customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused';
}
}
namespace SubscriptionUpdate {
type BillingCycleAnchor = 'now' | 'unchanged';
type DefaultAllowedUpdate = 'price' | 'promotion_code' | 'quantity';
interface Product {
/**
* Control whether the quantity of the product can be adjusted.
*/
adjustable_quantity?: Product.AdjustableQuantity;
/**
* The list of price IDs for the product that a subscription can be updated to.
*/
prices: Array<string>;
/**
* The product id.
*/
product: string;
}
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
interface ScheduleAtPeriodEnd {
/**
* List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
*/
conditions?: Emptyable<Array<ScheduleAtPeriodEnd.Condition>>;
}
type TrialUpdateBehavior = 'continue_trial' | 'end_trial';
namespace Product {
interface AdjustableQuantity {
/**
* Set to true if the quantity can be adjusted to any non-negative integer.
*/
enabled: boolean;
/**
* The maximum quantity that can be set for the product.
*/
maximum?: number;
/**
* The minimum quantity that can be set for the product.
*/
minimum?: number;
}
}
namespace ScheduleAtPeriodEnd {
interface Condition {
/**
* The type of condition.
*/
type: Condition.Type;
}
namespace Condition {
type Type = 'decreasing_item_amount' | 'shortening_interval';
}
}
}
}
}
}
export declare namespace BillingPortal {
interface ConfigurationListParams extends PaginationParams {
/**
* Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
*/
active?: boolean;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
*/
is_default?: boolean;
}
}

35
node_modules/stripe/cjs/resources/BillingPortal/Configurations.js generated vendored Normal file
View File

@@ -0,0 +1,35 @@
"use strict";
// File generated from our OpenAPI spec
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConfigurationResource = void 0;
const StripeResource_js_1 = require("../../StripeResource.js");
class ConfigurationResource extends StripeResource_js_1.StripeResource {
/**
* Returns a list of configurations that describe the functionality of the customer portal.
*/
list(params, options) {
return this._makeRequest('GET', '/v1/billing_portal/configurations', params, options, {
methodType: 'list',
});
}
/**
* Creates a configuration that describes the functionality and behavior of a PortalSession
*/
create(params, options) {
return this._makeRequest('POST', '/v1/billing_portal/configurations', params, options);
}
/**
* Retrieves a configuration that describes the functionality of the customer portal.
*/
retrieve(id, params, options) {
return this._makeRequest('GET', `/v1/billing_portal/configurations/${encodeURIComponent(id)}`, params, options);
}
/**
* Updates a configuration that describes the functionality of the customer portal.
*/
update(id, params, options) {
return this._makeRequest('POST', `/v1/billing_portal/configurations/${encodeURIComponent(id)}`, params, options);
}
}
exports.ConfigurationResource = ConfigurationResource;
//# sourceMappingURL=Configurations.js.map

1
node_modules/stripe/cjs/resources/BillingPortal/Configurations.js.map generated vendored Normal file
View File

@@ -0,0 +1 @@
{"version":3,"file":"Configurations.js","sourceRoot":"","sources":["../../../src/resources/BillingPortal/Configurations.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAUvD,MAAa,qBAAsB,SAAQ,kCAAc;IACvD;;OAEG;IACH,IAAI,CACF,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,mCAAmC,EACnC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,mCAAmC,EACnC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qCAAqC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qCAAqC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA9DD,sDA8DC"}

360
node_modules/stripe/cjs/resources/BillingPortal/Sessions.d.ts generated vendored Normal file
View File

@@ -0,0 +1,360 @@
import { StripeResource } from '../../StripeResource.js';
import { Configuration } from './Configurations.js';
import { RequestOptions, Response } from '../../lib.js';
export declare class SessionResource extends StripeResource {
/**
* Creates a session of the customer portal.
*/
create(params?: BillingPortal.SessionCreateParams, options?: RequestOptions): Promise<Response<Session>>;
}
export interface Session {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'billing_portal.session';
/**
* The configuration used by this session, describing the features available.
*/
configuration: string | Configuration;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: number;
/**
* The ID of the customer for this session.
*/
customer: string;
/**
* The ID of the account for this session.
*/
customer_account: string | null;
/**
* Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
*/
flow: BillingPortal.Session.Flow | null;
/**
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
*/
livemode: boolean;
/**
* The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer's `preferred_locales` or browser's locale is used.
*/
locale: BillingPortal.Session.Locale | null;
/**
* The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
*/
on_behalf_of: string | null;
/**
* The URL to redirect customers to when they click on the portal's link to return to your website.
*/
return_url: string | null;
/**
* The short-lived URL of the session that gives customers access to the customer portal.
*/
url: string;
}
export declare namespace BillingPortal {
namespace Session {
interface Flow {
after_completion: Flow.AfterCompletion;
/**
* Configuration when `flow.type=subscription_cancel`.
*/
subscription_cancel: Flow.SubscriptionCancel | null;
/**
* Configuration when `flow.type=subscription_update`.
*/
subscription_update: Flow.SubscriptionUpdate | null;
/**
* Configuration when `flow.type=subscription_update_confirm`.
*/
subscription_update_confirm: Flow.SubscriptionUpdateConfirm | null;
/**
* Type of flow that the customer will go through.
*/
type: Flow.Type;
}
type Locale = 'auto' | 'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IE' | 'en-IN' | 'en-NZ' | 'en-SG' | 'es' | 'es-419' | 'et' | 'fi' | 'fil' | 'fr' | 'fr-CA' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'mt' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sv' | 'th' | 'tr' | 'vi' | 'zh' | 'zh-HK' | 'zh-TW';
namespace Flow {
interface AfterCompletion {
/**
* Configuration when `after_completion.type=hosted_confirmation`.
*/
hosted_confirmation: AfterCompletion.HostedConfirmation | null;
/**
* Configuration when `after_completion.type=redirect`.
*/
redirect: AfterCompletion.Redirect | null;
/**
* The specified type of behavior after the flow is completed.
*/
type: AfterCompletion.Type;
}
interface SubscriptionCancel {
/**
* Specify a retention strategy to be used in the cancellation flow.
*/
retention: SubscriptionCancel.Retention | null;
/**
* The ID of the subscription to be canceled.
*/
subscription: string;
}
interface SubscriptionUpdate {
/**
* The ID of the subscription to be updated.
*/
subscription: string;
}
interface SubscriptionUpdateConfirm {
/**
* The coupon or promotion code to apply to this subscription update.
*/
discounts: Array<SubscriptionUpdateConfirm.Discount> | null;
/**
* The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
*/
items: Array<SubscriptionUpdateConfirm.Item>;
/**
* The ID of the subscription to be updated.
*/
subscription: string;
}
type Type = 'payment_method_update' | 'subscription_cancel' | 'subscription_update' | 'subscription_update_confirm';
namespace AfterCompletion {
interface HostedConfirmation {
/**
* A custom message to display to the customer after the flow is completed.
*/
custom_message: string | null;
}
interface Redirect {
/**
* The URL the customer will be redirected to after the flow is completed.
*/
return_url: string;
}
type Type = 'hosted_confirmation' | 'portal_homepage' | 'redirect';
}
namespace SubscriptionCancel {
interface Retention {
/**
* Configuration when `retention.type=coupon_offer`.
*/
coupon_offer: Retention.CouponOffer | null;
/**
* Type of retention strategy that will be used.
*/
type: 'coupon_offer';
}
namespace Retention {
interface CouponOffer {
/**
* The ID of the coupon to be offered.
*/
coupon: string;
}
}
}
namespace SubscriptionUpdateConfirm {
interface Discount {
/**
* The ID of the coupon to apply to this subscription update.
*/
coupon: string | null;
/**
* The ID of a promotion code to apply to this subscription update.
*/
promotion_code: string | null;
}
interface Item {
/**
* The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
*/
id: string | null;
/**
* The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
*/
price: string | null;
/**
* [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
*/
quantity?: number;
}
}
}
}
}
export declare namespace BillingPortal {
interface SessionCreateParams {
/**
* The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
*/
configuration?: string;
/**
* The ID of an existing customer.
*/
customer?: string;
/**
* The ID of an existing account.
*/
customer_account?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
*/
flow_data?: SessionCreateParams.FlowData;
/**
* The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer's `preferred_locales` or browser's locale is used.
*/
locale?: SessionCreateParams.Locale;
/**
* The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
*/
on_behalf_of?: string;
/**
* The default URL to redirect customers to when they click on the portal's link to return to your website.
*/
return_url?: string;
}
namespace SessionCreateParams {
interface FlowData {
/**
* Behavior after the flow is completed.
*/
after_completion?: FlowData.AfterCompletion;
/**
* Configuration when `flow_data.type=subscription_cancel`.
*/
subscription_cancel?: FlowData.SubscriptionCancel;
/**
* Configuration when `flow_data.type=subscription_update`.
*/
subscription_update?: FlowData.SubscriptionUpdate;
/**
* Configuration when `flow_data.type=subscription_update_confirm`.
*/
subscription_update_confirm?: FlowData.SubscriptionUpdateConfirm;
/**
* Type of flow that the customer will go through.
*/
type: FlowData.Type;
}
type Locale = 'auto' | 'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IE' | 'en-IN' | 'en-NZ' | 'en-SG' | 'es' | 'es-419' | 'et' | 'fi' | 'fil' | 'fr' | 'fr-CA' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'mt' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sv' | 'th' | 'tr' | 'vi' | 'zh' | 'zh-HK' | 'zh-TW';
namespace FlowData {
interface AfterCompletion {
/**
* Configuration when `after_completion.type=hosted_confirmation`.
*/
hosted_confirmation?: AfterCompletion.HostedConfirmation;
/**
* Configuration when `after_completion.type=redirect`.
*/
redirect?: AfterCompletion.Redirect;
/**
* The specified behavior after the flow is completed.
*/
type: AfterCompletion.Type;
}
interface SubscriptionCancel {
/**
* Specify a retention strategy to be used in the cancellation flow.
*/
retention?: SubscriptionCancel.Retention;
/**
* The ID of the subscription to be canceled.
*/
subscription: string;
}
interface SubscriptionUpdate {
/**
* The ID of the subscription to be updated.
*/
subscription: string;
}
interface SubscriptionUpdateConfirm {
/**
* The coupon or promotion code to apply to this subscription update.
*/
discounts?: Array<SubscriptionUpdateConfirm.Discount>;
/**
* The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
*/
items: Array<SubscriptionUpdateConfirm.Item>;
/**
* The ID of the subscription to be updated.
*/
subscription: string;
}
type Type = 'payment_method_update' | 'subscription_cancel' | 'subscription_update' | 'subscription_update_confirm';
namespace AfterCompletion {
interface HostedConfirmation {
/**
* A custom message to display to the customer after the flow is completed.
*/
custom_message?: string;
}
interface Redirect {
/**
* The URL the customer will be redirected to after the flow is completed.
*/
return_url: string;
}
type Type = 'hosted_confirmation' | 'portal_homepage' | 'redirect';
}
namespace SubscriptionCancel {
interface Retention {
/**
* Configuration when `retention.type=coupon_offer`.
*/
coupon_offer: Retention.CouponOffer;
/**
* Type of retention strategy to use with the customer.
*/
type: 'coupon_offer';
}
namespace Retention {
interface CouponOffer {
/**
* The ID of the coupon to be offered.
*/
coupon: string;
}
}
}
namespace SubscriptionUpdateConfirm {
interface Discount {
/**
* The ID of the coupon to apply to this subscription update.
*/
coupon?: string;
/**
* The ID of a promotion code to apply to this subscription update.
*/
promotion_code?: string;
}
interface Item {
/**
* The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
*/
id: string;
/**
* The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
*/
price?: string;
/**
* [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
*/
quantity?: number;
}
}
}
}
}

15
node_modules/stripe/cjs/resources/BillingPortal/Sessions.js generated vendored Normal file
View File

@@ -0,0 +1,15 @@
"use strict";
// File generated from our OpenAPI spec
Object.defineProperty(exports, "__esModule", { value: true });
exports.SessionResource = void 0;
const StripeResource_js_1 = require("../../StripeResource.js");
class SessionResource extends StripeResource_js_1.StripeResource {
/**
* Creates a session of the customer portal.
*/
create(params, options) {
return this._makeRequest('POST', '/v1/billing_portal/sessions', params, options);
}
}
exports.SessionResource = SessionResource;
//# sourceMappingURL=Sessions.js.map

1
node_modules/stripe/cjs/resources/BillingPortal/Sessions.js.map generated vendored Normal file
View File

@@ -0,0 +1 @@
{"version":3,"file":"Sessions.js","sourceRoot":"","sources":["../../../src/resources/BillingPortal/Sessions.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAIvD,MAAa,eAAgB,SAAQ,kCAAc;IACjD;;OAEG;IACH,MAAM,CACJ,MAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,6BAA6B,EAC7B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAfD,0CAeC"}

20
node_modules/stripe/cjs/resources/BillingPortal/index.d.ts generated vendored Normal file
View File

@@ -0,0 +1,20 @@
import { Stripe } from '../../stripe.core.js';
import { BillingPortal as BillingPortalNamespace0, Configuration, ConfigurationResource } from './Configurations.js';
import { BillingPortal as BillingPortalNamespace1, Session, SessionResource } from './Sessions.js';
export { Configuration } from './Configurations.js';
export { Session } from './Sessions.js';
export declare class BillingPortal {
private readonly stripe;
configurations: ConfigurationResource;
sessions: SessionResource;
constructor(stripe: Stripe);
}
export declare namespace BillingPortal {
export import ConfigurationListParams = BillingPortalNamespace0.ConfigurationListParams;
export import ConfigurationCreateParams = BillingPortalNamespace0.ConfigurationCreateParams;
export import ConfigurationRetrieveParams = BillingPortalNamespace0.ConfigurationRetrieveParams;
export import ConfigurationUpdateParams = BillingPortalNamespace0.ConfigurationUpdateParams;
export { Configuration };
export import SessionCreateParams = BillingPortalNamespace1.SessionCreateParams;
export { Session };
}

15
node_modules/stripe/cjs/resources/BillingPortal/index.js generated vendored Normal file
View File

@@ -0,0 +1,15 @@
"use strict";
// File generated from our OpenAPI spec
Object.defineProperty(exports, "__esModule", { value: true });
exports.BillingPortal = void 0;
const Configurations_js_1 = require("./Configurations.js");
const Sessions_js_1 = require("./Sessions.js");
class BillingPortal {
constructor(stripe) {
this.stripe = stripe;
this.configurations = new Configurations_js_1.ConfigurationResource(stripe);
this.sessions = new Sessions_js_1.SessionResource(stripe);
}
}
exports.BillingPortal = BillingPortal;
//# sourceMappingURL=index.js.map

1
node_modules/stripe/cjs/resources/BillingPortal/index.js.map generated vendored Normal file
View File

@@ -0,0 +1 @@
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/BillingPortal/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,2DAI6B;AAC7B,+CAIuB;AAKvB,MAAa,aAAa;IAIxB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;CACF;AARD,sCAQC"}