Package com.stripe.net

Class ApiResource

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
All Implemented Interfaces:
StripeActiveObject, StripeObjectInterface
Direct Known Subclasses:
Account, Account, AccountInferredBalance, AccountLink, AccountNotice, AccountSession, ActiveEntitlement, Alert, ApplePayDomain, ApplicationFee, Association, Authorization, Balance, BalanceSettings, BalanceTransaction, BankAccount, BlocklistEntry, Calculation, Capability, Card, Card, Cardholder, CashBalance, Charge, Configuration, Configuration, ConfirmationToken, ConnectionToken, CountrySpec, Coupon, CreditBalanceSummary, CreditBalanceTransaction, CreditGrant, CreditNote, CreditReversal, CreditUnderwritingRecord, Customer, CustomerBalanceTransaction, CustomerSession, DebitReversal, Dispute, Dispute, DisputeSettlementDetail, EarlyFraudWarning, EphemeralKey, Event, ExchangeRate, Feature, FeeRefund, File, FileLink, FinancialAccount, FinancingOffer, FinancingSummary, FinancingTransaction, Form, FraudLiabilityDebit, FxQuote, InboundTransfer, Institution, Invoice, InvoiceItem, InvoiceLineItem, InvoicePayment, InvoiceRenderingTemplate, Location, LoginLink, Mandate, Margin, Meter, MeterEvent, MeterEventAdjustment, MeterEventSummary, MeterUsage, OnboardingLink, Order, Order, OutboundPayment, OutboundTransfer, PagingIterator, PaymentAttemptRecord, PaymentIntent, PaymentIntentAmountDetailsLineItem, PaymentLink, PaymentMethod, PaymentMethodConfiguration, PaymentMethodDomain, PaymentRecord, Payout, Person, PersonalizationDesign, PhysicalBundle, Plan, Price, Product, Product, ProductFeature, PromotionCode, Quote, QuotePreviewInvoice, QuotePreviewSubscriptionSchedule, Reader, ReaderCollectedData, ReceivedCredit, ReceivedDebit, RedactionJob, RedactionJobValidationError, Refund, Registration, ReportRun, ReportType, Request, RequestedSession, Review, ScheduledQueryRun, SearchPagingIterator, Secret, Session, Session, Session, Settings, SetupAttempt, SetupIntent, ShippingRate, Source, Subscription, SubscriptionItem, SubscriptionSchedule, Supplier, TaxCode, TaxId, TaxRate, TestClock, Token, Token, Topup, Transaction, Transaction, Transaction, Transaction, TransactionEntry, Transfer, TransferReversal, ValueList, ValueListItem, VerificationReport, VerificationSession, WebhookEndpoint
public abstract class ApiResource extends StripeObject implements StripeActiveObject

  • Field Details

    • CHARSET

      public static final Charset CHARSET

    • INTERNAL_GSON

      public static final com.google.gson.Gson INTERNAL_GSON

    • GSON

      public static final com.google.gson.Gson GSON

  • Constructor Details

    • ApiResource

      public ApiResource()

  • Method Details

    • setGlobalResponseGetter

      public static void setGlobalResponseGetter(StripeResponseGetter srg)

    • getGlobalResponseGetter

      public static StripeResponseGetter getGlobalResponseGetter()

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter srg)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Parameters:
      srg - the StripeResponseGetter instance to use for making further requests.

    • getResponseGetter

      protected StripeResponseGetter getResponseGetter()

    • urlEncode

      public static String urlEncode(String str)
      URL-encodes a string.

    • urlEncodeId

      public static String urlEncodeId(String id) throws InvalidRequestException
      URL-encode a string ID in url path formatting.
      Throws:
      InvalidRequestException

    • checkNullTypedParams

      public static void checkNullTypedParams(String url, ApiRequestParams params)
      Invalidate null typed parameters.
      Parameters:
      url - request url associated with the given parameters.
      params - typed parameters to check for null value.

    • setExpandableFieldId

      public static <T extends HasId> ExpandableField<T> setExpandableFieldId(String newId, ExpandableField<T> currentObject)
      When setting a String ID for an ExpandableField, we need to be careful about keeping the String ID and the expanded object in sync. If they specify a new String ID that is different from the ID within the expanded object, we don't keep the object.