Package com.chargebee.v4.models

Class BaseResponse

java.lang.Object
com.chargebee.v4.models.BaseResponse
Direct Known Subclasses:
AddEntitlementOverrideForSubscriptionResponse, AddItemEntitlementsResponse, AdditionalBillingLogiqRetrieveResponse, AddonCopyResponse, AddonCreateResponse, AddonDeleteResponse, AddonRetrieveResponse, AddonUnarchiveResponse, AddonUpdateResponse, AddressRetrieveResponse, AddressUpdateResponse, AdvanceInvoiceEstimateResponse, AlertCreateResponse, AlertDeleteResponse, AlertRetrieveResponse, AlertUpdateResponse, AssignOrderNumberResponse, AttachedItemCreateResponse, AttachedItemDeleteResponse, AttachedItemRetrieveResponse, AttachedItemUpdateResponse, BrandConfigurationRetrieveResponse, BusinessEntityCreateTransfersResponse, BusinessProfileRetrieveResponse, CardRetrieveResponse, CardSwitchGatewayForCustomerResponse, CommentCreateResponse, CommentDeleteResponse, CommentRetrieveResponse, ConfigurationListResponse, CopyCardForCustomerResponse, CouponCodeArchiveResponse, CouponCodeCreateResponse, CouponCodeRetrieveResponse, CouponCopyResponse, CouponCreateForItemsResponse, CouponCreateResponse, CouponDeleteResponse, CouponRetrieveResponse, CouponSetAddCouponCodesResponse, CouponSetCreateResponse, CouponSetDeleteResponse, CouponSetDeleteUnusedCouponCodesResponse, CouponSetRetrieveResponse, CouponSetUpdateResponse, CouponUnarchiveResponse, CouponUpdateForItemsResponse, CouponUpdateResponse, CreateMediaAndAttachToItemResponse, CreateProductVariantResponse, CreateSubscriptionForCustomerEstimateResponse, CreateSubscriptionForCustomerQuoteResponse, CreateSubscriptionItemEstimateResponse, CreateSubscriptionItemForCustomerEstimateResponse, CreateSubscriptionItemsForCustomerQuoteResponse, CreateUnbilledChargeResponse, CreateVoucherPaymentSourceResponse, CreditNoteCreateResponse, CreditNoteDeleteResponse, CreditNoteDownloadEinvoiceResponse, CreditNotePdfResponse, CreditNoteRecordRefundResponse, CreditNoteRefundResponse, CreditNoteRemoveTaxWithheldRefundResponse, CreditNoteResendEinvoiceResponse, CreditNoteRetrieveResponse, CreditNoteSendEinvoiceResponse, CsvTaxRuleCreateResponse, CurrencyAddScheduleResponse, CurrencyCreateResponse, CurrencyRemoveScheduleResponse, CurrencyRetrieveResponse, CurrencyUpdateResponse, CustomerAddContactResponse, CustomerAddPromotionalCreditsResponse, CustomerAssignPaymentRoleResponse, CustomerChangeBillingDateResponse, CustomerClearPersonalDataResponse, CustomerCollectPaymentResponse, CustomerCreateResponse, CustomerDeductPromotionalCreditsResponse, CustomerDeleteContactResponse, CustomerDeleteRelationshipResponse, CustomerDeleteResponse, CustomerHierarchyResponse, CustomerMergeResponse, CustomerMoveResponse, CustomerRecordExcessPaymentResponse, CustomerRelationshipsResponse, CustomerRetrieveResponse, CustomerSetPromotionalCreditsResponse, CustomerUpdateBillingInfoResponse, CustomerUpdateContactResponse, CustomerUpdateHierarchySettingsResponse, CustomerUpdatePaymentMethodResponse, CustomerUpdateResponse, DeleteCardForCustomerResponse, DeleteOfflineTransactionResponse, DifferentialPriceCreateResponse, DifferentialPriceDeleteResponse, DifferentialPriceRetrieveResponse, DifferentialPriceUpdateResponse, DownloadEinvoiceResponse, EditCreateSubscriptionCustomerQuoteForItemsResponse, EditCreateSubscriptionForCustomerQuoteResponse, EditOneTimeQuoteResponse, EditUpdateSubscriptionQuoteForItemsResponse, EditUpdateSubscriptionQuoteResponse, EntitlementCreateResponse, EstimateCancelSubscriptionForItemsResponse, EstimateCancelSubscriptionResponse, EstimateChangeTermEndResponse, EstimateCreateInvoiceForItemsResponse, EstimateCreateInvoiceResponse, EstimateCreateSubscriptionResponse, EstimateGiftSubscriptionForItemsResponse, EstimateGiftSubscriptionResponse, EstimatePauseSubscriptionResponse, EstimatePaymentSchedulesResponse, EstimateResumeSubscriptionResponse, EstimateUpdateSubscriptionForItemsResponse, EstimateUpdateSubscriptionResponse, EventRetrieveResponse, ExportAddonsResponse, ExportAttachedItemsResponse, ExportCouponsResponse, ExportCreditNotesResponse, ExportCustomersResponse, ExportDeferredRevenueResponse, ExportDifferentialPricesResponse, ExportInvoicesResponse, ExportItemFamiliesResponse, ExportItemPricesResponse, ExportItemsResponse, ExportOrdersResponse, ExportPaymentSourceResponse, ExportPlansResponse, ExportPriceVariantsResponse, ExportRetrieveResponse, ExportRevenueRecognitionResponse, ExportSubscriptionsResponse, ExportTransactionsResponse, FeatureActivateResponse, FeatureArchiveResponse, FeatureCreateResponse, FeatureDeleteResponse, FeatureReactivateResponse, FeatureRetrieveResponse, FeatureUpdateResponse, FullExportStatusResponse, GiftCancelResponse, GiftClaimResponse, GiftCreateForItemsResponse, GiftCreateResponse, GiftRetrieveResponse, HostedPageAcceptQuoteResponse, HostedPageAcknowledgeResponse, HostedPageCheckoutExistingForItemsResponse, HostedPageCheckoutExistingResponse, HostedPageCheckoutGiftForItemsResponse, HostedPageCheckoutGiftResponse, HostedPageCheckoutNewForItemsResponse, HostedPageCheckoutNewResponse, HostedPageCheckoutOneTimeForItemsResponse, HostedPageCheckoutOneTimeResponse, HostedPageClaimGiftResponse, HostedPageCollectNowResponse, HostedPageEventsResponse, HostedPageExtendSubscriptionResponse, HostedPageManagePaymentSourcesResponse, HostedPagePreCancelResponse, HostedPageRetrieveAgreementPdfResponse, HostedPageRetrieveResponse, HostedPageUpdateCardResponse, HostedPageUpdatePaymentMethodResponse, HostedPageViewVoucherResponse, ImportCreditNoteResponse, ImportInvoiceResponse, ImportOrderResponse, ImportSubscriptionResponse, InAppSubscriptionImportReceiptResponse, InAppSubscriptionImportSubscriptionResponse, InAppSubscriptionProcessReceiptResponse, InAppSubscriptionRetrieveStoreSubscriptionsResponse, InvoiceAddAddonChargeResponse, InvoiceAddChargeItemResponse, InvoiceAddChargeResponse, InvoiceApplyCreditsResponse, InvoiceApplyPaymentScheduleSchemeResponse, InvoiceApplyPaymentsResponse, InvoiceChargeAddonResponse, InvoiceChargeResponse, InvoiceCloseResponse, InvoiceCollectPaymentResponse, InvoiceCreateForChargeItemResponse, InvoiceCreateForChargeItemsAndChargesResponse, InvoiceCreateResponse, InvoiceDeleteImportedResponse, InvoiceDeleteLineItemsResponse, InvoiceDeleteResponse, InvoicePauseDunningResponse, InvoicePaymentSchedulesResponse, InvoicePdfResponse, InvoiceRecordPaymentResponse, InvoiceRecordRefundResponse, InvoiceRecordTaxWithheldResponse, InvoiceRefundResponse, InvoiceRemoveCreditNoteResponse, InvoiceRemovePaymentResponse, InvoiceRemoveTaxWithheldResponse, InvoiceResumeDunningResponse, InvoiceRetrieveResponse, InvoiceStopDunningResponse, InvoiceSyncUsagesResponse, InvoiceUnbilledChargesResponse, InvoiceUpdateDetailsResponse, InvoiceWriteOffResponse, ItemCreateResponse, ItemDeleteResponse, ItemFamilyCreateResponse, ItemFamilyDeleteResponse, ItemFamilyRetrieveResponse, ItemFamilyUpdateResponse, ItemPriceCreateResponse, ItemPriceDeleteResponse, ItemPriceRetrieveResponse, ItemPriceUpdateResponse, ItemRetrieveResponse, ItemUpdateResponse, LedgerOperationAuthorizeResponse, LedgerOperationCaptureAuthorizationResponse, LedgerOperationCaptureResponse, LedgerOperationReleaseAuthorizationResponse, MoveItemPriceResponse, NonSubscriptionProcessReceiptResponse, OfferEventsResponse, OfferFulfillmentsGetResponse, OfferFulfillmentsResponse, OfferFulfillmentsUpdateResponse, OmnichannelOneTimeOrderRetrieveResponse, OmnichannelSubscriptionMoveResponse, OmnichannelSubscriptionRetrieveResponse, OrderCancelResponse, OrderCreateRefundableCreditNoteResponse, OrderCreateResponse, OrderDeleteResponse, OrderReopenResponse, OrderResendResponse, OrderRetrieveResponse, OrderUpdateResponse, PaymentIntentCreateResponse, PaymentIntentRetrieveResponse, PaymentIntentUpdateResponse, PaymentScheduleSchemeCreateResponse, PaymentScheduleSchemeDeleteResponse, PaymentScheduleSchemeRetrieveResponse, PaymentSourceAgreementPdfResponse, PaymentSourceCreateBankAccountResponse, PaymentSourceCreateCardResponse, PaymentSourceCreateUsingPaymentIntentResponse, PaymentSourceCreateUsingPermanentTokenResponse, PaymentSourceCreateUsingTempTokenResponse, PaymentSourceCreateUsingTokenResponse, PaymentSourceDeleteLocalResponse, PaymentSourceDeleteResponse, PaymentSourceRetrieveResponse, PaymentSourceSwitchGatewayAccountResponse, PaymentSourceUpdateBankAccountResponse, PaymentSourceUpdateCardResponse, PaymentSourceVerifyBankAccountResponse, PaymentVoucherCreateResponse, PaymentVoucherRetrieveResponse, Pc2MigrationContactSupportResponse, Pc2MigrationCreateResponse, Pc2MigrationInitiateResponse, Pc2MigrationItemCreateResponse, Pc2MigrationItemDeleteResponse, Pc2MigrationItemFamilyCreateResponse, Pc2MigrationItemFamilyDeleteResponse, Pc2MigrationItemFamilyRetrieveResponse, Pc2MigrationItemFamilyUpdateResponse, Pc2MigrationItemPriceDeleteResponse, Pc2MigrationItemPriceRetrieveResponse, Pc2MigrationItemPriceUpdateResponse, Pc2MigrationItemRetrieveResponse, Pc2MigrationItemUpdateResponse, Pc2MigrationRetrieveResponse, PersonalizedOffersResponse, PlanCopyResponse, PlanCreateResponse, PlanDeleteResponse, PlanRetrieveResponse, PlanUnarchiveResponse, PlanUpdateResponse, PortalSessionActivateResponse, PortalSessionCreateResponse, PortalSessionLogoutResponse, PortalSessionRetrieveResponse, PriceVariantCreateResponse, PriceVariantDeleteResponse, PriceVariantRetrieveResponse, PriceVariantUpdateResponse, PricingPageSessionCreateForExistingSubscriptionResponse, PricingPageSessionCreateForNewSubscriptionResponse, ProductCreateResponse, ProductDeleteResponse, ProductRetrieveResponse, ProductUpdateOptionsResponse, ProductUpdateResponse, PromotionalCreditAddResponse, PromotionalCreditDeductResponse, PromotionalCreditRetrieveResponse, PromotionalCreditSetResponse, PromotionalGrantsResponse, PurchaseCreateResponse, PurchaseEstimateResponse, QuoteConvertResponse, QuoteCreateForChargeItemsAndChargesResponse, QuoteCreateForOnetimeChargesResponse, QuoteCreateSignatureResponse, QuoteDeleteResponse, QuoteEditForChargeItemsAndChargesResponse, QuoteExtendExpiryDateResponse, QuotePdfResponse, QuoteRefreshSignatureLinkResponse, QuoteRetrieveResponse, QuoteRetrieveSignatureResponse, QuoteRetrieveSignedPdfResponse, QuoteUpdateSignatureResponse, QuoteUpdateSignatureStatusResponse, QuoteUpdateStatusResponse, RampCreateForSubscriptionResponse, RampDeleteResponse, RampRetrieveResponse, RampUpdateResponse, RecordedPurchaseCreateResponse, RecordedPurchaseRetrieveResponse, RegenerateInvoiceEstimateResponse, RenewalEstimateResponse, ResendEinvoiceResponse, ResourceMigrationRetrieveLatestResponse, RetrieveLedgerOperationResponse, RuleRetrieveResponse, SendEinvoiceResponse, SetSubscriptionEntitlementAvailabilityResponse, SubscriptionAddChargeAtTermEndResponse, SubscriptionCancelForItemsResponse, SubscriptionCancelResponse, SubscriptionChangeTermEndResponse, SubscriptionChargeAddonAtTermEndResponse, SubscriptionChargeFutureRenewalsResponse, SubscriptionCreateForCustomerResponse, SubscriptionCreateResponse, SubscriptionCreateWithItemsResponse, SubscriptionDeleteResponse, SubscriptionEditAdvanceInvoiceScheduleResponse, SubscriptionImportContractTermResponse, SubscriptionImportForCustomerResponse, SubscriptionImportForItemsResponse, SubscriptionImportUnbilledChargesResponse, SubscriptionMoveResponse, SubscriptionOverrideBillingProfileResponse, SubscriptionPauseResponse, SubscriptionReactivateResponse, SubscriptionRegenerateInvoiceResponse, SubscriptionRemoveAdvanceInvoiceScheduleResponse, SubscriptionRemoveCouponsResponse, SubscriptionRemoveScheduledCancellationResponse, SubscriptionRemoveScheduledChangesResponse, SubscriptionRemoveScheduledPauseResponse, SubscriptionRemoveScheduledResumptionResponse, SubscriptionResumeResponse, SubscriptionRetrieveAdvanceInvoiceScheduleResponse, SubscriptionRetrieveResponse, SubscriptionRetrieveWithScheduledChangesResponse, SubscriptionSettingRetrieveResponse, SubscriptionUpdateForItemsResponse, SubscriptionUpdateResponse, SyncTransactionResponse, ThirdPartyConfigurationConfigurationsResponse, ThirdPartyConfigurationRetrieveResponse, ThirdPartyConfigurationUpdateResponse, ThirdPartyEntityMappingListAllResponse, ThirdPartyEntityMappingRetrieveEntityResponse, ThirdPartyEntityMappingUpdateEntityResponse, ThirdPartySyncDetailCreateResponse, ThirdPartySyncDetailRetrieveLatestSyncResponse, ThirdPartySyncDetailRetrieveResponse, ThirdPartySyncDetailUpdateResponse, TimeMachineRetrieveResponse, TimeMachineStartAfreshResponse, TimeMachineTravelForwardResponse, TpSiteUserPayNowEnableLiveResponse, TransactionCreateAuthorizationResponse, TransactionReconcileResponse, TransactionRecordRefundResponse, TransactionRefundResponse, TransactionRetrieveResponse, UnbilledChargeCreateResponse, UnbilledChargeDeleteResponse, UnbilledChargeInvoiceNowEstimateResponse, UnbilledChargesSettingRetrieveResponse, UpcomingInvoicesEstimateResponse, UpdateCardForCustomerResponse, UpdateGiftResponse, UpdateSubscriptionQuoteForItemsResponse, UpdateSubscriptionQuoteResponse, UpsertOrRemoveItemEntitlementsForItemResponse, UsageCreateResponse, UsageDeleteResponse, UsageEventBatchIngestResponse, UsageEventCreateResponse, UsageFileProcessingStatusResponse, UsageFileUploadUrlResponse, UsagePdfResponse, UsageRetrieveResponse, VariantDeleteResponse, VariantRetrieveResponse, VariantUpdateResponse, VirtualBankAccountCreateResponse, VirtualBankAccountCreateUsingPermanentTokenResponse, VirtualBankAccountDeleteLocalResponse, VirtualBankAccountDeleteResponse, VirtualBankAccountRetrieveResponse, VirtualBankAccountSyncFundResponse, VoidCreditNoteResponse, VoidInvoiceResponse, VoidTransactionResponse, WebhookEndpointCreateResponse, WebhookEndpointDeleteResponse, WebhookEndpointRetrieveResponse, WebhookEndpointUpdateResponse
public abstract class BaseResponse extends Object
Base class for all response objects. Provides common functionality for accessing HTTP response metadata.

  • Constructor Details

    • BaseResponse

      protected BaseResponse(Response httpResponse)

  • Method Details

    • responsePayload

      public String responsePayload()
      Get the raw response payload as JSON string.

    • httpStatus

      public int httpStatus()
      Get the HTTP status code.

    • headers

      public Map<String,List<String>> headers()
      Get response headers.

    • header

      public List<String> header(String name)
      Get a specific header value.

    • isIdempotencyReplayed

      public boolean isIdempotencyReplayed()
      Check if this response is an idempotency replay. Returns true if the chargebee-idempotency-replayed header is set to "true".
      Returns:
      true if this is a replayed idempotent request, false otherwise

    • getHttpResponse

      protected Response getHttpResponse()
      Get the underlying HTTP response object.
      Returns:
      the HTTP response, or null if not available