Module: Stripe

Extended by:
Forwardable
Defined in:
lib/stripe/api_version.rb,
lib/stripe.rb,
lib/stripe/util.rb,
lib/stripe/oauth.rb,
lib/stripe/errors.rb,
lib/stripe/version.rb,
lib/stripe/webhook.rb,
lib/stripe/list_object.rb,
lib/stripe/api_resource.rb,
lib/stripe/error_object.rb,
lib/stripe/object_types.rb,
lib/stripe/stripe_client.rb,
lib/stripe/stripe_object.rb,
lib/stripe/resources/card.rb,
lib/stripe/resources/file.rb,
lib/stripe/resources/plan.rb,
lib/stripe/instrumentation.rb,
lib/stripe/resources/event.rb,
lib/stripe/resources/order.rb,
lib/stripe/resources/price.rb,
lib/stripe/resources/quote.rb,
lib/stripe/resources/token.rb,
lib/stripe/resources/topup.rb,
lib/stripe/stripe_response.rb,
lib/stripe/resources/charge.rb,
lib/stripe/resources/coupon.rb,
lib/stripe/resources/margin.rb,
lib/stripe/resources/payout.rb,
lib/stripe/resources/person.rb,
lib/stripe/resources/refund.rb,
lib/stripe/resources/review.rb,
lib/stripe/resources/source.rb,
lib/stripe/resources/tax_id.rb,
lib/stripe/multipart_encoder.rb,
lib/stripe/resources/account.rb,
lib/stripe/resources/balance.rb,
lib/stripe/resources/dispute.rb,
lib/stripe/resources/invoice.rb,
lib/stripe/resources/mandate.rb,
lib/stripe/resources/product.rb,
lib/stripe/connection_manager.rb,
lib/stripe/resources/customer.rb,
lib/stripe/resources/discount.rb,
lib/stripe/resources/reversal.rb,
lib/stripe/resources/tax/form.rb,
lib/stripe/resources/tax_code.rb,
lib/stripe/resources/tax_rate.rb,
lib/stripe/resources/transfer.rb,
lib/stripe/api_operations/list.rb,
lib/stripe/api_operations/save.rb,
lib/stripe/resources/file_link.rb,
lib/stripe/resources/line_item.rb,
lib/stripe/resources/capability.rb,
lib/stripe/resources/login_link.rb,
lib/stripe/search_result_object.rb,
lib/stripe/stripe_configuration.rb,
lib/stripe/api_operations/create.rb,
lib/stripe/api_operations/delete.rb,
lib/stripe/api_operations/search.rb,
lib/stripe/resources/apps/secret.rb,
lib/stripe/resources/credit_note.rb,
lib/stripe/resources/quote_phase.rb,
lib/stripe/api_operations/request.rb,
lib/stripe/resources/account_link.rb,
lib/stripe/resources/bank_account.rb,
lib/stripe/resources/cash_balance.rb,
lib/stripe/resources/country_spec.rb,
lib/stripe/resources/invoice_item.rb,
lib/stripe/resources/issuing/card.rb,
lib/stripe/resources/payment_link.rb,
lib/stripe/resources/setup_intent.rb,
lib/stripe/resources/subscription.rb,
lib/stripe/resources/tax/settings.rb,
lib/stripe/resources/usage_record.rb,
lib/stripe/singleton_api_resource.rb,
lib/stripe/resources/billing/alert.rb,
lib/stripe/resources/billing/meter.rb,
lib/stripe/resources/climate/order.rb,
lib/stripe/resources/ephemeral_key.rb,
lib/stripe/resources/exchange_rate.rb,
lib/stripe/resources/issuing/token.rb,
lib/stripe/resources/setup_attempt.rb,
lib/stripe/resources/shipping_rate.rb,
lib/stripe/resources/account_notice.rb,
lib/stripe/resources/alipay_account.rb,
lib/stripe/resources/payment_intent.rb,
lib/stripe/resources/payment_method.rb,
lib/stripe/resources/promotion_code.rb,
lib/stripe/api_resource_test_helpers.rb,
lib/stripe/resources/account_session.rb,
lib/stripe/resources/application_fee.rb,
lib/stripe/resources/climate/product.rb,
lib/stripe/resources/gift_cards/card.rb,
lib/stripe/resources/invoice_payment.rb,
lib/stripe/resources/issuing/dispute.rb,
lib/stripe/resources/product_feature.rb,
lib/stripe/resources/tax/association.rb,
lib/stripe/resources/tax/calculation.rb,
lib/stripe/resources/tax/transaction.rb,
lib/stripe/resources/terminal/reader.rb,
lib/stripe/resources/apple_pay_domain.rb,
lib/stripe/resources/checkout/session.rb,
lib/stripe/resources/climate/supplier.rb,
lib/stripe/resources/customer_session.rb,
lib/stripe/resources/radar/value_list.rb,
lib/stripe/resources/tax/registration.rb,
lib/stripe/resources/webhook_endpoint.rb,
lib/stripe/resources/invoice_line_item.rb,
lib/stripe/resources/subscription_item.rb,
lib/stripe/resources/terminal/location.rb,
lib/stripe/resources/confirmation_token.rb,
lib/stripe/resources/forwarding/request.rb,
lib/stripe/resources/issuing/cardholder.rb,
lib/stripe/resources/recipient_transfer.rb,
lib/stripe/resources/source_transaction.rb,
lib/stripe/api_operations/singleton_save.rb,
lib/stripe/request_signing_authenticator.rb,
lib/stripe/resources/balance_transaction.rb,
lib/stripe/resources/billing/meter_event.rb,
lib/stripe/resources/issuing/transaction.rb,
lib/stripe/api_operations/nested_resource.rb,
lib/stripe/resources/entitlements/feature.rb,
lib/stripe/resources/funding_instructions.rb,
lib/stripe/resources/reporting/report_run.rb,
lib/stripe/resources/treasury/transaction.rb,
lib/stripe/resources/usage_record_summary.rb,
lib/stripe/resources/credit_note_line_item.rb,
lib/stripe/resources/issuing/authorization.rb,
lib/stripe/resources/payment_method_domain.rb,
lib/stripe/resources/quote_preview_invoice.rb,
lib/stripe/resources/radar/value_list_item.rb,
lib/stripe/resources/reporting/report_type.rb,
lib/stripe/resources/subscription_schedule.rb,
lib/stripe/resources/application_fee_refund.rb,
lib/stripe/resources/billing_portal/session.rb,
lib/stripe/resources/gift_cards/transaction.rb,
lib/stripe/resources/terminal/configuration.rb,
lib/stripe/resources/capital/financing_offer.rb,
lib/stripe/resources/issuing/physical_bundle.rb,
lib/stripe/resources/test_helpers/test_clock.rb,
lib/stripe/resources/treasury/debit_reversal.rb,
lib/stripe/resources/treasury/received_debit.rb,
lib/stripe/resources/treasury/credit_reversal.rb,
lib/stripe/resources/treasury/received_credit.rb,
lib/stripe/resources/capital/financing_summary.rb,
lib/stripe/resources/radar/early_fraud_warning.rb,
lib/stripe/resources/sigma/scheduled_query_run.rb,
lib/stripe/resources/tax/calculation_line_item.rb,
lib/stripe/resources/tax/transaction_line_item.rb,
lib/stripe/resources/terminal/connection_token.rb,
lib/stripe/resources/treasury/inbound_transfer.rb,
lib/stripe/resources/treasury/outbound_payment.rb,
lib/stripe/resources/treasury/financial_account.rb,
lib/stripe/resources/treasury/outbound_transfer.rb,
lib/stripe/resources/treasury/transaction_entry.rb,
lib/stripe/resources/billing/meter_event_summary.rb,
lib/stripe/resources/billing_portal/configuration.rb,
lib/stripe/resources/customer_balance_transaction.rb,
lib/stripe/resources/identity/verification_report.rb,
lib/stripe/resources/payment_method_configuration.rb,
lib/stripe/resources/capital/financing_transaction.rb,
lib/stripe/resources/financial_connections/account.rb,
lib/stripe/resources/financial_connections/session.rb,
lib/stripe/resources/identity/verification_session.rb,
lib/stripe/resources/billing/meter_event_adjustment.rb,
lib/stripe/resources/issuing/personalization_design.rb,
lib/stripe/resources/entitlements/active_entitlement.rb,
lib/stripe/resources/customer_cash_balance_transaction.rb,
lib/stripe/resources/financial_connections/institution.rb,
lib/stripe/resources/financial_connections/transaction.rb,
lib/stripe/resources/issuing/credit_underwriting_record.rb,
lib/stripe/resources/financial_connections/account_owner.rb,
lib/stripe/resources/quote_preview_subscription_schedule.rb,
lib/stripe/resources/treasury/financial_account_features.rb,
lib/stripe/resources/financial_connections/account_ownership.rb,
lib/stripe/resources/financial_connections/account_inferred_balance.rb

Overview

File generated from our OpenAPI spec frozen_string_literal: true

Defined Under Namespace

Modules: APIOperations, ApiVersion, Apps, Billing, BillingPortal, Capital, Checkout, Climate, Entitlements, FinancialConnections, Forwarding, GiftCards, Identity, Issuing, OAuth, ObjectTypes, Radar, Reporting, Sigma, StripeResponseBase, Tax, Terminal, TestHelpers, Treasury, Util, Webhook Classes: APIConnectionError, APIError, APIResource, APIResourceTestHelpers, Account, AccountLink, AccountNotice, AccountSession, AlipayAccount, ApplePayDomain, ApplicationFee, ApplicationFeeRefund, AuthenticationError, Balance, BalanceTransaction, BankAccount, Capability, Card, CardError, CashBalance, Charge, ConfirmationToken, ConnectionManager, CountrySpec, Coupon, CreditNote, CreditNoteLineItem, Customer, CustomerBalanceTransaction, CustomerCashBalanceTransaction, CustomerSession, Discount, Dispute, EphemeralKey, ErrorObject, Event, ExchangeRate, File, FileLink, FundingInstructions, IdempotencyError, Instrumentation, InvalidRequestError, Invoice, InvoiceItem, InvoiceLineItem, InvoicePayment, LineItem, ListObject, LoginLink, Mandate, Margin, MultipartEncoder, OAuthErrorObject, Order, PaymentIntent, PaymentLink, PaymentMethod, PaymentMethodConfiguration, PaymentMethodDomain, Payout, PermissionError, Person, Plan, Preview, Price, Product, ProductFeature, PromotionCode, Quote, QuotePhase, QuotePreviewInvoice, QuotePreviewSubscriptionSchedule, RateLimitError, RawRequest, RecipientTransfer, Refund, RequestSigningAuthenticator, Reversal, Review, SearchResultObject, SetupAttempt, SetupIntent, ShippingRate, SignatureVerificationError, SingletonAPIResource, Source, SourceTransaction, StripeClient, StripeConfiguration, StripeError, StripeHeadersOnlyResponse, StripeObject, StripeResponse, StripeResponseHeaders, Subscription, SubscriptionItem, SubscriptionSchedule, TaxCode, TaxId, TaxRate, Token, Topup, Transfer, UsageRecord, UsageRecordSummary, WebhookEndpoint

Constant Summary collapse

DEFAULT_CA_BUNDLE_PATH = 
__dir__ + "/data/ca-certificates.crt"
LEVEL_DEBUG =

map to the same values as the standard library’s logger

Logger::DEBUG
LEVEL_ERROR = 
Logger::ERROR
LEVEL_INFO = 
Logger::INFO
VERSION = 
"12.5.0-beta.2"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Object (readonly)

Returns the value of attribute config.



72
73
74
 
# File 'lib/stripe.rb', line 72

def config
  @config
end

Class Method Details

.add_beta_version(beta_name, version) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/stripe.rb', line 124

def self.add_beta_version(beta_name, version)
  if api_version.include?("; #{beta_name}=")
    raise "Stripe version header #{api_version} already contains entry for beta #{beta_name}"
  end

  self.api_version = "#{api_version}; #{beta_name}=#{version}"
end

.app_info ⇒ Object

Gets the application for a plugin that’s identified some. See #set_app_info.



102
103
104
 
# File 'lib/stripe.rb', line 102

def self.app_info
  @app_info
end

.app_info=(info) ⇒ Object 



106
107
108
 
# File 'lib/stripe.rb', line 106

def self.app_info=(info)
  @app_info = info
end

.deserialize(data) ⇒ Object 



170
171
172
173
 
# File 'lib/stripe.rb', line 170

def self.deserialize(data)
  data = JSON.parse(data) if data.is_a?(String)
  Util.convert_to_stripe_object(data, {})
end

.raw_request(method, url, params = {}, opts = {}) ⇒ Object

Sends a request to Stripe REST API



165
166
167
168
 
# File 'lib/stripe.rb', line 165

def self.raw_request(method, url, params = {}, opts = {})
  req = RawRequest.new
  req.execute(method, url, params, opts, ["raw_request"])
end

.set_app_info(name, partner_id: nil, url: nil, version: nil) ⇒ Object

Sets some basic information about the running application that’s sent along with API requests. Useful for plugin authors to identify their plugin when communicating with Stripe.

Takes a name and optional partner program ID, plugin URL, and version.



115
116
117
118
119
120
121
122
 
# File 'lib/stripe.rb', line 115

def self.set_app_info(name, partner_id: nil, url: nil, version: nil)
  @app_info = {
    name: name,
    partner_id: partner_id,
    url: url,
    version: version,
  }
end