Stripe::BillingPortalApi
Constants
Constructors
Instance methods
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Returns a list of configurations that describe the functionality of the customer portal.
@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param active [Bool?] Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). @optional @param is_default [Bool?] Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PortalPublicResourceConfigurationList]<p>Returns a list of configurations that describe the functionality of the customer portal.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param active [Bool?] Only return configurations that are active or inactive (e.g., pass true to only list active configurations).
@optional @param is_default [Bool?] Only return the default or non-default configurations (e.g., pass true to only list the default configuration).
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a configuration that describes the functionality of the customer portal.
@required @param configuration [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::BillingPortalConfiguration]<p>Retrieves a configuration that describes the functionality of the customer portal.</p> @required @param configuration [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a configuration that describes the functionality of the customer portal.</p> @required @param configuration [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::BillingPortalConfiguration, Integer, Hash)] Stripe::BillingPortalConfiguration, response status code and response headers
<p>Returns a list of configurations that describe the functionality of the customer portal.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param active [Bool?] Only return configurations that are active or inactive (e.g., pass true to only list active configurations).
@optional @param is_default [Bool?] Only return the default or non-default configurations (e.g., pass true to only list the default configuration).
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::PortalPublicResourceConfigurationList, Integer, Hash)] Stripe::PortalPublicResourceConfigurationList, response status code and response headers
Creates a configuration that describes the functionality and behavior of a PortalSession
@required @param business_profile [Stripe::BusinessProfileCreateParam?] @required @param features [Stripe::FeaturesCreationParam?] @optional @param default_return_url [Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param login_page [Stripe::LoginPageCreateParam?] @optional @param metadata [Hash(String, String)?] @return [Stripe::BillingPortalConfiguration]<p>Creates a configuration that describes the functionality and behavior of a PortalSession</p> @required @param business_profile [Stripe::BusinessProfileCreateParam?] @required @param features [Stripe::FeaturesCreationParam?] @optional @param default_return_url [Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param login_page [Stripe::LoginPageCreateParam?] @optional @param metadata [Hash(String, String)?] @return nil
Updates a configuration that describes the functionality of the customer portal.
@required @param configuration [String?] @optional @param active [Bool?] Whether the configuration is active and can be used to create portal sessions. @optional @param business_profile [Stripe::BusinessProfileUpdateParam?] @optional @param default_return_url [Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param features [Stripe::FeaturesUpdatingParam?] @optional @param login_page [Stripe::LoginPageUpdateParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::BillingPortalConfiguration]<p>Updates a configuration that describes the functionality of the customer portal.</p> @required @param configuration [String?] @optional @param active [Bool?] Whether the configuration is active and can be used to create portal sessions. @optional @param business_profile [Stripe::BusinessProfileUpdateParam?] @optional @param default_return_url [Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param features [Stripe::FeaturesUpdatingParam?] @optional @param login_page [Stripe::LoginPageUpdateParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil
<p>Updates a configuration that describes the functionality of the customer portal.</p> @required @param configuration [String?] @optional @param active [Bool?] Whether the configuration is active and can be used to create portal sessions. @optional @param business_profile [Stripe::BusinessProfileUpdateParam?] @optional @param default_return_url [Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param features [Stripe::FeaturesUpdatingParam?] @optional @param login_page [Stripe::LoginPageUpdateParam?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::BillingPortalConfiguration, Integer, Hash)] Stripe::BillingPortalConfiguration, response status code and response headers
<p>Creates a configuration that describes the functionality and behavior of a PortalSession</p> @required @param business_profile [Stripe::BusinessProfileCreateParam?] @required @param features [Stripe::FeaturesCreationParam?] @optional @param default_return_url [Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param login_page [Stripe::LoginPageCreateParam?] @optional @param metadata [Hash(String, String)?] @return [Tuple(Stripe::BillingPortalConfiguration, Integer, Hash)] Stripe::BillingPortalConfiguration, response status code and response headers
Creates a session of the customer portal.
@required @param customer [String?] The ID of an existing customer. @optional @param configuration [String?] The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param flow_data [Stripe::FlowDataParam?] @optional @param locale [String?] 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. @optional @param on_behalf_of [String?] 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://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. @optional @param return_url [String?] The default URL to redirect customers to when they click on the portal's link to return to your website. @return [Stripe::BillingPortalSession]<p>Creates a session of the customer portal.</p>
@required @param customer [String?] The ID of an existing customer.
@optional @param configuration [String?] The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param flow_data [Stripe::FlowDataParam?]
@optional @param locale [String?] 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.
@optional @param on_behalf_of [String?] 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. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays.
@optional @param return_url [String?] The default URL to redirect customers to when they click on the portal's link to return to your website.
@return nil
<p>Creates a session of the customer portal.</p>
@required @param customer [String?] The ID of an existing customer.
@optional @param configuration [String?] The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param flow_data [Stripe::FlowDataParam?]
@optional @param locale [String?] 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.
@optional @param on_behalf_of [String?] 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. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays.
@optional @param return_url [String?] The default URL to redirect customers to when they click on the portal's link to return to your website.
@return [Tuple(Stripe::BillingPortalSession, Integer, Hash)] Stripe::BillingPortalSession, response status code and response headers