mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-08 00:02:46 -04:00
5424da3fff
* Update generated code for v1121 * Update generated code for v1126 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Co-authored-by: helenye-stripe <111009531+helenye-stripe@users.noreply.github.com>
40 lines
1.3 KiB
Ruby
40 lines
1.3 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
module BillingPortal
|
|
# The Billing customer portal is a Stripe-hosted UI for subscription and
|
|
# billing management.
|
|
#
|
|
# A portal configuration describes the functionality and features that you
|
|
# want to provide to your customers through the portal.
|
|
#
|
|
# A portal session describes the instantiation of the customer portal for
|
|
# a particular customer. By visiting the session's URL, the customer
|
|
# can manage their subscriptions and billing details. For security reasons,
|
|
# sessions are short-lived and will expire if the customer does not visit the URL.
|
|
# Create sessions on-demand when customers intend to manage their subscriptions
|
|
# and billing details.
|
|
#
|
|
# Related guide: [Customer management](https://stripe.com/customer-management)
|
|
class Session < APIResource
|
|
extend Stripe::APIOperations::Create
|
|
|
|
OBJECT_NAME = "billing_portal.session"
|
|
def self.object_name
|
|
"billing_portal.session"
|
|
end
|
|
|
|
# Creates a session of the customer portal.
|
|
def self.create(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: "/v1/billing_portal/sessions",
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|