class Stripe::BillingPortalApi
- Stripe::BillingPortalApi
- Reference
- Object
Defined in:
stripe/api/billing_portal_api.crConstant Summary
-
GET_BILLING_PORTAL_CONFIGURATIONS_CONFIGURATION_MAX_LENGTH_FOR_CONFIGURATION =
5000 -
GET_BILLING_PORTAL_CONFIGURATIONS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_BILLING_PORTAL_CONFIGURATIONS_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
POST_BILLING_PORTAL_CONFIGURATIONS_CONFIGURATION_MAX_LENGTH_FOR_CONFIGURATION =
5000 -
POST_BILLING_PORTAL_SESSIONS_MAX_LENGTH_FOR_CONFIGURATION =
5000 -
POST_BILLING_PORTAL_SESSIONS_MAX_LENGTH_FOR_CUSTOMER =
5000 -
POST_BILLING_PORTAL_SESSIONS_VALID_VALUES_FOR_LOCALE =
String.static_array("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")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_billing_portal_configurations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, active : Bool | Nil = nil, is_default : Bool | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_billing_portal_configurations_configuration(*, configuration : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_portal_configurations(*, business_profile : Stripe::BusinessProfileCreateParam | Nil = nil, features : Stripe::FeaturesCreationParam | Nil = nil, default_return_url : Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl | Nil = nil, expand : Array(String) | Nil = nil, login_page : Stripe::LoginPageCreateParam | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_portal_configurations_configuration(*, configuration : String | Nil = nil, active : Bool | Nil = nil, business_profile : Stripe::BusinessProfileUpdateParam | Nil = nil, default_return_url : Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl | Nil = nil, expand : Array(String) | Nil = nil, features : Stripe::FeaturesUpdatingParam | Nil = nil, login_page : Stripe::LoginPageUpdateParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_portal_sessions(*, customer : String | Nil = nil, configuration : String | Nil = nil, expand : Array(String) | Nil = nil, flow_data : Stripe::FlowDataParam | Nil = nil, locale : String | Nil = nil, on_behalf_of : String | Nil = nil, return_url : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_billing_portal_configurations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, active : Bool | Nil = nil, is_default : Bool | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::PortalPublicResourceConfigurationList
Returns a list of configurations that describe the functionality of the customer portal.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_billing_portal_configurations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, active : Bool | Nil = nil, is_default : Bool | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<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.
-
#get_billing_portal_configurations_configuration(*, configuration : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BillingPortalConfiguration
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. -
#get_billing_portal_configurations_configuration(*, configuration : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : 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.
-
#get_billing_portal_configurations_configuration_with_http_info(*, configuration : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BillingPortalConfiguration, Int32, Hash(String, Array(String) | String))
<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.
-
#get_billing_portal_configurations_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, active : Bool | Nil = nil, is_default : Bool | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::PortalPublicResourceConfigurationList, Int32, Hash(String, Array(String) | String))
<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.
-
#post_billing_portal_configurations(*, business_profile : Stripe::BusinessProfileCreateParam | Nil = nil, features : Stripe::FeaturesCreationParam | Nil = nil, default_return_url : Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl | Nil = nil, expand : Array(String) | Nil = nil, login_page : Stripe::LoginPageCreateParam | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Stripe::BillingPortalConfiguration
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. -
#post_billing_portal_configurations(*, business_profile : Stripe::BusinessProfileCreateParam | Nil = nil, features : Stripe::FeaturesCreationParam | Nil = nil, default_return_url : Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl | Nil = nil, expand : Array(String) | Nil = nil, login_page : Stripe::LoginPageCreateParam | Nil = nil, metadata : Hash(String, String) | Nil = nil, &block : Crest::Response -> ) : Nil
<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.
-
#post_billing_portal_configurations_configuration(*, configuration : String | Nil = nil, active : Bool | Nil = nil, business_profile : Stripe::BusinessProfileUpdateParam | Nil = nil, default_return_url : Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl | Nil = nil, expand : Array(String) | Nil = nil, features : Stripe::FeaturesUpdatingParam | Nil = nil, login_page : Stripe::LoginPageUpdateParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::BillingPortalConfiguration
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. -
#post_billing_portal_configurations_configuration(*, configuration : String | Nil = nil, active : Bool | Nil = nil, business_profile : Stripe::BusinessProfileUpdateParam | Nil = nil, default_return_url : Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl | Nil = nil, expand : Array(String) | Nil = nil, features : Stripe::FeaturesUpdatingParam | Nil = nil, login_page : Stripe::LoginPageUpdateParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : 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.
-
#post_billing_portal_configurations_configuration_with_http_info(*, configuration : String | Nil = nil, active : Bool | Nil = nil, business_profile : Stripe::BusinessProfileUpdateParam | Nil = nil, default_return_url : Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl | Nil = nil, expand : Array(String) | Nil = nil, features : Stripe::FeaturesUpdatingParam | Nil = nil, login_page : Stripe::LoginPageUpdateParam | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::BillingPortalConfiguration, Int32, Hash(String, Array(String) | String))
<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.
-
#post_billing_portal_configurations_with_http_info(*, business_profile : Stripe::BusinessProfileCreateParam | Nil = nil, features : Stripe::FeaturesCreationParam | Nil = nil, default_return_url : Stripe::PostBillingPortalConfigurationsRequestDefaultReturnUrl | Nil = nil, expand : Array(String) | Nil = nil, login_page : Stripe::LoginPageCreateParam | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Tuple(Stripe::BillingPortalConfiguration, Int32, Hash(String, Array(String) | String))
<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.
-
#post_billing_portal_sessions(*, customer : String | Nil = nil, configuration : String | Nil = nil, expand : Array(String) | Nil = nil, flow_data : Stripe::FlowDataParam | Nil = nil, locale : String | Nil = nil, on_behalf_of : String | Nil = nil, return_url : String | Nil = nil) : Stripe::BillingPortalSession
Creates a session of the customer portal.
@required @param customer [String?] The ID of an existing customer. -
#post_billing_portal_sessions(*, customer : String | Nil = nil, configuration : String | Nil = nil, expand : Array(String) | Nil = nil, flow_data : Stripe::FlowDataParam | Nil = nil, locale : String | Nil = nil, on_behalf_of : String | Nil = nil, return_url : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a session of the customer portal.</p> @required @param customer [String?] The ID of an existing customer.
-
#post_billing_portal_sessions_with_http_info(*, customer : String | Nil = nil, configuration : String | Nil = nil, expand : Array(String) | Nil = nil, flow_data : Stripe::FlowDataParam | Nil = nil, locale : String | Nil = nil, on_behalf_of : String | Nil = nil, return_url : String | Nil = nil) : Tuple(Stripe::BillingPortalSession, Int32, Hash(String, Array(String) | String))
<p>Creates a session of the customer portal.</p> @required @param customer [String?] The ID of an existing customer.
Constructor Detail
Instance Method Detail
@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