Table of Contents - recurly-4.65.0 Documentation
Pages
Classes and Modules
- Recurly
- Recurly::Client
- Recurly::ConnectionPool
- Recurly::Errors
- Recurly::Errors::APIError
- Recurly::Errors::BadGatewayError
- Recurly::Errors::BadRequestError
- Recurly::Errors::ClientError
- Recurly::Errors::ConnectionFailedError
- Recurly::Errors::ForbiddenError
- Recurly::Errors::ImmutableSubscriptionError
- Recurly::Errors::InternalServerError
- Recurly::Errors::InvalidApiKeyError
- Recurly::Errors::InvalidApiVersionError
- Recurly::Errors::InvalidContentTypeError
- Recurly::Errors::InvalidPermissionsError
- Recurly::Errors::InvalidTokenError
- Recurly::Errors::MissingFeatureError
- Recurly::Errors::NetworkError
- Recurly::Errors::NotAcceptableError
- Recurly::Errors::NotFoundError
- Recurly::Errors::NotModifiedError
- Recurly::Errors::PaymentRequiredError
- Recurly::Errors::PreconditionFailedError
- Recurly::Errors::RateLimitedError
- Recurly::Errors::RedirectionError
- Recurly::Errors::ResponseError
- Recurly::Errors::SSLError
- Recurly::Errors::ServerError
- Recurly::Errors::ServiceNotAvailableError
- Recurly::Errors::ServiceUnavailableError
- Recurly::Errors::SignatureVerificationError
- Recurly::Errors::SimultaneousRequestError
- Recurly::Errors::TaxServiceError
- Recurly::Errors::TimeoutError
- Recurly::Errors::TooManyRequestsError
- Recurly::Errors::TransactionError
- Recurly::Errors::UnauthorizedError
- Recurly::Errors::UnavailableInApiVersionError
- Recurly::Errors::UnknownApiVersionError
- Recurly::Errors::UnprocessableEntityError
- Recurly::Errors::ValidationError
- Recurly::FileParser
- Recurly::HTTP
- Recurly::HTTP::Request
- Recurly::HTTP::Response
- Recurly::JSONParser
- Recurly::Pager
- Recurly::Request
- Recurly::Requests
- Recurly::Requests::AccountAcquisitionCost
- Recurly::Requests::AccountAcquisitionUpdate
- Recurly::Requests::AccountCreate
- Recurly::Requests::AccountExternalSubscription
- Recurly::Requests::AccountPurchase
- Recurly::Requests::AccountReference
- Recurly::Requests::AccountUpdate
- Recurly::Requests::AddOnCreate
- Recurly::Requests::AddOnPricing
- Recurly::Requests::AddOnUpdate
- Recurly::Requests::Address
- Recurly::Requests::BillingInfoCreate
- Recurly::Requests::BillingInfoVerify
- Recurly::Requests::BillingInfoVerifyCVV
- Recurly::Requests::CouponBulkCreate
- Recurly::Requests::CouponCreate
- Recurly::Requests::CouponPricing
- Recurly::Requests::CouponRedemptionCreate
- Recurly::Requests::CouponUpdate
- Recurly::Requests::CustomField
- Recurly::Requests::DunningCampaignsBulkUpdate
- Recurly::Requests::ExternalAccountCreate
- Recurly::Requests::ExternalAccountUpdate
- Recurly::Requests::ExternalChargeCreate
- Recurly::Requests::ExternalInvoiceCreate
- Recurly::Requests::ExternalPaymentPhaseBase
- Recurly::Requests::ExternalProductCreate
- Recurly::Requests::ExternalProductReferenceBase
- Recurly::Requests::ExternalProductReferenceConnectionType
- Recurly::Requests::ExternalProductReferenceCreate
- Recurly::Requests::ExternalProductReferenceUpdate
- Recurly::Requests::ExternalProductUpdate
- Recurly::Requests::ExternalRefund
- Recurly::Requests::ExternalSubscriptionCreate
- Recurly::Requests::ExternalSubscriptionUpdate
- Recurly::Requests::ExternalTransaction
- Recurly::Requests::GatewayAttributes
- Recurly::Requests::GeneralLedgerAccountCreate
- Recurly::Requests::GeneralLedgerAccountUpdate
- Recurly::Requests::GiftCardCreate
- Recurly::Requests::GiftCardDeliveryCreate
- Recurly::Requests::GiftCardRedeem
- Recurly::Requests::InvoiceAddress
- Recurly::Requests::InvoiceCollect
- Recurly::Requests::InvoiceCreate
- Recurly::Requests::InvoiceRefund
- Recurly::Requests::InvoiceUpdate
- Recurly::Requests::ItemCreate
- Recurly::Requests::ItemUpdate
- Recurly::Requests::LineItemCreate
- Recurly::Requests::LineItemRefund
- Recurly::Requests::MeasuredUnitCreate
- Recurly::Requests::MeasuredUnitUpdate
- Recurly::Requests::PaymentGatewayReferences
- Recurly::Requests::PercentageTier
- Recurly::Requests::PercentageTiersByCurrency
- Recurly::Requests::PlanCreate
- Recurly::Requests::PlanHostedPages
- Recurly::Requests::PlanPricing
- Recurly::Requests::PlanRampInterval
- Recurly::Requests::PlanRampPricing
- Recurly::Requests::PlanUpdate
- Recurly::Requests::Pricing
- Recurly::Requests::ProrationSettings
- Recurly::Requests::PurchaseCreate
- Recurly::Requests::ShippingAddressCreate
- Recurly::Requests::ShippingAddressUpdate
- Recurly::Requests::ShippingFeeCreate
- Recurly::Requests::ShippingMethodCreate
- Recurly::Requests::ShippingMethodUpdate
- Recurly::Requests::ShippingPurchase
- Recurly::Requests::SubscriptionAddOnCreate
- Recurly::Requests::SubscriptionAddOnPercentageTier
- Recurly::Requests::SubscriptionAddOnTier
- Recurly::Requests::SubscriptionAddOnUpdate
- Recurly::Requests::SubscriptionCancel
- Recurly::Requests::SubscriptionChangeBillingInfoCreate
- Recurly::Requests::SubscriptionChangeCreate
- Recurly::Requests::SubscriptionChangeShippingCreate
- Recurly::Requests::SubscriptionCreate
- Recurly::Requests::SubscriptionPause
- Recurly::Requests::SubscriptionPurchase
- Recurly::Requests::SubscriptionRampInterval
- Recurly::Requests::SubscriptionShippingCreate
- Recurly::Requests::SubscriptionShippingPurchase
- Recurly::Requests::SubscriptionShippingUpdate
- Recurly::Requests::SubscriptionUpdate
- Recurly::Requests::Tier
- Recurly::Requests::TierPricing
- Recurly::Requests::UsageCreate
- Recurly::Resource
- Recurly::Resources
- Recurly::Resources::Account
- Recurly::Resources::AccountAcquisition
- Recurly::Resources::AccountAcquisitionCost
- Recurly::Resources::AccountBalance
- Recurly::Resources::AccountBalanceAmount
- Recurly::Resources::AccountMini
- Recurly::Resources::AccountNote
- Recurly::Resources::AddOn
- Recurly::Resources::AddOnMini
- Recurly::Resources::AddOnPricing
- Recurly::Resources::Address
- Recurly::Resources::AddressWithName
- Recurly::Resources::BillingInfo
- Recurly::Resources::BillingInfoUpdatedBy
- Recurly::Resources::BinaryFile
- Recurly::Resources::BusinessEntity
- Recurly::Resources::BusinessEntityMini
- Recurly::Resources::Coupon
- Recurly::Resources::CouponDiscount
- Recurly::Resources::CouponDiscountPricing
- Recurly::Resources::CouponDiscountTrial
- Recurly::Resources::CouponMini
- Recurly::Resources::CouponRedemption
- Recurly::Resources::CouponRedemptionMini
- Recurly::Resources::CreditPayment
- Recurly::Resources::CustomField
- Recurly::Resources::CustomFieldDefinition
- Recurly::Resources::CustomerPermission
- Recurly::Resources::DunningCampaign
- Recurly::Resources::DunningCampaignsBulkUpdateResponse
- Recurly::Resources::DunningCycle
- Recurly::Resources::DunningInterval
- Recurly::Resources::Empty
- Recurly::Resources::Entitlement
- Recurly::Resources::Entitlements
- Recurly::Resources::Error
- Recurly::Resources::ErrorMayHaveTransaction
- Recurly::Resources::ExportDates
- Recurly::Resources::ExportFile
- Recurly::Resources::ExportFiles
- Recurly::Resources::ExternalAccount
- Recurly::Resources::ExternalCharge
- Recurly::Resources::ExternalInvoice
- Recurly::Resources::ExternalPaymentPhase
- Recurly::Resources::ExternalProduct
- Recurly::Resources::ExternalProductReferenceCollection
- Recurly::Resources::ExternalProductReferenceMini
- Recurly::Resources::ExternalSubscription
- Recurly::Resources::FraudInfo
- Recurly::Resources::FraudRiskRule
- Recurly::Resources::GatewayAttributes
- Recurly::Resources::GeneralLedgerAccount
- Recurly::Resources::GiftCard
- Recurly::Resources::GiftCardDelivery
- Recurly::Resources::GrantedBy
- Recurly::Resources::Invoice
- Recurly::Resources::InvoiceAddress
- Recurly::Resources::InvoiceCollection
- Recurly::Resources::InvoiceMini
- Recurly::Resources::InvoiceTemplate
- Recurly::Resources::Item
- Recurly::Resources::ItemMini
- Recurly::Resources::LineItem
- Recurly::Resources::MeasuredUnit
- Recurly::Resources::Page
- Recurly::Resources::PaymentGatewayReferences
- Recurly::Resources::PaymentMethod
- Recurly::Resources::PercentageTier
- Recurly::Resources::PercentageTiersByCurrency
- Recurly::Resources::PerformanceObligation
- Recurly::Resources::Plan
- Recurly::Resources::PlanHostedPages
- Recurly::Resources::PlanMini
- Recurly::Resources::PlanPricing
- Recurly::Resources::PlanRampInterval
- Recurly::Resources::PlanRampPricing
- Recurly::Resources::Pricing
- Recurly::Resources::ReferenceOnlyCurrencyConversion
- Recurly::Resources::Settings
- Recurly::Resources::ShippingAddress
- Recurly::Resources::ShippingMethod
- Recurly::Resources::ShippingMethodMini
- Recurly::Resources::Site
- Recurly::Resources::Subscription
- Recurly::Resources::SubscriptionAddOn
- Recurly::Resources::SubscriptionAddOnPercentageTier
- Recurly::Resources::SubscriptionAddOnTier
- Recurly::Resources::SubscriptionChange
- Recurly::Resources::SubscriptionChangeBillingInfo
- Recurly::Resources::SubscriptionRampIntervalResponse
- Recurly::Resources::SubscriptionShipping
- Recurly::Resources::TaxDetail
- Recurly::Resources::TaxInfo
- Recurly::Resources::Tier
- Recurly::Resources::TierPricing
- Recurly::Resources::Transaction
- Recurly::Resources::TransactionError
- Recurly::Resources::TransactionFraudInfo
- Recurly::Resources::TransactionPaymentGateway
- Recurly::Resources::UniqueCouponCode
- Recurly::Resources::UniqueCouponCodeParams
- Recurly::Resources::Usage
- Recurly::Resources::User
- Recurly::Schema
- Recurly::Schema::ArrayAttribute
- Recurly::Schema::Attribute
- Recurly::Schema::BooleanAttribute
- Recurly::Schema::DateTimeAttribute
- Recurly::Schema::PrimitiveAttribute
- Recurly::Schema::RequestCaster
- Recurly::Schema::ResourceAttribute
- Recurly::Schema::ResourceCaster
- Recurly::Schema::SchemaFactory
- Recurly::Schema::SchemaValidator
- Recurly::Webhooks
Methods
- ::build — Recurly::Schema::Attribute
- ::error_class — Recurly::Errors::APIError
- ::from_json — Recurly::JSONParser
- ::from_response — Recurly::Errors::APIError
- ::get_recurly_class — Recurly::Schema
- ::new — Recurly::Client
- ::new — Recurly::ConnectionPool
- ::new — Recurly::Errors::APIError
- ::new — Recurly::HTTP::Response
- ::new — Recurly::HTTP::Request
- ::new — Recurly::Pager
- ::new — Recurly::Request
- ::new — Recurly::Resource
- ::new — Recurly::Schema
- ::new — Recurly::Schema::Attribute
- ::parse — Recurly::FileParser
- ::parse — Recurly::JSONParser
- ::recurly_class — Recurly::JSONParser
- ::secure_compare — Recurly::Webhooks
- ::verify_signature — Recurly::Webhooks
- #== — Recurly::HTTP::Request
- #== — Recurly::Request
- #== — Recurly::Resource
- #add_attribute — Recurly::Schema
- #api_version — Recurly::Client
- #apply_credit_balance — Recurly::Client
- #build_url — Recurly::Client
- #cancelPurchase — Recurly::Client
- #cancel_subscription — Recurly::Client
- #cast — Recurly::Schema::Attribute
- #cast — Recurly::Schema::DateTimeAttribute
- #cast — Recurly::Schema::ResourceAttribute
- #cast — Recurly::Schema::ArrayAttribute
- #cast — Recurly::Schema::ResourceCaster
- #cast_request — Recurly::Schema::RequestCaster
- #collect_invoice — Recurly::Client
- #convert_trial — Recurly::Client
- #count — Recurly::Pager
- #create_account — Recurly::Client
- #create_account_external_account — Recurly::Client
- #create_authorize_purchase — Recurly::Client
- #create_billing_info — Recurly::Client
- #create_capture_purchase — Recurly::Client
- #create_coupon — Recurly::Client
- #create_coupon_redemption — Recurly::Client
- #create_external_invoice — Recurly::Client
- #create_external_product — Recurly::Client
- #create_external_product_external_product_reference — Recurly::Client
- #create_external_subscription — Recurly::Client
- #create_general_ledger_account — Recurly::Client
- #create_gift_card — Recurly::Client
- #create_invoice — Recurly::Client
- #create_item — Recurly::Client
- #create_line_item — Recurly::Client
- #create_measured_unit — Recurly::Client
- #create_pending_purchase — Recurly::Client
- #create_plan — Recurly::Client
- #create_plan_add_on — Recurly::Client
- #create_purchase — Recurly::Client
- #create_shipping_address — Recurly::Client
- #create_shipping_method — Recurly::Client
- #create_subscription — Recurly::Client
- #create_subscription_change — Recurly::Client
- #create_usage — Recurly::Client
- #deactivate_account — Recurly::Client
- #deactivate_coupon — Recurly::Client
- #deactivate_external_product_external_product_reference — Recurly::Client
- #deactivate_external_products — Recurly::Client
- #deactivate_item — Recurly::Client
- #deactivate_shipping_method — Recurly::Client
- #deactivate_unique_coupon_code — Recurly::Client
- #define_attribute — Recurly::Schema::SchemaFactory
- #delete — Recurly::Client
- #delete_account_external_account — Recurly::Client
- #each — Recurly::Pager
- #each_page — Recurly::Pager
- #extract_path — Recurly::Pager
- #fetch_next! — Recurly::Pager
- #first — Recurly::Pager
- #generate_idempotency_key — Recurly::Client
- #generate_unique_coupon_codes — Recurly::Client
- #get — Recurly::Client
- #get_a_billing_info — Recurly::Client
- #get_account — Recurly::Client
- #get_account_acquisition — Recurly::Client
- #get_account_balance — Recurly::Client
- #get_account_external_account — Recurly::Client
- #get_account_note — Recurly::Client
- #get_add_on — Recurly::Client
- #get_attribute — Recurly::Schema
- #get_billing_info — Recurly::Client
- #get_business_entity — Recurly::Client
- #get_coupon — Recurly::Client
- #get_credit_payment — Recurly::Client
- #get_custom_field_definition — Recurly::Client
- #get_did_you_mean — Recurly::Schema::SchemaValidator
- #get_dunning_campaign — Recurly::Client
- #get_export_dates — Recurly::Client
- #get_export_files — Recurly::Client
- #get_external_product — Recurly::Client
- #get_external_product_external_product_reference — Recurly::Client
- #get_external_subscription — Recurly::Client
- #get_external_subscription_external_payment_phase — Recurly::Client
- #get_general_ledger_account — Recurly::Client
- #get_gift_card — Recurly::Client
- #get_invoice — Recurly::Client
- #get_invoice_pdf — Recurly::Client
- #get_invoice_template — Recurly::Client
- #get_item — Recurly::Client
- #get_line_item — Recurly::Client
- #get_measured_unit — Recurly::Client
- #get_performance_obligation — Recurly::Client
- #get_performance_obligations — Recurly::Client
- #get_plan — Recurly::Client
- #get_plan_add_on — Recurly::Client
- #get_preview_renewal — Recurly::Client
- #get_response — Recurly::Errors::APIError
- #get_response — Recurly::Resource
- #get_shipping_address — Recurly::Client
- #get_shipping_method — Recurly::Client
- #get_site — Recurly::Client
- #get_subscription — Recurly::Client
- #get_subscription_change — Recurly::Client
- #get_transaction — Recurly::Client
- #get_unique_coupon_code — Recurly::Client
- #get_usage — Recurly::Client
- #handle_response! — Recurly::Client
- #has_more? — Recurly::Pager
- #head — Recurly::Client
- #init_http_connection — Recurly::ConnectionPool
- #inspect — Recurly::Resource
- #interpolate_path — Recurly::Client
- #is_valid? — Recurly::Schema::PrimitiveAttribute
- #is_valid? — Recurly::Schema::BooleanAttribute
- #is_valid? — Recurly::Schema::DateTimeAttribute
- #is_valid? — Recurly::Schema::ResourceAttribute
- #is_valid? — Recurly::Schema::ArrayAttribute
- #item_enumerator — Recurly::Pager
- #levenshtein_distance — Recurly::Schema::SchemaValidator
- #list_account_acquisition — Recurly::Client
- #list_account_coupon_redemptions — Recurly::Client
- #list_account_credit_payments — Recurly::Client
- #list_account_external_account — Recurly::Client
- #list_account_external_invoices — Recurly::Client
- #list_account_external_subscriptions — Recurly::Client
- #list_account_invoices — Recurly::Client
- #list_account_line_items — Recurly::Client
- #list_account_notes — Recurly::Client
- #list_account_subscriptions — Recurly::Client
- #list_account_transactions — Recurly::Client
- #list_accounts — Recurly::Client
- #list_active_coupon_redemptions — Recurly::Client
- #list_add_ons — Recurly::Client
- #list_billing_infos — Recurly::Client
- #list_business_entities — Recurly::Client
- #list_business_entity_invoices — Recurly::Client
- #list_child_accounts — Recurly::Client
- #list_coupons — Recurly::Client
- #list_credit_payments — Recurly::Client
- #list_custom_field_definitions — Recurly::Client
- #list_dunning_campaigns — Recurly::Client
- #list_entitlements — Recurly::Client
- #list_external_invoices — Recurly::Client
- #list_external_product_external_product_references — Recurly::Client
- #list_external_products — Recurly::Client
- #list_external_subscription_external_invoices — Recurly::Client
- #list_external_subscription_external_payment_phases — Recurly::Client
- #list_external_subscriptions — Recurly::Client
- #list_general_ledger_accounts — Recurly::Client
- #list_gift_cards — Recurly::Client
- #list_invoice_coupon_redemptions — Recurly::Client
- #list_invoice_line_items — Recurly::Client
- #list_invoice_template_accounts — Recurly::Client
- #list_invoice_templates — Recurly::Client
- #list_invoices — Recurly::Client
- #list_items — Recurly::Client
- #list_line_items — Recurly::Client
- #list_measured_unit — Recurly::Client
- #list_plan_add_ons — Recurly::Client
- #list_plans — Recurly::Client
- #list_related_invoices — Recurly::Client
- #list_shipping_addresses — Recurly::Client
- #list_shipping_methods — Recurly::Client
- #list_sites — Recurly::Client
- #list_subscription_coupon_redemptions — Recurly::Client
- #list_subscription_invoices — Recurly::Client
- #list_subscription_line_items — Recurly::Client
- #list_subscriptions — Recurly::Client
- #list_transactions — Recurly::Client
- #list_unique_coupon_codes — Recurly::Client
- #list_usage — Recurly::Client
- #map_array_params — Recurly::Client
- #mark_invoice_failed — Recurly::Client
- #mark_invoice_successful — Recurly::Client
- #min3 — Recurly::Schema::SchemaValidator
- #page_enumerator — Recurly::Pager
- #pager — Recurly::Client
- #pause_subscription — Recurly::Client
- #post — Recurly::Client
- #preview_gift_card — Recurly::Client
- #preview_invoice — Recurly::Client
- #preview_purchase — Recurly::Client
- #preview_subscription_change — Recurly::Client
- #put — Recurly::Client
- #put_dunning_campaign_bulk_update — Recurly::Client
- #put_external_subscription — Recurly::Client
- #raise_api_error! — Recurly::Client
- #reactivate_account — Recurly::Client
- #reactivate_item — Recurly::Client
- #reactivate_subscription — Recurly::Client
- #reactivate_unique_coupon_code — Recurly::Client
- #read_headers — Recurly::Client
- #record_external_transaction — Recurly::Client
- #recurly_class — Recurly::Schema::Attribute
- #redeem_gift_card — Recurly::Client
- #refund_invoice — Recurly::Client
- #remove_a_billing_info — Recurly::Client
- #remove_account_acquisition — Recurly::Client
- #remove_billing_info — Recurly::Client
- #remove_coupon_redemption — Recurly::Client
- #remove_line_item — Recurly::Client
- #remove_measured_unit — Recurly::Client
- #remove_plan — Recurly::Client
- #remove_plan_add_on — Recurly::Client
- #remove_shipping_address — Recurly::Client
- #remove_subscription_change — Recurly::Client
- #remove_usage — Recurly::Client
- #reopen_invoice — Recurly::Client
- #requires_client? — Recurly::Pager
- #requires_client? — Recurly::Resource
- #restore_coupon — Recurly::Client
- #resume_subscription — Recurly::Client
- #rewind! — Recurly::Pager
- #run_request — Recurly::Client
- #safely_castable? — Recurly::Schema::SchemaValidator
- #schema — Recurly::Request
- #schema — Recurly::Resource
- #schema — Recurly::Schema::SchemaFactory
- #scope_by_site — Recurly::Client
- #set_api_key — Recurly::Client
- #set_connection_options — Recurly::Client
- #set_headers — Recurly::Client
- #set_http_options — Recurly::Client
- #show_external_invoice — Recurly::Client
- #status_code — Recurly::Errors::APIError
- #terminate_subscription — Recurly::Client
- #to_json — Recurly::Resource
- #to_s — Recurly::Request
- #to_s — Recurly::Resource
- #type — Recurly::Schema::DateTimeAttribute
- #update_a_billing_info — Recurly::Client
- #update_account — Recurly::Client
- #update_account_acquisition — Recurly::Client
- #update_account_external_account — Recurly::Client
- #update_billing_info — Recurly::Client
- #update_coupon — Recurly::Client
- #update_external_product — Recurly::Client
- #update_general_ledger_account — Recurly::Client
- #update_invoice — Recurly::Client
- #update_item — Recurly::Client
- #update_measured_unit — Recurly::Client
- #update_plan — Recurly::Client
- #update_plan_add_on — Recurly::Client
- #update_shipping_address — Recurly::Client
- #update_shipping_method — Recurly::Client
- #update_subscription — Recurly::Client
- #update_usage — Recurly::Client
- #validate! — Recurly::Schema::SchemaValidator
- #validate_attribute! — Recurly::Schema::SchemaValidator
- #validate_options! — Recurly::Client
- #validate_path_parameters! — Recurly::Client
- #verify_billing_info — Recurly::Client
- #verify_billing_info_cvv — Recurly::Client
- #verify_billing_infos — Recurly::Client
- #verify_billing_infos_cvv — Recurly::Client
- #void_invoice — Recurly::Client
- #with_connection — Recurly::ConnectionPool