Class: Recurly::Client
- Inherits:
-
Object
- Object
- Recurly::Client
- Defined in:
- lib/recurly/client.rb,
lib/recurly/client/operations.rb
Constant Summary collapse
- API_HOSTS =
{ us: "https://v3.recurly.com", eu: "https://v3.eu.recurly.com", }
- REGION =
:us
- CA_FILE =
File.join(File.dirname(__FILE__), "../data/ca-certificates.crt")
- BINARY_TYPES =
[ "application/pdf", ].freeze
- JSON_CONTENT_TYPE =
"application/json"
- MAX_RETRIES =
3
- LOG_LEVELS =
%i(debug info warn error fatal).freeze
- BASE36_ALPHABET =
(("0".."9").to_a + ("a".."z").to_a).freeze
- ALLOWED_OPTIONS =
[ :site_id, :open_timeout, :read_timeout, :body, :params, :headers, ].freeze
Class Attribute Summary collapse
Instance Method Summary collapse
- #api_version ⇒ Object
-
#apply_credit_balance(invoice_id:, **options) ⇒ Resources::Invoice
Apply available credit to a pending or past due charge invoice.
-
#cancel_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Cancel a subscription.
-
#cancelPurchase(transaction_id:, **options) ⇒ Resources::InvoiceCollection
Cancel Purchase.
-
#collect_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Collect a pending or past due, automatic invoice.
-
#convert_trial(subscription_id:, **options) ⇒ Resources::Subscription
Convert trial subscription.
-
#create_account(body:, **options) ⇒ Resources::Account
Create an account.
-
#create_account_external_account(account_id:, body:, **options) ⇒ Resources::ExternalAccount
Create an external account.
-
#create_authorize_purchase(body:, **options) ⇒ Resources::InvoiceCollection
Authorize a purchase.
-
#create_billing_info(account_id:, body:, **options) ⇒ Resources::BillingInfo
Add new billing information on an account.
-
#create_capture_purchase(transaction_id:, **options) ⇒ Resources::InvoiceCollection
Capture a purchase.
-
#create_coupon(body:, **options) ⇒ Resources::Coupon
Create a new coupon.
-
#create_coupon_redemption(account_id:, body:, **options) ⇒ Resources::CouponRedemption
Generate an active coupon redemption on an account or subscription.
-
#create_external_invoice(external_subscription_id:, body:, **options) ⇒ Resources::ExternalInvoice
Create an external invoice.
-
#create_external_product(body:, **options) ⇒ Resources::ExternalProduct
Create an external product.
-
#create_external_product_external_product_reference(external_product_id:, body:, **options) ⇒ Resources::ExternalProductReferenceMini
Create an external product reference on an external product.
-
#create_external_subscription(body:, **options) ⇒ Resources::ExternalSubscription
Create an external subscription.
-
#create_general_ledger_account(body:, **options) ⇒ Resources::GeneralLedgerAccount
Create a new general ledger account.
-
#create_gift_card(body:, **options) ⇒ Resources::GiftCard
Create gift card.
-
#create_invoice(account_id:, body:, **options) ⇒ Resources::InvoiceCollection
Create an invoice for pending line items.
-
#create_item(body:, **options) ⇒ Resources::Item
Create a new item.
-
#create_line_item(account_id:, body:, **options) ⇒ Resources::LineItem
Create a new line item for the account.
-
#create_measured_unit(body:, **options) ⇒ Resources::MeasuredUnit
Create a new measured unit.
-
#create_pending_purchase(body:, **options) ⇒ Resources::InvoiceCollection
Create a pending purchase.
-
#create_plan(body:, **options) ⇒ Resources::Plan
Create a plan.
-
#create_plan_add_on(plan_id:, body:, **options) ⇒ Resources::AddOn
Create an add-on.
-
#create_purchase(body:, **options) ⇒ Resources::InvoiceCollection
Create a new purchase.
-
#create_shipping_address(account_id:, body:, **options) ⇒ Resources::ShippingAddress
Create a new shipping address for the account.
-
#create_shipping_method(body:, **options) ⇒ Resources::ShippingMethod
Create a new shipping method.
-
#create_subscription(body:, **options) ⇒ Resources::Subscription
Create a new subscription.
-
#create_subscription_change(subscription_id:, body:, **options) ⇒ Resources::SubscriptionChange
Create a new subscription change.
-
#create_usage(subscription_id:, add_on_id:, body:, **options) ⇒ Resources::Usage
Log a usage record on this subscription add-on.
-
#deactivate_account(account_id:, **options) ⇒ Resources::Account
Deactivate an account.
-
#deactivate_coupon(coupon_id:, **options) ⇒ Resources::Coupon
Expire a coupon.
-
#deactivate_external_product_external_product_reference(external_product_id:, external_product_reference_id:, **options) ⇒ Resources::ExternalProductReferenceMini
Deactivate an external product reference.
-
#deactivate_external_products(external_product_id:, **options) ⇒ Resources::ExternalProduct
Deactivate an external product.
-
#deactivate_item(item_id:, **options) ⇒ Resources::Item
Deactivate an item.
-
#deactivate_shipping_method(shipping_method_id:, **options) ⇒ Resources::ShippingMethod
Deactivate a shipping method.
-
#deactivate_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode
Deactivate a unique coupon code.
-
#delete_account_external_account(account_id:, external_account_id:, **options) ⇒ Resources::ExternalAccount
Delete an external account for an account.
-
#generate_unique_coupon_codes(coupon_id:, body:, **options) ⇒ Resources::UniqueCouponCodeParams
Generate unique coupon codes.
-
#get_a_billing_info(account_id:, billing_info_id:, **options) ⇒ Resources::BillingInfo
Fetch a billing info.
-
#get_account(account_id:, **options) ⇒ Resources::Account
Fetch an account.
-
#get_account_acquisition(account_id:, **options) ⇒ Resources::AccountAcquisition
Fetch an account's acquisition data.
-
#get_account_balance(account_id:, **options) ⇒ Resources::AccountBalance
Fetch an account's balance and past due status.
-
#get_account_external_account(account_id:, external_account_id:, **options) ⇒ Resources::ExternalAccount
Get an external account for an account.
-
#get_account_note(account_id:, account_note_id:, **options) ⇒ Resources::AccountNote
Fetch an account note.
-
#get_add_on(add_on_id:, **options) ⇒ Resources::AddOn
Fetch an add-on.
-
#get_billing_info(account_id:, **options) ⇒ Resources::BillingInfo
Fetch an account's billing information.
-
#get_business_entity(business_entity_id:, **options) ⇒ Resources::BusinessEntity
Fetch a business entity.
-
#get_coupon(coupon_id:, **options) ⇒ Resources::Coupon
Fetch a coupon.
-
#get_credit_payment(credit_payment_id:, **options) ⇒ Resources::CreditPayment
Fetch a credit payment.
-
#get_custom_field_definition(custom_field_definition_id:, **options) ⇒ Resources::CustomFieldDefinition
Fetch an custom field definition.
-
#get_dunning_campaign(dunning_campaign_id:, **options) ⇒ Resources::DunningCampaign
Fetch a dunning campaign.
-
#get_export_dates(**options) ⇒ Resources::ExportDates
List the dates that have an available export to download.
-
#get_export_files(export_date:, **options) ⇒ Resources::ExportFiles
List of the export files that are available to download.
-
#get_external_product(external_product_id:, **options) ⇒ Resources::ExternalProduct
Fetch an external product.
-
#get_external_product_external_product_reference(external_product_id:, external_product_reference_id:, **options) ⇒ Resources::ExternalProductReferenceMini
Fetch an external product reference.
-
#get_external_subscription(external_subscription_id:, **options) ⇒ Resources::ExternalSubscription
Fetch an external subscription.
-
#get_external_subscription_external_payment_phase(external_subscription_id:, external_payment_phase_id:, **options) ⇒ Resources::ExternalPaymentPhase
Fetch an external payment phase.
-
#get_general_ledger_account(general_ledger_account_id:, **options) ⇒ Resources::GeneralLedgerAccount
Fetch a general ledger account.
-
#get_gift_card(gift_card_id:, **options) ⇒ Resources::GiftCard
Fetch a gift card.
-
#get_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Fetch an invoice.
-
#get_invoice_pdf(invoice_id:, **options) ⇒ Resources::BinaryFile
Fetch an invoice as a PDF.
-
#get_invoice_template(invoice_template_id:, **options) ⇒ Resources::InvoiceTemplate
Fetch an invoice template.
-
#get_item(item_id:, **options) ⇒ Resources::Item
Fetch an item.
-
#get_line_item(line_item_id:, **options) ⇒ Resources::LineItem
Fetch a line item.
-
#get_measured_unit(measured_unit_id:, **options) ⇒ Resources::MeasuredUnit
Fetch a measured unit.
-
#get_performance_obligation(performance_obligation_id:, **options) ⇒ Resources::PerformanceObligation
Get a single Performance Obligation.
-
#get_performance_obligations(**options) ⇒ Pager<Resources::PerformanceObligation>
Get a site's Performance Obligations.
-
#get_plan(plan_id:, **options) ⇒ Resources::Plan
Fetch a plan.
-
#get_plan_add_on(plan_id:, add_on_id:, **options) ⇒ Resources::AddOn
Fetch a plan's add-on.
-
#get_preview_renewal(subscription_id:, **options) ⇒ Resources::InvoiceCollection
Fetch a preview of a subscription's renewal invoice(s).
-
#get_shipping_address(account_id:, shipping_address_id:, **options) ⇒ Resources::ShippingAddress
Fetch an account's shipping address.
-
#get_shipping_method(shipping_method_id:, **options) ⇒ Resources::ShippingMethod
Fetch a shipping method.
-
#get_site(site_id:, **options) ⇒ Resources::Site
Fetch a site.
-
#get_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Fetch a subscription.
-
#get_subscription_change(subscription_id:, **options) ⇒ Resources::SubscriptionChange
Fetch a subscription's pending change.
-
#get_transaction(transaction_id:, **options) ⇒ Resources::Transaction
Fetch a transaction.
-
#get_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode
Fetch a unique coupon code.
-
#get_usage(usage_id:, **options) ⇒ Resources::Usage
Get a usage record.
-
#initialize(region: REGION, base_url: , ca_file: CA_FILE, api_key:, logger: nil, keep_alive_timeout: 600) {|_self| ... } ⇒ Client
constructor
Initialize a client.
-
#list_account_acquisition(**options) ⇒ Pager<Resources::AccountAcquisition>
List a site's account acquisition data.
-
#list_account_coupon_redemptions(account_id:, **options) ⇒ Pager<Resources::CouponRedemption>
List the coupon redemptions for an account.
-
#list_account_credit_payments(account_id:, **options) ⇒ Pager<Resources::CreditPayment>
List an account's credit payments.
-
#list_account_external_account(account_id:, **options) ⇒ Pager<Resources::ExternalAccount>
List external accounts for an account.
-
#list_account_external_invoices(account_id:, **options) ⇒ Pager<Resources::ExternalInvoice>
List the external invoices on an account.
-
#list_account_external_subscriptions(account_id:, **options) ⇒ Pager<Resources::ExternalSubscription>
List an account's external subscriptions.
-
#list_account_invoices(account_id:, **options) ⇒ Pager<Resources::Invoice>
List an account's invoices.
-
#list_account_line_items(account_id:, **options) ⇒ Pager<Resources::LineItem>
List an account's line items.
-
#list_account_notes(account_id:, **options) ⇒ Pager<Resources::AccountNote>
List an account's notes.
-
#list_account_subscriptions(account_id:, **options) ⇒ Pager<Resources::Subscription>
List an account's subscriptions.
-
#list_account_transactions(account_id:, **options) ⇒ Pager<Resources::Transaction>
List an account's transactions.
-
#list_accounts(**options) ⇒ Pager<Resources::Account>
List a site's accounts.
-
#list_active_coupon_redemptions(account_id:, **options) ⇒ Pager<Resources::CouponRedemption>
List the coupon redemptions that are active on an account.
-
#list_add_ons(**options) ⇒ Pager<Resources::AddOn>
List a site's add-ons.
-
#list_billing_infos(account_id:, **options) ⇒ Pager<Resources::BillingInfo>
Get the list of billing information associated with an account.
-
#list_business_entities(**options) ⇒ Pager<Resources::BusinessEntity>
List business entities.
-
#list_business_entity_invoices(business_entity_id:, **options) ⇒ Pager<Resources::Invoice>
List a business entity's invoices.
-
#list_child_accounts(account_id:, **options) ⇒ Pager<Resources::Account>
List an account's child accounts.
-
#list_coupons(**options) ⇒ Pager<Resources::Coupon>
List a site's coupons.
-
#list_credit_payments(**options) ⇒ Pager<Resources::CreditPayment>
List a site's credit payments.
-
#list_custom_field_definitions(**options) ⇒ Pager<Resources::CustomFieldDefinition>
List a site's custom field definitions.
-
#list_dunning_campaigns(**options) ⇒ Pager<Resources::DunningCampaign>
List the dunning campaigns for a site.
-
#list_entitlements(account_id:, **options) ⇒ Pager<Resources::Entitlements>
List entitlements granted to an account.
-
#list_external_invoices(**options) ⇒ Pager<Resources::ExternalInvoice>
List the external invoices on a site.
-
#list_external_product_external_product_references(external_product_id:, **options) ⇒ Pager<Resources::ExternalProductReferenceCollection>
List the external product references for an external product.
-
#list_external_products(**options) ⇒ Pager<Resources::ExternalProduct>
List a site's external products.
-
#list_external_subscription_external_invoices(external_subscription_id:, **options) ⇒ Pager<Resources::ExternalInvoice>
List the external invoices on an external subscription.
-
#list_external_subscription_external_payment_phases(external_subscription_id:, **options) ⇒ Pager<Resources::ExternalPaymentPhase>
List the external payment phases on an external subscription.
-
#list_external_subscriptions(**options) ⇒ Pager<Resources::ExternalSubscription>
List the external subscriptions on a site.
-
#list_general_ledger_accounts(**options) ⇒ Pager<Resources::GeneralLedgerAccount>
List a site's general ledger accounts.
-
#list_gift_cards(**options) ⇒ Pager<Resources::GiftCard>
List gift cards.
-
#list_invoice_coupon_redemptions(invoice_id:, **options) ⇒ Pager<Resources::CouponRedemption>
List the coupon redemptions applied to an invoice.
-
#list_invoice_line_items(invoice_id:, **options) ⇒ Pager<Resources::LineItem>
List an invoice's line items.
-
#list_invoice_template_accounts(invoice_template_id:, **options) ⇒ Pager<Resources::Account>
List an invoice template's associated accounts.
-
#list_invoice_templates(**options) ⇒ Pager<Resources::InvoiceTemplate>
Show the invoice templates for a site.
-
#list_invoices(**options) ⇒ Pager<Resources::Invoice>
List a site's invoices.
-
#list_items(**options) ⇒ Pager<Resources::Item>
List a site's items.
-
#list_line_items(**options) ⇒ Pager<Resources::LineItem>
List a site's line items.
-
#list_measured_unit(**options) ⇒ Pager<Resources::MeasuredUnit>
List a site's measured units.
-
#list_plan_add_ons(plan_id:, **options) ⇒ Pager<Resources::AddOn>
List a plan's add-ons.
-
#list_plans(**options) ⇒ Pager<Resources::Plan>
List a site's plans.
-
#list_related_invoices(invoice_id:, **options) ⇒ Pager<Resources::Invoice>
List an invoice's related credit or charge invoices.
-
#list_shipping_addresses(account_id:, **options) ⇒ Pager<Resources::ShippingAddress>
Fetch a list of an account's shipping addresses.
-
#list_shipping_methods(**options) ⇒ Pager<Resources::ShippingMethod>
List a site's shipping methods.
-
#list_sites(**options) ⇒ Pager<Resources::Site>
List sites.
-
#list_subscription_coupon_redemptions(subscription_id:, **options) ⇒ Pager<Resources::CouponRedemption>
List the coupon redemptions for a subscription.
-
#list_subscription_invoices(subscription_id:, **options) ⇒ Pager<Resources::Invoice>
List a subscription's invoices.
-
#list_subscription_line_items(subscription_id:, **options) ⇒ Pager<Resources::LineItem>
List a subscription's line items.
-
#list_subscriptions(**options) ⇒ Pager<Resources::Subscription>
List a site's subscriptions.
-
#list_transactions(**options) ⇒ Pager<Resources::Transaction>
List a site's transactions.
-
#list_unique_coupon_codes(coupon_id:, **options) ⇒ Pager<Resources::UniqueCouponCode>
List unique coupon codes associated with a bulk coupon.
-
#list_usage(subscription_id:, add_on_id:, **options) ⇒ Pager<Resources::Usage>
List a subscription add-on's usage records.
-
#mark_invoice_failed(invoice_id:, **options) ⇒ Resources::Invoice
Mark an open invoice as failed.
-
#mark_invoice_successful(invoice_id:, **options) ⇒ Resources::Invoice
Mark an open invoice as successful.
-
#pause_subscription(subscription_id:, body:, **options) ⇒ Resources::Subscription
Pause subscription.
-
#preview_gift_card(body:, **options) ⇒ Resources::GiftCard
Preview gift card.
-
#preview_invoice(account_id:, body:, **options) ⇒ Resources::InvoiceCollection
Preview new invoice for pending line items.
-
#preview_purchase(body:, **options) ⇒ Resources::InvoiceCollection
Preview a new purchase.
-
#preview_subscription_change(subscription_id:, body:, **options) ⇒ Resources::SubscriptionChange
Preview a new subscription change.
-
#put_dunning_campaign_bulk_update(dunning_campaign_id:, body:, **options) ⇒ Resources::DunningCampaignsBulkUpdateResponse
Assign a dunning campaign to multiple plans.
-
#put_external_subscription(external_subscription_id:, **options) ⇒ Resources::ExternalSubscription
Update an external subscription.
-
#reactivate_account(account_id:, **options) ⇒ Resources::Account
Reactivate an inactive account.
-
#reactivate_item(item_id:, **options) ⇒ Resources::Item
Reactivate an inactive item.
-
#reactivate_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Reactivate a canceled subscription.
-
#reactivate_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode
Restore a unique coupon code.
-
#record_external_transaction(invoice_id:, body:, **options) ⇒ Resources::Transaction
Record an external payment for a manual invoices.
-
#redeem_gift_card(redemption_code:, body:, **options) ⇒ Resources::GiftCard
Redeem gift card.
-
#refund_invoice(invoice_id:, body:, **options) ⇒ Resources::Invoice
Refund an invoice.
-
#remove_a_billing_info(account_id:, billing_info_id:, **options) ⇒ Resources::Empty
Remove an account's billing information.
-
#remove_account_acquisition(account_id:, **options) ⇒ Resources::Empty
Remove an account's acquisition data.
-
#remove_billing_info(account_id:, **options) ⇒ Resources::Empty
Remove an account's billing information.
-
#remove_coupon_redemption(account_id:, **options) ⇒ Resources::CouponRedemption
Delete the active coupon redemption from an account.
-
#remove_line_item(line_item_id:, **options) ⇒ Resources::Empty
Delete an uninvoiced line item.
-
#remove_measured_unit(measured_unit_id:, **options) ⇒ Resources::MeasuredUnit
Remove a measured unit.
-
#remove_plan(plan_id:, **options) ⇒ Resources::Plan
Remove a plan.
-
#remove_plan_add_on(plan_id:, add_on_id:, **options) ⇒ Resources::AddOn
Remove an add-on.
-
#remove_shipping_address(account_id:, shipping_address_id:, **options) ⇒ Resources::Empty
Remove an account's shipping address.
-
#remove_subscription_change(subscription_id:, **options) ⇒ Resources::Empty
Delete the pending subscription change.
-
#remove_usage(usage_id:, **options) ⇒ Resources::Empty
Delete a usage record.
-
#reopen_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Reopen a closed, manual invoice.
-
#restore_coupon(coupon_id:, body:, **options) ⇒ Resources::Coupon
Restore an inactive coupon.
-
#resume_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Resume subscription.
-
#show_external_invoice(external_invoice_id:, **options) ⇒ Resources::ExternalInvoice
Fetch an external invoice.
-
#terminate_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Terminate a subscription.
-
#update_a_billing_info(account_id:, billing_info_id:, body:, **options) ⇒ Resources::BillingInfo
Update an account's billing information.
-
#update_account(account_id:, body:, **options) ⇒ Resources::Account
Update an account.
-
#update_account_acquisition(account_id:, body:, **options) ⇒ Resources::AccountAcquisition
Update an account's acquisition data.
-
#update_account_external_account(account_id:, external_account_id:, body:, **options) ⇒ Resources::ExternalAccount
Update an external account.
-
#update_billing_info(account_id:, body:, **options) ⇒ Resources::BillingInfo
Set an account's billing information.
-
#update_coupon(coupon_id:, body:, **options) ⇒ Resources::Coupon
Update an active coupon.
-
#update_external_product(external_product_id:, body:, **options) ⇒ Resources::ExternalProduct
Update an external product.
-
#update_general_ledger_account(general_ledger_account_id:, body:, **options) ⇒ Resources::GeneralLedgerAccount
Update a general ledger account.
-
#update_invoice(invoice_id:, body:, **options) ⇒ Resources::Invoice
Update an invoice.
-
#update_item(item_id:, body:, **options) ⇒ Resources::Item
Update an active item.
-
#update_measured_unit(measured_unit_id:, body:, **options) ⇒ Resources::MeasuredUnit
Update a measured unit.
-
#update_plan(plan_id:, body:, **options) ⇒ Resources::Plan
Update a plan.
-
#update_plan_add_on(plan_id:, add_on_id:, body:, **options) ⇒ Resources::AddOn
Update an add-on.
-
#update_shipping_address(account_id:, shipping_address_id:, body:, **options) ⇒ Resources::ShippingAddress
Update an account's shipping address.
-
#update_shipping_method(shipping_method_id:, body:, **options) ⇒ Resources::ShippingMethod
Update an active Shipping Method.
-
#update_subscription(subscription_id:, body:, **options) ⇒ Resources::Subscription
Update a subscription.
-
#update_usage(usage_id:, body:, **options) ⇒ Resources::Usage
Update a usage record.
-
#verify_billing_info(account_id:, **options) ⇒ Resources::Transaction
Verify an account's credit card billing information.
-
#verify_billing_info_cvv(account_id:, body:, **options) ⇒ Resources::Transaction
Verify an account's credit card billing cvv.
-
#verify_billing_infos(account_id:, billing_info_id:, **options) ⇒ Resources::Transaction
Verify a billing information's credit card.
-
#verify_billing_infos_cvv(account_id:, billing_info_id:, body:, **options) ⇒ Resources::Transaction
Verify a billing information's credit card cvv.
-
#void_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Void a credit invoice.
Constructor Details
#initialize(region: REGION, base_url: , ca_file: CA_FILE, api_key:, logger: nil, keep_alive_timeout: 600) {|_self| ... } ⇒ Client
Initialize a client. It requires an API key.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/recurly/client.rb', line 64 def initialize(region: REGION, base_url: API_HOSTS[:us], ca_file: CA_FILE, api_key:, logger: nil, keep_alive_timeout: 600) raise ArgumentError, "'api_key' must be set to a non-nil value" if api_key.nil? raise ArgumentError, "Invalid region type. Expected one of: #{API_HOSTS.keys.join(", ")}" if !API_HOSTS.key?(region) base_url = API_HOSTS[region] if base_url == API_HOSTS[:us] && API_HOSTS.key?(region) set_api_key(api_key) (base_url, ca_file, keep_alive_timeout) if logger.nil? @logger = Logger.new(STDOUT).tap do |l| l.level = Logger::WARN end else unless LOG_LEVELS.all? { |lev| logger.respond_to?(lev) } raise ArgumentError, "You must pass in a logger implementation that responds to the following messages: #{LOG_LEVELS}" end @logger = logger end if @logger.level < Logger::INFO msg = <<-MSG The Recurly logger should not be initialized beyond the level INFO. It is currently configured to emit headers and request / response bodies. This has the potential to leak PII and other sensitive information and should never be used in production. MSG log_warn("SECURITY_WARNING", message: msg) end # execute block with this client if given yield(self) if block_given? end |
Class Attribute Details
.connection_pool ⇒ Recurly::ConnectionPool
171 172 173 |
# File 'lib/recurly/client.rb', line 171 def connection_pool @connection_pool end |
Instance Method Details
#api_version ⇒ Object
7 8 9 |
# File 'lib/recurly/client/operations.rb', line 7 def api_version "v2021-02-25" end |
#apply_credit_balance(invoice_id:, **options) ⇒ Resources::Invoice
Apply available credit to a pending or past due charge invoice
2661 2662 2663 2664 |
# File 'lib/recurly/client/operations.rb', line 2661 def apply_credit_balance(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/apply_credit_balance", invoice_id: invoice_id) put(path, **) end |
#cancel_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Cancel a subscription
3751 3752 3753 3754 |
# File 'lib/recurly/client/operations.rb', line 3751 def cancel_subscription(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/cancel", subscription_id: subscription_id) put(path, [:body], Requests::SubscriptionCancel, **) end |
#cancelPurchase(transaction_id:, **options) ⇒ Resources::InvoiceCollection
Cancel Purchase
4496 4497 4498 4499 |
# File 'lib/recurly/client/operations.rb', line 4496 def cancelPurchase(transaction_id:, **) path = interpolate_path("/purchases/{transaction_id}/cancel/", transaction_id: transaction_id) post(path, **) end |
#collect_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Collect a pending or past due, automatic invoice
2685 2686 2687 2688 |
# File 'lib/recurly/client/operations.rb', line 2685 def collect_invoice(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/collect", invoice_id: invoice_id) put(path, [:body], Requests::InvoiceCollect, **) end |
#convert_trial(subscription_id:, **options) ⇒ Resources::Subscription
Convert trial subscription
3845 3846 3847 3848 |
# File 'lib/recurly/client/operations.rb', line 3845 def convert_trial(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/convert_trial", subscription_id: subscription_id) put(path, **) end |
#create_account(body:, **options) ⇒ Resources::Account
Create an account
169 170 171 172 |
# File 'lib/recurly/client/operations.rb', line 169 def create_account(body:, **) path = "/accounts" post(path, body, Requests::AccountCreate, **) end |
#create_account_external_account(account_id:, body:, **options) ⇒ Resources::ExternalAccount
Create an external account
809 810 811 812 |
# File 'lib/recurly/client/operations.rb', line 809 def create_account_external_account(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/external_accounts", account_id: account_id) post(path, body, Requests::ExternalAccountCreate, **) end |
#create_authorize_purchase(body:, **options) ⇒ Resources::InvoiceCollection
Authorize a purchase
4468 4469 4470 4471 |
# File 'lib/recurly/client/operations.rb', line 4468 def (body:, **) path = "/purchases/authorize" post(path, body, Requests::PurchaseCreate, **) end |
#create_billing_info(account_id:, body:, **options) ⇒ Resources::BillingInfo
Add new billing information on an account
541 542 543 544 |
# File 'lib/recurly/client/operations.rb', line 541 def create_billing_info(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/billing_infos", account_id: account_id) post(path, body, Requests::BillingInfoCreate, **) end |
#create_capture_purchase(transaction_id:, **options) ⇒ Resources::InvoiceCollection
Capture a purchase
4482 4483 4484 4485 |
# File 'lib/recurly/client/operations.rb', line 4482 def create_capture_purchase(transaction_id:, **) path = interpolate_path("/purchases/{transaction_id}/capture", transaction_id: transaction_id) post(path, **) end |
#create_coupon(body:, **options) ⇒ Resources::Coupon
Create a new coupon
1595 1596 1597 1598 |
# File 'lib/recurly/client/operations.rb', line 1595 def create_coupon(body:, **) path = "/coupons" post(path, body, Requests::CouponCreate, **) end |
#create_coupon_redemption(account_id:, body:, **options) ⇒ Resources::CouponRedemption
Generate an active coupon redemption on an account or subscription
720 721 722 723 |
# File 'lib/recurly/client/operations.rb', line 720 def create_coupon_redemption(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/coupon_redemptions/active", account_id: account_id) post(path, body, Requests::CouponRedemptionCreate, **) end |
#create_external_invoice(external_subscription_id:, body:, **options) ⇒ Resources::ExternalInvoice
Create an external invoice
2508 2509 2510 2511 |
# File 'lib/recurly/client/operations.rb', line 2508 def create_external_invoice(external_subscription_id:, body:, **) path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_invoices", external_subscription_id: external_subscription_id) post(path, body, Requests::ExternalInvoiceCreate, **) end |
#create_external_product(body:, **options) ⇒ Resources::ExternalProduct
Create an external product
2307 2308 2309 2310 |
# File 'lib/recurly/client/operations.rb', line 2307 def create_external_product(body:, **) path = "/external_products" post(path, body, Requests::ExternalProductCreate, **) end |
#create_external_product_external_product_reference(external_product_id:, body:, **options) ⇒ Resources::ExternalProductReferenceMini
Create an external product reference on an external product
create_external_product_external_product_reference api documentation
2383 2384 2385 2386 |
# File 'lib/recurly/client/operations.rb', line 2383 def create_external_product_external_product_reference(external_product_id:, body:, **) path = interpolate_path("/external_products/{external_product_id}/external_product_references", external_product_id: external_product_id) post(path, body, Requests::ExternalProductReferenceCreate, **) end |
#create_external_subscription(body:, **options) ⇒ Resources::ExternalSubscription
Create an external subscription
2427 2428 2429 2430 |
# File 'lib/recurly/client/operations.rb', line 2427 def create_external_subscription(body:, **) path = "/external_subscriptions" post(path, body, Requests::ExternalSubscriptionCreate, **) end |
#create_general_ledger_account(body:, **options) ⇒ Resources::GeneralLedgerAccount
Create a new general ledger account
1869 1870 1871 1872 |
# File 'lib/recurly/client/operations.rb', line 1869 def create_general_ledger_account(body:, **) path = "/general_ledger_accounts" post(path, body, Requests::GeneralLedgerAccountCreate, **) end |
#create_gift_card(body:, **options) ⇒ Resources::GiftCard
Create gift card
4781 4782 4783 4784 |
# File 'lib/recurly/client/operations.rb', line 4781 def create_gift_card(body:, **) path = "/gift_cards" post(path, body, Requests::GiftCardCreate, **) end |
#create_invoice(account_id:, body:, **options) ⇒ Resources::InvoiceCollection
Create an invoice for pending line items
962 963 964 965 |
# File 'lib/recurly/client/operations.rb', line 962 def create_invoice(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/invoices", account_id: account_id) post(path, body, Requests::InvoiceCreate, **) end |
#create_item(body:, **options) ⇒ Resources::Item
Create a new item
2081 2082 2083 2084 |
# File 'lib/recurly/client/operations.rb', line 2081 def create_item(body:, **) path = "/items" post(path, body, Requests::ItemCreate, **) end |
#create_line_item(account_id:, body:, **options) ⇒ Resources::LineItem
Create a new line item for the account
1077 1078 1079 1080 |
# File 'lib/recurly/client/operations.rb', line 1077 def create_line_item(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/line_items", account_id: account_id) post(path, body, Requests::LineItemCreate, **) end |
#create_measured_unit(body:, **options) ⇒ Resources::MeasuredUnit
Create a new measured unit
2233 2234 2235 2236 |
# File 'lib/recurly/client/operations.rb', line 2233 def create_measured_unit(body:, **) path = "/measured_units" post(path, body, Requests::MeasuredUnitCreate, **) end |
#create_pending_purchase(body:, **options) ⇒ Resources::InvoiceCollection
Create a pending purchase
4454 4455 4456 4457 |
# File 'lib/recurly/client/operations.rb', line 4454 def create_pending_purchase(body:, **) path = "/purchases/pending" post(path, body, Requests::PurchaseCreate, **) end |
#create_plan(body:, **options) ⇒ Resources::Plan
Create a plan
3131 3132 3133 3134 |
# File 'lib/recurly/client/operations.rb', line 3131 def create_plan(body:, **) path = "/plans" post(path, body, Requests::PlanCreate, **) end |
#create_plan_add_on(plan_id:, body:, **options) ⇒ Resources::AddOn
Create an add-on
3289 3290 3291 3292 |
# File 'lib/recurly/client/operations.rb', line 3289 def create_plan_add_on(plan_id:, body:, **) path = interpolate_path("/plans/{plan_id}/add_ons", plan_id: plan_id) post(path, body, Requests::AddOnCreate, **) end |
#create_purchase(body:, **options) ⇒ Resources::InvoiceCollection
Create a new purchase
4372 4373 4374 4375 |
# File 'lib/recurly/client/operations.rb', line 4372 def create_purchase(body:, **) path = "/purchases" post(path, body, Requests::PurchaseCreate, **) end |
#create_shipping_address(account_id:, body:, **options) ⇒ Resources::ShippingAddress
Create a new shipping address for the account
1221 1222 1223 1224 |
# File 'lib/recurly/client/operations.rb', line 1221 def create_shipping_address(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/shipping_addresses", account_id: account_id) post(path, body, Requests::ShippingAddressCreate, **) end |
#create_shipping_method(body:, **options) ⇒ Resources::ShippingMethod
Create a new shipping method
3506 3507 3508 3509 |
# File 'lib/recurly/client/operations.rb', line 3506 def create_shipping_method(body:, **) path = "/shipping_methods" post(path, body, Requests::ShippingMethodCreate, **) end |
#create_subscription(body:, **options) ⇒ Resources::Subscription
Create a new subscription
3633 3634 3635 3636 |
# File 'lib/recurly/client/operations.rb', line 3633 def create_subscription(body:, **) path = "/subscriptions" post(path, body, Requests::SubscriptionCreate, **) end |
#create_subscription_change(subscription_id:, body:, **options) ⇒ Resources::SubscriptionChange
Create a new subscription change
3926 3927 3928 3929 |
# File 'lib/recurly/client/operations.rb', line 3926 def create_subscription_change(subscription_id:, body:, **) path = interpolate_path("/subscriptions/{subscription_id}/change", subscription_id: subscription_id) post(path, body, Requests::SubscriptionChangeCreate, **) end |
#create_usage(subscription_id:, add_on_id:, body:, **options) ⇒ Resources::Usage
Log a usage record on this subscription add-on
4177 4178 4179 4180 |
# File 'lib/recurly/client/operations.rb', line 4177 def create_usage(subscription_id:, add_on_id:, body:, **) path = interpolate_path("/subscriptions/{subscription_id}/add_ons/{add_on_id}/usage", subscription_id: subscription_id, add_on_id: add_on_id) post(path, body, Requests::UsageCreate, **) end |
#deactivate_account(account_id:, **options) ⇒ Resources::Account
Deactivate an account
246 247 248 249 |
# File 'lib/recurly/client/operations.rb', line 246 def deactivate_account(account_id:, **) path = interpolate_path("/accounts/{account_id}", account_id: account_id) delete(path, **) end |
#deactivate_coupon(coupon_id:, **options) ⇒ Resources::Coupon
Expire a coupon
1668 1669 1670 1671 |
# File 'lib/recurly/client/operations.rb', line 1668 def deactivate_coupon(coupon_id:, **) path = interpolate_path("/coupons/{coupon_id}", coupon_id: coupon_id) delete(path, **) end |
#deactivate_external_product_external_product_reference(external_product_id:, external_product_reference_id:, **options) ⇒ Resources::ExternalProductReferenceMini
Deactivate an external product reference
deactivate_external_product_external_product_reference api documentation
2413 2414 2415 2416 |
# File 'lib/recurly/client/operations.rb', line 2413 def deactivate_external_product_external_product_reference(external_product_id:, external_product_reference_id:, **) path = interpolate_path("/external_products/{external_product_id}/external_product_references/{external_product_reference_id}", external_product_id: external_product_id, external_product_reference_id: external_product_reference_id) delete(path, **) end |
#deactivate_external_products(external_product_id:, **options) ⇒ Resources::ExternalProduct
Deactivate an external product
2350 2351 2352 2353 |
# File 'lib/recurly/client/operations.rb', line 2350 def deactivate_external_products(external_product_id:, **) path = interpolate_path("/external_products/{external_product_id}", external_product_id: external_product_id) delete(path, **) end |
#deactivate_item(item_id:, **options) ⇒ Resources::Item
Deactivate an item
2158 2159 2160 2161 |
# File 'lib/recurly/client/operations.rb', line 2158 def deactivate_item(item_id:, **) path = interpolate_path("/items/{item_id}", item_id: item_id) delete(path, **) end |
#deactivate_shipping_method(shipping_method_id:, **options) ⇒ Resources::ShippingMethod
Deactivate a shipping method
3549 3550 3551 3552 |
# File 'lib/recurly/client/operations.rb', line 3549 def deactivate_shipping_method(shipping_method_id:, **) path = interpolate_path("/shipping_methods/{shipping_method_id}", shipping_method_id: shipping_method_id) delete(path, **) end |
#deactivate_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode
Deactivate a unique coupon code
4318 4319 4320 4321 |
# File 'lib/recurly/client/operations.rb', line 4318 def deactivate_unique_coupon_code(unique_coupon_code_id:, **) path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}", unique_coupon_code_id: unique_coupon_code_id) delete(path, **) end |
#delete_account_external_account(account_id:, external_account_id:, **options) ⇒ Resources::ExternalAccount
Delete an external account for an account
855 856 857 858 |
# File 'lib/recurly/client/operations.rb', line 855 def delete_account_external_account(account_id:, external_account_id:, **) path = interpolate_path("/accounts/{account_id}/external_accounts/{external_account_id}", account_id: account_id, external_account_id: external_account_id) delete(path, **) end |
#generate_unique_coupon_codes(coupon_id:, body:, **options) ⇒ Resources::UniqueCouponCodeParams
Generate unique coupon codes
1683 1684 1685 1686 |
# File 'lib/recurly/client/operations.rb', line 1683 def generate_unique_coupon_codes(coupon_id:, body:, **) path = interpolate_path("/coupons/{coupon_id}/generate", coupon_id: coupon_id) post(path, body, Requests::CouponBulkCreate, **) end |
#get_a_billing_info(account_id:, billing_info_id:, **options) ⇒ Resources::BillingInfo
Fetch a billing info
556 557 558 559 |
# File 'lib/recurly/client/operations.rb', line 556 def get_a_billing_info(account_id:, billing_info_id:, **) path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: account_id, billing_info_id: billing_info_id) get(path, **) end |
#get_account(account_id:, **options) ⇒ Resources::Account
Fetch an account
192 193 194 195 |
# File 'lib/recurly/client/operations.rb', line 192 def get_account(account_id:, **) path = interpolate_path("/accounts/{account_id}", account_id: account_id) get(path, **) end |
#get_account_acquisition(account_id:, **options) ⇒ Resources::AccountAcquisition
Fetch an account's acquisition data
269 270 271 272 |
# File 'lib/recurly/client/operations.rb', line 269 def get_account_acquisition(account_id:, **) path = interpolate_path("/accounts/{account_id}/acquisition", account_id: account_id) get(path, **) end |
#get_account_balance(account_id:, **options) ⇒ Resources::AccountBalance
Fetch an account's balance and past due status
374 375 376 377 |
# File 'lib/recurly/client/operations.rb', line 374 def get_account_balance(account_id:, **) path = interpolate_path("/accounts/{account_id}/balance", account_id: account_id) get(path, **) end |
#get_account_external_account(account_id:, external_account_id:, **options) ⇒ Resources::ExternalAccount
Get an external account for an account
824 825 826 827 |
# File 'lib/recurly/client/operations.rb', line 824 def get_account_external_account(account_id:, external_account_id:, **) path = interpolate_path("/accounts/{account_id}/external_accounts/{external_account_id}", account_id: account_id, external_account_id: external_account_id) get(path, **) end |
#get_account_note(account_id:, account_note_id:, **options) ⇒ Resources::AccountNote
Fetch an account note
1138 1139 1140 1141 |
# File 'lib/recurly/client/operations.rb', line 1138 def get_account_note(account_id:, account_note_id:, **) path = interpolate_path("/accounts/{account_id}/notes/{account_note_id}", account_id: account_id, account_note_id: account_note_id) get(path, **) end |
#get_add_on(add_on_id:, **options) ⇒ Resources::AddOn
Fetch an add-on
3445 3446 3447 3448 |
# File 'lib/recurly/client/operations.rb', line 3445 def get_add_on(add_on_id:, **) path = interpolate_path("/add_ons/{add_on_id}", add_on_id: add_on_id) get(path, **) end |
#get_billing_info(account_id:, **options) ⇒ Resources::BillingInfo
Fetch an account's billing information
397 398 399 400 |
# File 'lib/recurly/client/operations.rb', line 397 def get_billing_info(account_id:, **) path = interpolate_path("/accounts/{account_id}/billing_info", account_id: account_id) get(path, **) end |
#get_business_entity(business_entity_id:, **options) ⇒ Resources::BusinessEntity
Fetch a business entity
4741 4742 4743 4744 |
# File 'lib/recurly/client/operations.rb', line 4741 def get_business_entity(business_entity_id:, **) path = interpolate_path("/business_entities/{business_entity_id}", business_entity_id: business_entity_id) get(path, **) end |
#get_coupon(coupon_id:, **options) ⇒ Resources::Coupon
Fetch a coupon
1618 1619 1620 1621 |
# File 'lib/recurly/client/operations.rb', line 1618 def get_coupon(coupon_id:, **) path = interpolate_path("/coupons/{coupon_id}", coupon_id: coupon_id) get(path, **) end |
#get_credit_payment(credit_payment_id:, **options) ⇒ Resources::CreditPayment
Fetch a credit payment
1784 1785 1786 1787 |
# File 'lib/recurly/client/operations.rb', line 1784 def get_credit_payment(credit_payment_id:, **) path = interpolate_path("/credit_payments/{credit_payment_id}", credit_payment_id: credit_payment_id) get(path, **) end |
#get_custom_field_definition(custom_field_definition_id:, **options) ⇒ Resources::CustomFieldDefinition
Fetch an custom field definition
1855 1856 1857 1858 |
# File 'lib/recurly/client/operations.rb', line 1855 def get_custom_field_definition(custom_field_definition_id:, **) path = interpolate_path("/custom_field_definitions/{custom_field_definition_id}", custom_field_definition_id: custom_field_definition_id) get(path, **) end |
#get_dunning_campaign(dunning_campaign_id:, **options) ⇒ Resources::DunningCampaign
Fetch a dunning campaign
4576 4577 4578 4579 |
# File 'lib/recurly/client/operations.rb', line 4576 def get_dunning_campaign(dunning_campaign_id:, **) path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id) get(path, **) end |
#get_export_dates(**options) ⇒ Resources::ExportDates
List the dates that have an available export to download.
4520 4521 4522 4523 |
# File 'lib/recurly/client/operations.rb', line 4520 def get_export_dates(**) path = "/export_dates" get(path, **) end |
#get_export_files(export_date:, **options) ⇒ Resources::ExportFiles
List of the export files that are available to download.
4545 4546 4547 4548 |
# File 'lib/recurly/client/operations.rb', line 4545 def get_export_files(export_date:, **) path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date) get(path, **) end |
#get_external_product(external_product_id:, **options) ⇒ Resources::ExternalProduct
Fetch an external product
2321 2322 2323 2324 |
# File 'lib/recurly/client/operations.rb', line 2321 def get_external_product(external_product_id:, **) path = interpolate_path("/external_products/{external_product_id}", external_product_id: external_product_id) get(path, **) end |
#get_external_product_external_product_reference(external_product_id:, external_product_reference_id:, **options) ⇒ Resources::ExternalProductReferenceMini
Fetch an external product reference
get_external_product_external_product_reference api documentation
2398 2399 2400 2401 |
# File 'lib/recurly/client/operations.rb', line 2398 def get_external_product_external_product_reference(external_product_id:, external_product_reference_id:, **) path = interpolate_path("/external_products/{external_product_id}/external_product_references/{external_product_reference_id}", external_product_id: external_product_id, external_product_reference_id: external_product_reference_id) get(path, **) end |
#get_external_subscription(external_subscription_id:, **options) ⇒ Resources::ExternalSubscription
Fetch an external subscription
2458 2459 2460 2461 |
# File 'lib/recurly/client/operations.rb', line 2458 def get_external_subscription(external_subscription_id:, **) path = interpolate_path("/external_subscriptions/{external_subscription_id}", external_subscription_id: external_subscription_id) get(path, **) end |
#get_external_subscription_external_payment_phase(external_subscription_id:, external_payment_phase_id:, **options) ⇒ Resources::ExternalPaymentPhase
Fetch an external payment phase
get_external_subscription_external_payment_phase api documentation
4690 4691 4692 4693 |
# File 'lib/recurly/client/operations.rb', line 4690 def get_external_subscription_external_payment_phase(external_subscription_id:, external_payment_phase_id:, **) path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id}", external_subscription_id: external_subscription_id, external_payment_phase_id: external_payment_phase_id) get(path, **) end |
#get_general_ledger_account(general_ledger_account_id:, **options) ⇒ Resources::GeneralLedgerAccount
Fetch a general ledger account
1915 1916 1917 1918 |
# File 'lib/recurly/client/operations.rb', line 1915 def get_general_ledger_account(general_ledger_account_id:, **) path = interpolate_path("/general_ledger_accounts/{general_ledger_account_id}", general_ledger_account_id: general_ledger_account_id) get(path, **) end |
#get_gift_card(gift_card_id:, **options) ⇒ Resources::GiftCard
Fetch a gift card
4795 4796 4797 4798 |
# File 'lib/recurly/client/operations.rb', line 4795 def get_gift_card(gift_card_id:, **) path = interpolate_path("/gift_cards/{gift_card_id}", gift_card_id: gift_card_id) get(path, **) end |
#get_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Fetch an invoice
2583 2584 2585 2586 |
# File 'lib/recurly/client/operations.rb', line 2583 def get_invoice(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}", invoice_id: invoice_id) get(path, **) end |
#get_invoice_pdf(invoice_id:, **options) ⇒ Resources::BinaryFile
Fetch an invoice as a PDF
2637 2638 2639 2640 |
# File 'lib/recurly/client/operations.rb', line 2637 def get_invoice_pdf(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}.pdf", invoice_id: invoice_id) get(path, **) end |
#get_invoice_template(invoice_template_id:, **options) ⇒ Resources::InvoiceTemplate
Fetch an invoice template
4622 4623 4624 4625 |
# File 'lib/recurly/client/operations.rb', line 4622 def get_invoice_template(invoice_template_id:, **) path = interpolate_path("/invoice_templates/{invoice_template_id}", invoice_template_id: invoice_template_id) get(path, **) end |
#get_item(item_id:, **options) ⇒ Resources::Item
Fetch an item
2104 2105 2106 2107 |
# File 'lib/recurly/client/operations.rb', line 2104 def get_item(item_id:, **) path = interpolate_path("/items/{item_id}", item_id: item_id) get(path, **) end |
#get_line_item(line_item_id:, **options) ⇒ Resources::LineItem
Fetch a line item
3020 3021 3022 3023 |
# File 'lib/recurly/client/operations.rb', line 3020 def get_line_item(line_item_id:, **) path = interpolate_path("/line_items/{line_item_id}", line_item_id: line_item_id) get(path, **) end |
#get_measured_unit(measured_unit_id:, **options) ⇒ Resources::MeasuredUnit
Fetch a measured unit
2247 2248 2249 2250 |
# File 'lib/recurly/client/operations.rb', line 2247 def get_measured_unit(measured_unit_id:, **) path = interpolate_path("/measured_units/{measured_unit_id}", measured_unit_id: measured_unit_id) get(path, **) end |
#get_performance_obligation(performance_obligation_id:, **options) ⇒ Resources::PerformanceObligation
Get a single Performance Obligation.
1944 1945 1946 1947 |
# File 'lib/recurly/client/operations.rb', line 1944 def get_performance_obligation(performance_obligation_id:, **) path = interpolate_path("/performance_obligations/{performance_obligation_id}", performance_obligation_id: performance_obligation_id) get(path, **) end |
#get_performance_obligations(**options) ⇒ Pager<Resources::PerformanceObligation>
Get a site's Performance Obligations
1957 1958 1959 1960 |
# File 'lib/recurly/client/operations.rb', line 1957 def get_performance_obligations(**) path = "/performance_obligations" pager(path, **) end |
#get_plan(plan_id:, **options) ⇒ Resources::Plan
Fetch a plan
3154 3155 3156 3157 |
# File 'lib/recurly/client/operations.rb', line 3154 def get_plan(plan_id:, **) path = interpolate_path("/plans/{plan_id}", plan_id: plan_id) get(path, **) end |
#get_plan_add_on(plan_id:, add_on_id:, **options) ⇒ Resources::AddOn
Fetch a plan's add-on
3315 3316 3317 3318 |
# File 'lib/recurly/client/operations.rb', line 3315 def get_plan_add_on(plan_id:, add_on_id:, **) path = interpolate_path("/plans/{plan_id}/add_ons/{add_on_id}", plan_id: plan_id, add_on_id: add_on_id) get(path, **) end |
#get_preview_renewal(subscription_id:, **options) ⇒ Resources::InvoiceCollection
Fetch a preview of a subscription's renewal invoice(s)
3870 3871 3872 3873 |
# File 'lib/recurly/client/operations.rb', line 3870 def get_preview_renewal(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id) get(path, **) end |
#get_shipping_address(account_id:, shipping_address_id:, **options) ⇒ Resources::ShippingAddress
Fetch an account's shipping address
1248 1249 1250 1251 |
# File 'lib/recurly/client/operations.rb', line 1248 def get_shipping_address(account_id:, shipping_address_id:, **) path = interpolate_path("/accounts/{account_id}/shipping_addresses/{shipping_address_id}", account_id: account_id, shipping_address_id: shipping_address_id) get(path, **) end |
#get_shipping_method(shipping_method_id:, **options) ⇒ Resources::ShippingMethod
Fetch a shipping method
3520 3521 3522 3523 |
# File 'lib/recurly/client/operations.rb', line 3520 def get_shipping_method(shipping_method_id:, **) path = interpolate_path("/shipping_methods/{shipping_method_id}", shipping_method_id: shipping_method_id) get(path, **) end |
#get_site(site_id:, **options) ⇒ Resources::Site
Fetch a site
69 70 71 72 |
# File 'lib/recurly/client/operations.rb', line 69 def get_site(site_id:, **) path = interpolate_path("/sites/{site_id}", site_id: site_id) get(path, **) end |
#get_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Fetch a subscription
3658 3659 3660 3661 |
# File 'lib/recurly/client/operations.rb', line 3658 def get_subscription(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}", subscription_id: subscription_id) get(path, **) end |
#get_subscription_change(subscription_id:, **options) ⇒ Resources::SubscriptionChange
Fetch a subscription's pending change
3895 3896 3897 3898 |
# File 'lib/recurly/client/operations.rb', line 3895 def get_subscription_change(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/change", subscription_id: subscription_id) get(path, **) end |
#get_transaction(transaction_id:, **options) ⇒ Resources::Transaction
Fetch a transaction
4290 4291 4292 4293 |
# File 'lib/recurly/client/operations.rb', line 4290 def get_transaction(transaction_id:, **) path = interpolate_path("/transactions/{transaction_id}", transaction_id: transaction_id) get(path, **) end |
#get_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode
Fetch a unique coupon code
4304 4305 4306 4307 |
# File 'lib/recurly/client/operations.rb', line 4304 def get_unique_coupon_code(unique_coupon_code_id:, **) path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}", unique_coupon_code_id: unique_coupon_code_id) get(path, **) end |
#get_usage(usage_id:, **options) ⇒ Resources::Usage
Get a usage record
4191 4192 4193 4194 |
# File 'lib/recurly/client/operations.rb', line 4191 def get_usage(usage_id:, **) path = interpolate_path("/usage/{usage_id}", usage_id: usage_id) get(path, **) end |
#list_account_acquisition(**options) ⇒ Pager<Resources::AccountAcquisition>
List a site's account acquisition data
list_account_acquisition api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1514 1515 1516 1517 |
# File 'lib/recurly/client/operations.rb', line 1514 def list_account_acquisition(**) path = "/acquisitions" pager(path, **) end |
#list_account_coupon_redemptions(account_id:, **options) ⇒ Pager<Resources::CouponRedemption>
List the coupon redemptions for an account
list_account_coupon_redemptions api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:state [String] Filter by state.
667 668 669 670 |
# File 'lib/recurly/client/operations.rb', line 667 def list_account_coupon_redemptions(account_id:, **) path = interpolate_path("/accounts/{account_id}/coupon_redemptions", account_id: account_id) pager(path, **) end |
#list_account_credit_payments(account_id:, **options) ⇒ Pager<Resources::CreditPayment>
List an account's credit payments
list_account_credit_payments api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
780 781 782 783 |
# File 'lib/recurly/client/operations.rb', line 780 def list_account_credit_payments(account_id:, **) path = interpolate_path("/accounts/{account_id}/credit_payments", account_id: account_id) pager(path, **) end |
#list_account_external_account(account_id:, **options) ⇒ Pager<Resources::ExternalAccount>
List external accounts for an account
794 795 796 797 |
# File 'lib/recurly/client/operations.rb', line 794 def list_account_external_account(account_id:, **) path = interpolate_path("/accounts/{account_id}/external_accounts", account_id: account_id) pager(path, **) end |
#list_account_external_invoices(account_id:, **options) ⇒ Pager<Resources::ExternalInvoice>
List the external invoices on an account
list_account_external_invoices api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
875 876 877 878 |
# File 'lib/recurly/client/operations.rb', line 875 def list_account_external_invoices(account_id:, **) path = interpolate_path("/accounts/{account_id}/external_invoices", account_id: account_id) pager(path, **) end |
#list_account_external_subscriptions(account_id:, **options) ⇒ Pager<Resources::ExternalSubscription>
List an account's external subscriptions
list_account_external_subscriptions api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
4727 4728 4729 4730 |
# File 'lib/recurly/client/operations.rb', line 4727 def list_account_external_subscriptions(account_id:, **) path = interpolate_path("/accounts/{account_id}/external_subscriptions", account_id: account_id) pager(path, **) end |
#list_account_invoices(account_id:, **options) ⇒ Pager<Resources::Invoice>
List an account's invoices
list_account_invoices api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:state [String] Invoice state.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:type [String] Filter by type when:
- +type=charge+, only charge invoices will be returned.
- +type=credit+, only credit invoices will be returned.
- +type=non-legacy+, only charge and credit invoices will be returned.
- +type=legacy+, only legacy invoices will be returned.
931 932 933 934 |
# File 'lib/recurly/client/operations.rb', line 931 def list_account_invoices(account_id:, **) path = interpolate_path("/accounts/{account_id}/invoices", account_id: account_id) pager(path, **) end |
#list_account_line_items(account_id:, **options) ⇒ Pager<Resources::LineItem>
List an account's line items
list_account_line_items api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:original [String] Filter by original field.
:state [String] Filter by state field.
:type [String] Filter by type field.
1045 1046 1047 1048 |
# File 'lib/recurly/client/operations.rb', line 1045 def list_account_line_items(account_id:, **) path = interpolate_path("/accounts/{account_id}/line_items", account_id: account_id) pager(path, **) end |
#list_account_notes(account_id:, **options) ⇒ Pager<Resources::AccountNote>
List an account's notes
list_account_notes api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
1111 1112 1113 1114 |
# File 'lib/recurly/client/operations.rb', line 1111 def list_account_notes(account_id:, **) path = interpolate_path("/accounts/{account_id}/notes", account_id: account_id) pager(path, **) end |
#list_account_subscriptions(account_id:, **options) ⇒ Pager<Resources::Subscription>
List an account's subscriptions
list_account_subscriptions api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:state [String] Filter by state.
- When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
- When +state=in_trial+, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
- When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
1364 1365 1366 1367 |
# File 'lib/recurly/client/operations.rb', line 1364 def list_account_subscriptions(account_id:, **) path = interpolate_path("/accounts/{account_id}/subscriptions", account_id: account_id) pager(path, **) end |
#list_account_transactions(account_id:, **options) ⇒ Pager<Resources::Transaction>
List an account's transactions
list_account_transactions api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
:success [String] Filter by success field.
1415 1416 1417 1418 |
# File 'lib/recurly/client/operations.rb', line 1415 def list_account_transactions(account_id:, **) path = interpolate_path("/accounts/{account_id}/transactions", account_id: account_id) pager(path, **) end |
#list_accounts(**options) ⇒ Pager<Resources::Account>
List a site's accounts
list_accounts api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
:subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
+canceled+, or +future+ state.
:past_due [String] Filter for accounts with an invoice in the +past_due+ state.
119 120 121 122 |
# File 'lib/recurly/client/operations.rb', line 119 def list_accounts(**) path = "/accounts" pager(path, **) end |
#list_active_coupon_redemptions(account_id:, **options) ⇒ Pager<Resources::CouponRedemption>
List the coupon redemptions that are active on an account
689 690 691 692 |
# File 'lib/recurly/client/operations.rb', line 689 def list_active_coupon_redemptions(account_id:, **) path = interpolate_path("/accounts/{account_id}/coupon_redemptions/active", account_id: account_id) pager(path, **) end |
#list_add_ons(**options) ⇒ Pager<Resources::AddOn>
List a site's add-ons
list_add_ons api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:state [String] Filter by state.
3422 3423 3424 3425 |
# File 'lib/recurly/client/operations.rb', line 3422 def list_add_ons(**) path = "/add_ons" pager(path, **) end |
#list_billing_infos(account_id:, **options) ⇒ Pager<Resources::BillingInfo>
Get the list of billing information associated with an account
list_billing_infos api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
526 527 528 529 |
# File 'lib/recurly/client/operations.rb', line 526 def list_billing_infos(account_id:, **) path = interpolate_path("/accounts/{account_id}/billing_infos", account_id: account_id) pager(path, **) end |
#list_business_entities(**options) ⇒ Pager<Resources::BusinessEntity>
List business entities
4754 4755 4756 4757 |
# File 'lib/recurly/client/operations.rb', line 4754 def list_business_entities(**) path = "/business_entities" pager(path, **) end |
#list_business_entity_invoices(business_entity_id:, **options) ⇒ Pager<Resources::Invoice>
List a business entity's invoices
list_business_entity_invoices api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:state [String] Invoice state.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:type [String] Filter by type when:
- +type=charge+, only charge invoices will be returned.
- +type=credit+, only credit invoices will be returned.
- +type=non-legacy+, only charge and credit invoices will be returned.
- +type=legacy+, only legacy invoices will be returned.
4869 4870 4871 4872 |
# File 'lib/recurly/client/operations.rb', line 4869 def list_business_entity_invoices(business_entity_id:, **) path = interpolate_path("/business_entities/{business_entity_id}/invoices", business_entity_id: business_entity_id) pager(path, **) end |
#list_child_accounts(account_id:, **options) ⇒ Pager<Resources::Account>
List an account's child accounts
list_child_accounts api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
:subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
+canceled+, or +future+ state.
:past_due [String] Filter for accounts with an invoice in the +past_due+ state.
1469 1470 1471 1472 |
# File 'lib/recurly/client/operations.rb', line 1469 def list_child_accounts(account_id:, **) path = interpolate_path("/accounts/{account_id}/accounts", account_id: account_id) pager(path, **) end |
#list_coupons(**options) ⇒ Pager<Resources::Coupon>
List a site's coupons
list_coupons api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1559 1560 1561 1562 |
# File 'lib/recurly/client/operations.rb', line 1559 def list_coupons(**) path = "/coupons" pager(path, **) end |
#list_credit_payments(**options) ⇒ Pager<Resources::CreditPayment>
List a site's credit payments
list_credit_payments api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1770 1771 1772 1773 |
# File 'lib/recurly/client/operations.rb', line 1770 def list_credit_payments(**) path = "/credit_payments" pager(path, **) end |
#list_custom_field_definitions(**options) ⇒ Pager<Resources::CustomFieldDefinition>
List a site's custom field definitions
list_custom_field_definitions api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:related_type [String] Filter by related type.
1830 1831 1832 1833 |
# File 'lib/recurly/client/operations.rb', line 1830 def list_custom_field_definitions(**) path = "/custom_field_definitions" pager(path, **) end |
#list_dunning_campaigns(**options) ⇒ Pager<Resources::DunningCampaign>
List the dunning campaigns for a site
list_dunning_campaigns api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
4562 4563 4564 4565 |
# File 'lib/recurly/client/operations.rb', line 4562 def list_dunning_campaigns(**) path = "/dunning_campaigns" pager(path, **) end |
#list_entitlements(account_id:, **options) ⇒ Pager<Resources::Entitlements>
List entitlements granted to an account
list_entitlements api documentation
- When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
- When no state is provided, subscriptions with active or canceled states will be returned.
4709 4710 4711 4712 |
# File 'lib/recurly/client/operations.rb', line 4709 def list_entitlements(account_id:, **) path = interpolate_path("/accounts/{account_id}/entitlements", account_id: account_id) pager(path, **) end |
#list_external_invoices(**options) ⇒ Pager<Resources::ExternalInvoice>
List the external invoices on a site
list_external_invoices api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
4641 4642 4643 4644 |
# File 'lib/recurly/client/operations.rb', line 4641 def list_external_invoices(**) path = "/external_invoices" pager(path, **) end |
#list_external_product_external_product_references(external_product_id:, **options) ⇒ Pager<Resources::ExternalProductReferenceCollection>
List the external product references for an external product
list_external_product_external_product_references api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
2368 2369 2370 2371 |
# File 'lib/recurly/client/operations.rb', line 2368 def list_external_product_external_product_references(external_product_id:, **) path = interpolate_path("/external_products/{external_product_id}/external_product_references", external_product_id: external_product_id) pager(path, **) end |
#list_external_products(**options) ⇒ Pager<Resources::ExternalProduct>
List a site's external products
list_external_products api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
2293 2294 2295 2296 |
# File 'lib/recurly/client/operations.rb', line 2293 def list_external_products(**) path = "/external_products" pager(path, **) end |
#list_external_subscription_external_invoices(external_subscription_id:, **options) ⇒ Pager<Resources::ExternalInvoice>
List the external invoices on an external subscription
list_external_subscription_external_invoices api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
2493 2494 2495 2496 |
# File 'lib/recurly/client/operations.rb', line 2493 def list_external_subscription_external_invoices(external_subscription_id:, **) path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_invoices", external_subscription_id: external_subscription_id) pager(path, **) end |
#list_external_subscription_external_payment_phases(external_subscription_id:, **options) ⇒ Pager<Resources::ExternalPaymentPhase>
List the external payment phases on an external subscription
list_external_subscription_external_payment_phases api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
4675 4676 4677 4678 |
# File 'lib/recurly/client/operations.rb', line 4675 def list_external_subscription_external_payment_phases(external_subscription_id:, **) path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_payment_phases", external_subscription_id: external_subscription_id) pager(path, **) end |
#list_external_subscriptions(**options) ⇒ Pager<Resources::ExternalSubscription>
List the external subscriptions on a site
list_external_subscriptions api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
2444 2445 2446 2447 |
# File 'lib/recurly/client/operations.rb', line 2444 def list_external_subscriptions(**) path = "/external_subscriptions" pager(path, **) end |
#list_general_ledger_accounts(**options) ⇒ Pager<Resources::GeneralLedgerAccount>
List a site's general ledger accounts
list_general_ledger_accounts api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:account_type [String] General Ledger Account type by which to filter the response.
1901 1902 1903 1904 |
# File 'lib/recurly/client/operations.rb', line 1901 def list_general_ledger_accounts(**) path = "/general_ledger_accounts" pager(path, **) end |
#list_gift_cards(**options) ⇒ Pager<Resources::GiftCard>
List gift cards
4767 4768 4769 4770 |
# File 'lib/recurly/client/operations.rb', line 4767 def list_gift_cards(**) path = "/gift_cards" pager(path, **) end |
#list_invoice_coupon_redemptions(invoice_id:, **options) ⇒ Pager<Resources::CouponRedemption>
List the coupon redemptions applied to an invoice
list_invoice_coupon_redemptions api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
2891 2892 2893 2894 |
# File 'lib/recurly/client/operations.rb', line 2891 def list_invoice_coupon_redemptions(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/coupon_redemptions", invoice_id: invoice_id) pager(path, **) end |
#list_invoice_line_items(invoice_id:, **options) ⇒ Pager<Resources::LineItem>
List an invoice's line items
list_invoice_line_items api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:original [String] Filter by original field.
:state [String] Filter by state field.
:type [String] Filter by type field.
2844 2845 2846 2847 |
# File 'lib/recurly/client/operations.rb', line 2844 def list_invoice_line_items(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/line_items", invoice_id: invoice_id) pager(path, **) end |
#list_invoice_template_accounts(invoice_template_id:, **options) ⇒ Pager<Resources::Account>
List an invoice template's associated accounts
list_invoice_template_accounts api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
:subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
+canceled+, or +future+ state.
:past_due [String] Filter for accounts with an invoice in the +past_due+ state.
2000 2001 2002 2003 |
# File 'lib/recurly/client/operations.rb', line 2000 def list_invoice_template_accounts(invoice_template_id:, **) path = interpolate_path("/invoice_templates/{invoice_template_id}/accounts", invoice_template_id: invoice_template_id) pager(path, **) end |
#list_invoice_templates(**options) ⇒ Pager<Resources::InvoiceTemplate>
Show the invoice templates for a site
list_invoice_templates api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
4608 4609 4610 4611 |
# File 'lib/recurly/client/operations.rb', line 4608 def list_invoice_templates(**) path = "/invoice_templates" pager(path, **) end |
#list_invoices(**options) ⇒ Pager<Resources::Invoice>
List a site's invoices
list_invoices api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:state [String] Invoice state.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:type [String] Filter by type when:
- +type=charge+, only charge invoices will be returned.
- +type=credit+, only credit invoices will be returned.
- +type=non-legacy+, only charge and credit invoices will be returned.
- +type=legacy+, only legacy invoices will be returned.
2560 2561 2562 2563 |
# File 'lib/recurly/client/operations.rb', line 2560 def list_invoices(**) path = "/invoices" pager(path, **) end |
#list_items(**options) ⇒ Pager<Resources::Item>
List a site's items
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:state [String] Filter by state.
2046 2047 2048 2049 |
# File 'lib/recurly/client/operations.rb', line 2046 def list_items(**) path = "/items" pager(path, **) end |
#list_line_items(**options) ⇒ Pager<Resources::LineItem>
List a site's line items
list_line_items api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:original [String] Filter by original field.
:state [String] Filter by state field.
:type [String] Filter by type field.
2997 2998 2999 3000 |
# File 'lib/recurly/client/operations.rb', line 2997 def list_line_items(**) path = "/line_items" pager(path, **) end |
#list_measured_unit(**options) ⇒ Pager<Resources::MeasuredUnit>
List a site's measured units
list_measured_unit api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:state [String] Filter by state.
2219 2220 2221 2222 |
# File 'lib/recurly/client/operations.rb', line 2219 def list_measured_unit(**) path = "/measured_units" pager(path, **) end |
#list_plan_add_ons(plan_id:, **options) ⇒ Pager<Resources::AddOn>
List a plan's add-ons
list_plan_add_ons api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:state [String] Filter by state.
3254 3255 3256 3257 |
# File 'lib/recurly/client/operations.rb', line 3254 def list_plan_add_ons(plan_id:, **) path = interpolate_path("/plans/{plan_id}/add_ons", plan_id: plan_id) pager(path, **) end |
#list_plans(**options) ⇒ Pager<Resources::Plan>
List a site's plans
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:state [String] Filter by state.
3091 3092 3093 3094 |
# File 'lib/recurly/client/operations.rb', line 3091 def list_plans(**) path = "/plans" pager(path, **) end |
#list_related_invoices(invoice_id:, **options) ⇒ Pager<Resources::Invoice>
List an invoice's related credit or charge invoices
2916 2917 2918 2919 |
# File 'lib/recurly/client/operations.rb', line 2916 def (invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/related_invoices", invoice_id: invoice_id) pager(path, **) end |
#list_shipping_addresses(account_id:, **options) ⇒ Pager<Resources::ShippingAddress>
Fetch a list of an account's shipping addresses
list_shipping_addresses api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1187 1188 1189 1190 |
# File 'lib/recurly/client/operations.rb', line 1187 def list_shipping_addresses(account_id:, **) path = interpolate_path("/accounts/{account_id}/shipping_addresses", account_id: account_id) pager(path, **) end |
#list_shipping_methods(**options) ⇒ Pager<Resources::ShippingMethod>
List a site's shipping methods
list_shipping_methods api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
3492 3493 3494 3495 |
# File 'lib/recurly/client/operations.rb', line 3492 def list_shipping_methods(**) path = "/shipping_methods" pager(path, **) end |
#list_sites(**options) ⇒ Pager<Resources::Site>
List sites
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:state [String] Filter by state.
46 47 48 49 |
# File 'lib/recurly/client/operations.rb', line 46 def list_sites(**) path = "/sites" pager(path, **) end |
#list_subscription_coupon_redemptions(subscription_id:, **options) ⇒ Pager<Resources::CouponRedemption>
List the coupon redemptions for a subscription
list_subscription_coupon_redemptions api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
4121 4122 4123 4124 |
# File 'lib/recurly/client/operations.rb', line 4121 def list_subscription_coupon_redemptions(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/coupon_redemptions", subscription_id: subscription_id) pager(path, **) end |
#list_subscription_invoices(subscription_id:, **options) ⇒ Pager<Resources::Invoice>
List a subscription's invoices
list_subscription_invoices api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:state [String] Invoice state.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:type [String] Filter by type when:
- +type=charge+, only charge invoices will be returned.
- +type=credit+, only credit invoices will be returned.
- +type=non-legacy+, only charge and credit invoices will be returned.
- +type=legacy+, only legacy invoices will be returned.
4022 4023 4024 4025 |
# File 'lib/recurly/client/operations.rb', line 4022 def list_subscription_invoices(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/invoices", subscription_id: subscription_id) pager(path, **) end |
#list_subscription_line_items(subscription_id:, **options) ⇒ Pager<Resources::LineItem>
List a subscription's line items
list_subscription_line_items api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:original [String] Filter by original field.
:state [String] Filter by state field.
:type [String] Filter by type field.
4074 4075 4076 4077 |
# File 'lib/recurly/client/operations.rb', line 4074 def list_subscription_line_items(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/line_items", subscription_id: subscription_id) pager(path, **) end |
#list_subscriptions(**options) ⇒ Pager<Resources::Subscription>
List a site's subscriptions
list_subscriptions api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:state [String] Filter by state.
- When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
- When +state=in_trial+, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
- When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
3600 3601 3602 3603 |
# File 'lib/recurly/client/operations.rb', line 3600 def list_subscriptions(**) path = "/subscriptions" pager(path, **) end |
#list_transactions(**options) ⇒ Pager<Resources::Transaction>
List a site's transactions
list_transactions api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:type [String] Filter by type field. The value +payment+ will return both +purchase+ and +capture+ transactions.
:success [String] Filter by success field.
4267 4268 4269 4270 |
# File 'lib/recurly/client/operations.rb', line 4267 def list_transactions(**) path = "/transactions" pager(path, **) end |
#list_unique_coupon_codes(coupon_id:, **options) ⇒ Pager<Resources::UniqueCouponCode>
List unique coupon codes associated with a bulk coupon
list_unique_coupon_codes api documentation
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:redeemed [String] Filter unique coupon codes by redemption status. +true+ for redeemed, +false+ for not redeemed.
1737 1738 1739 1740 |
# File 'lib/recurly/client/operations.rb', line 1737 def list_unique_coupon_codes(coupon_id:, **) path = interpolate_path("/coupons/{coupon_id}/unique_coupon_codes", coupon_id: coupon_id) pager(path, **) end |
#list_usage(subscription_id:, add_on_id:, **options) ⇒ Pager<Resources::Usage>
List a subscription add-on's usage records
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
*Important notes:*
* The +ids+ parameter cannot be used with any other ordering or filtering
parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
:limit [Integer] Limit number of records 1-200.
:order [String] Sort order.
:sort [String] Sort field. You *really* only want to sort by +usage_timestamp+ in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
:begin_time [DateTime] Inclusively filter by begin_time when +sort=usage_timestamp+ or +sort=recorded_timestamp+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:end_time [DateTime] Inclusively filter by end_time when +sort=usage_timestamp+ or +sort=recorded_timestamp+.
*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
:billing_status [String] Filter by usage record's billing status
4161 4162 4163 4164 |
# File 'lib/recurly/client/operations.rb', line 4161 def list_usage(subscription_id:, add_on_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/add_ons/{add_on_id}/usage", subscription_id: subscription_id, add_on_id: add_on_id) pager(path, **) end |
#mark_invoice_failed(invoice_id:, **options) ⇒ Resources::Invoice
Mark an open invoice as failed
2708 2709 2710 2711 |
# File 'lib/recurly/client/operations.rb', line 2708 def mark_invoice_failed(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/mark_failed", invoice_id: invoice_id) put(path, **) end |
#mark_invoice_successful(invoice_id:, **options) ⇒ Resources::Invoice
Mark an open invoice as successful
2731 2732 2733 2734 |
# File 'lib/recurly/client/operations.rb', line 2731 def mark_invoice_successful(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/mark_successful", invoice_id: invoice_id) put(path, **) end |
#pause_subscription(subscription_id:, body:, **options) ⇒ Resources::Subscription
Pause subscription
3806 3807 3808 3809 |
# File 'lib/recurly/client/operations.rb', line 3806 def pause_subscription(subscription_id:, body:, **) path = interpolate_path("/subscriptions/{subscription_id}/pause", subscription_id: subscription_id) put(path, body, Requests::SubscriptionPause, **) end |
#preview_gift_card(body:, **options) ⇒ Resources::GiftCard
Preview gift card
4809 4810 4811 4812 |
# File 'lib/recurly/client/operations.rb', line 4809 def preview_gift_card(body:, **) path = "/gift_cards/preview" post(path, body, Requests::GiftCardCreate, **) end |
#preview_invoice(account_id:, body:, **options) ⇒ Resources::InvoiceCollection
Preview new invoice for pending line items
993 994 995 996 |
# File 'lib/recurly/client/operations.rb', line 993 def preview_invoice(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/invoices/preview", account_id: account_id) post(path, body, Requests::InvoiceCreate, **) end |
#preview_purchase(body:, **options) ⇒ Resources::InvoiceCollection
Preview a new purchase
4412 4413 4414 4415 |
# File 'lib/recurly/client/operations.rb', line 4412 def preview_purchase(body:, **) path = "/purchases/preview" post(path, body, Requests::PurchaseCreate, **) end |
#preview_subscription_change(subscription_id:, body:, **options) ⇒ Resources::SubscriptionChange
Preview a new subscription change
3966 3967 3968 3969 |
# File 'lib/recurly/client/operations.rb', line 3966 def preview_subscription_change(subscription_id:, body:, **) path = interpolate_path("/subscriptions/{subscription_id}/change/preview", subscription_id: subscription_id) post(path, body, Requests::SubscriptionChangeCreate, **) end |
#put_dunning_campaign_bulk_update(dunning_campaign_id:, body:, **options) ⇒ Resources::DunningCampaignsBulkUpdateResponse
Assign a dunning campaign to multiple plans
4591 4592 4593 4594 |
# File 'lib/recurly/client/operations.rb', line 4591 def put_dunning_campaign_bulk_update(dunning_campaign_id:, body:, **) path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}/bulk_update", dunning_campaign_id: dunning_campaign_id) put(path, body, Requests::DunningCampaignsBulkUpdate, **) end |
#put_external_subscription(external_subscription_id:, **options) ⇒ Resources::ExternalSubscription
Update an external subscription
2473 2474 2475 2476 |
# File 'lib/recurly/client/operations.rb', line 2473 def put_external_subscription(external_subscription_id:, **) path = interpolate_path("/external_subscriptions/{external_subscription_id}", external_subscription_id: external_subscription_id) put(path, [:body], Requests::ExternalSubscriptionUpdate, **) end |
#reactivate_account(account_id:, **options) ⇒ Resources::Account
Reactivate an inactive account
351 352 353 354 |
# File 'lib/recurly/client/operations.rb', line 351 def reactivate_account(account_id:, **) path = interpolate_path("/accounts/{account_id}/reactivate", account_id: account_id) put(path, **) end |
#reactivate_item(item_id:, **options) ⇒ Resources::Item
Reactivate an inactive item
2181 2182 2183 2184 |
# File 'lib/recurly/client/operations.rb', line 2181 def reactivate_item(item_id:, **) path = interpolate_path("/items/{item_id}/reactivate", item_id: item_id) put(path, **) end |
#reactivate_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Reactivate a canceled subscription
3776 3777 3778 3779 |
# File 'lib/recurly/client/operations.rb', line 3776 def reactivate_subscription(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/reactivate", subscription_id: subscription_id) put(path, **) end |
#reactivate_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode
Restore a unique coupon code
4332 4333 4334 4335 |
# File 'lib/recurly/client/operations.rb', line 4332 def reactivate_unique_coupon_code(unique_coupon_code_id:, **) path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}/restore", unique_coupon_code_id: unique_coupon_code_id) put(path, **) end |
#record_external_transaction(invoice_id:, body:, **options) ⇒ Resources::Transaction
Record an external payment for a manual invoices.
2792 2793 2794 2795 |
# File 'lib/recurly/client/operations.rb', line 2792 def record_external_transaction(invoice_id:, body:, **) path = interpolate_path("/invoices/{invoice_id}/transactions", invoice_id: invoice_id) post(path, body, Requests::ExternalTransaction, **) end |
#redeem_gift_card(redemption_code:, body:, **options) ⇒ Resources::GiftCard
Redeem gift card
4824 4825 4826 4827 |
# File 'lib/recurly/client/operations.rb', line 4824 def redeem_gift_card(redemption_code:, body:, **) path = interpolate_path("/gift_cards/{redemption_code}/redeem", redemption_code: redemption_code) post(path, body, Requests::GiftCardRedeem, **) end |
#refund_invoice(invoice_id:, body:, **options) ⇒ Resources::Invoice
Refund an invoice
2947 2948 2949 2950 |
# File 'lib/recurly/client/operations.rb', line 2947 def refund_invoice(invoice_id:, body:, **) path = interpolate_path("/invoices/{invoice_id}/refund", invoice_id: invoice_id) post(path, body, Requests::InvoiceRefund, **) end |
#remove_a_billing_info(account_id:, billing_info_id:, **options) ⇒ Resources::Empty
Remove an account's billing information
587 588 589 590 |
# File 'lib/recurly/client/operations.rb', line 587 def remove_a_billing_info(account_id:, billing_info_id:, **) path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: account_id, billing_info_id: billing_info_id) delete(path, **) end |
#remove_account_acquisition(account_id:, **options) ⇒ Resources::Empty
Remove an account's acquisition data
328 329 330 331 |
# File 'lib/recurly/client/operations.rb', line 328 def remove_account_acquisition(account_id:, **) path = interpolate_path("/accounts/{account_id}/acquisition", account_id: account_id) delete(path, **) end |
#remove_billing_info(account_id:, **options) ⇒ Resources::Empty
Remove an account's billing information
451 452 453 454 |
# File 'lib/recurly/client/operations.rb', line 451 def remove_billing_info(account_id:, **) path = interpolate_path("/accounts/{account_id}/billing_info", account_id: account_id) delete(path, **) end |
#remove_coupon_redemption(account_id:, **options) ⇒ Resources::CouponRedemption
Delete the active coupon redemption from an account
743 744 745 746 |
# File 'lib/recurly/client/operations.rb', line 743 def remove_coupon_redemption(account_id:, **) path = interpolate_path("/accounts/{account_id}/coupon_redemptions/active", account_id: account_id) delete(path, **) end |
#remove_line_item(line_item_id:, **options) ⇒ Resources::Empty
Delete an uninvoiced line item
3045 3046 3047 3048 |
# File 'lib/recurly/client/operations.rb', line 3045 def remove_line_item(line_item_id:, **) path = interpolate_path("/line_items/{line_item_id}", line_item_id: line_item_id) delete(path, **) end |
#remove_measured_unit(measured_unit_id:, **options) ⇒ Resources::MeasuredUnit
Remove a measured unit
2276 2277 2278 2279 |
# File 'lib/recurly/client/operations.rb', line 2276 def remove_measured_unit(measured_unit_id:, **) path = interpolate_path("/measured_units/{measured_unit_id}", measured_unit_id: measured_unit_id) delete(path, **) end |
#remove_plan(plan_id:, **options) ⇒ Resources::Plan
Remove a plan
3204 3205 3206 3207 |
# File 'lib/recurly/client/operations.rb', line 3204 def remove_plan(plan_id:, **) path = interpolate_path("/plans/{plan_id}", plan_id: plan_id) delete(path, **) end |
#remove_plan_add_on(plan_id:, add_on_id:, **options) ⇒ Resources::AddOn
Remove an add-on
3374 3375 3376 3377 |
# File 'lib/recurly/client/operations.rb', line 3374 def remove_plan_add_on(plan_id:, add_on_id:, **) path = interpolate_path("/plans/{plan_id}/add_ons/{add_on_id}", plan_id: plan_id, add_on_id: add_on_id) delete(path, **) end |
#remove_shipping_address(account_id:, shipping_address_id:, **options) ⇒ Resources::Empty
Remove an account's shipping address
1309 1310 1311 1312 |
# File 'lib/recurly/client/operations.rb', line 1309 def remove_shipping_address(account_id:, shipping_address_id:, **) path = interpolate_path("/accounts/{account_id}/shipping_addresses/{shipping_address_id}", account_id: account_id, shipping_address_id: shipping_address_id) delete(path, **) end |
#remove_subscription_change(subscription_id:, **options) ⇒ Resources::Empty
Delete the pending subscription change
3951 3952 3953 3954 |
# File 'lib/recurly/client/operations.rb', line 3951 def remove_subscription_change(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/change", subscription_id: subscription_id) delete(path, **) end |
#remove_usage(usage_id:, **options) ⇒ Resources::Empty
Delete a usage record.
4220 4221 4222 4223 |
# File 'lib/recurly/client/operations.rb', line 4220 def remove_usage(usage_id:, **) path = interpolate_path("/usage/{usage_id}", usage_id: usage_id) delete(path, **) end |
#reopen_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Reopen a closed, manual invoice
2754 2755 2756 2757 |
# File 'lib/recurly/client/operations.rb', line 2754 def reopen_invoice(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/reopen", invoice_id: invoice_id) put(path, **) end |
#restore_coupon(coupon_id:, body:, **options) ⇒ Resources::Coupon
Restore an inactive coupon
1698 1699 1700 1701 |
# File 'lib/recurly/client/operations.rb', line 1698 def restore_coupon(coupon_id:, body:, **) path = interpolate_path("/coupons/{coupon_id}/restore", coupon_id: coupon_id) put(path, body, Requests::CouponUpdate, **) end |
#resume_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Resume subscription
3831 3832 3833 3834 |
# File 'lib/recurly/client/operations.rb', line 3831 def resume_subscription(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/resume", subscription_id: subscription_id) put(path, **) end |
#show_external_invoice(external_invoice_id:, **options) ⇒ Resources::ExternalInvoice
Fetch an external invoice
4655 4656 4657 4658 |
# File 'lib/recurly/client/operations.rb', line 4655 def show_external_invoice(external_invoice_id:, **) path = interpolate_path("/external_invoices/{external_invoice_id}", external_invoice_id: external_invoice_id) get(path, **) end |
#terminate_subscription(subscription_id:, **options) ⇒ Resources::Subscription
Terminate a subscription
terminate_subscription api documentation
* +full+ - Performs a full refund of the last invoice for the current subscription term.
* +partial+ - Prorates a refund based on the amount of time remaining in the current bill cycle.
* +none+ - Terminates the subscription without a refund.
In the event that the most recent invoice is a $0 invoice paid entirely by credit, Recurly will apply the credit back to the customer’s account.
You may also terminate a subscription with no refund and then manually refund specific invoices.
:charge [Boolean] Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.
3725 3726 3727 3728 |
# File 'lib/recurly/client/operations.rb', line 3725 def terminate_subscription(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}", subscription_id: subscription_id) delete(path, **) end |
#update_a_billing_info(account_id:, billing_info_id:, body:, **options) ⇒ Resources::BillingInfo
Update an account's billing information
572 573 574 575 |
# File 'lib/recurly/client/operations.rb', line 572 def update_a_billing_info(account_id:, billing_info_id:, body:, **) path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: account_id, billing_info_id: billing_info_id) put(path, body, Requests::BillingInfoCreate, **) end |
#update_account(account_id:, body:, **options) ⇒ Resources::Account
Update an account
223 224 225 226 |
# File 'lib/recurly/client/operations.rb', line 223 def update_account(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}", account_id: account_id) put(path, body, Requests::AccountUpdate, **) end |
#update_account_acquisition(account_id:, body:, **options) ⇒ Resources::AccountAcquisition
Update an account's acquisition data
305 306 307 308 |
# File 'lib/recurly/client/operations.rb', line 305 def update_account_acquisition(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/acquisition", account_id: account_id) put(path, body, Requests::AccountAcquisitionUpdate, **) end |
#update_account_external_account(account_id:, external_account_id:, body:, **options) ⇒ Resources::ExternalAccount
Update an external account
840 841 842 843 |
# File 'lib/recurly/client/operations.rb', line 840 def update_account_external_account(account_id:, external_account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/external_accounts/{external_account_id}", account_id: account_id, external_account_id: external_account_id) put(path, body, Requests::ExternalAccountUpdate, **) end |
#update_billing_info(account_id:, body:, **options) ⇒ Resources::BillingInfo
Set an account's billing information
428 429 430 431 |
# File 'lib/recurly/client/operations.rb', line 428 def update_billing_info(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/billing_info", account_id: account_id) put(path, body, Requests::BillingInfoCreate, **) end |
#update_coupon(coupon_id:, body:, **options) ⇒ Resources::Coupon
Update an active coupon
1645 1646 1647 1648 |
# File 'lib/recurly/client/operations.rb', line 1645 def update_coupon(coupon_id:, body:, **) path = interpolate_path("/coupons/{coupon_id}", coupon_id: coupon_id) put(path, body, Requests::CouponUpdate, **) end |
#update_external_product(external_product_id:, body:, **options) ⇒ Resources::ExternalProduct
Update an external product
2336 2337 2338 2339 |
# File 'lib/recurly/client/operations.rb', line 2336 def update_external_product(external_product_id:, body:, **) path = interpolate_path("/external_products/{external_product_id}", external_product_id: external_product_id) put(path, body, Requests::ExternalProductUpdate, **) end |
#update_general_ledger_account(general_ledger_account_id:, body:, **options) ⇒ Resources::GeneralLedgerAccount
Update a general ledger account
1930 1931 1932 1933 |
# File 'lib/recurly/client/operations.rb', line 1930 def update_general_ledger_account(general_ledger_account_id:, body:, **) path = interpolate_path("/general_ledger_accounts/{general_ledger_account_id}", general_ledger_account_id: general_ledger_account_id) put(path, body, Requests::GeneralLedgerAccountUpdate, **) end |
#update_invoice(invoice_id:, body:, **options) ⇒ Resources::Invoice
Update an invoice
2611 2612 2613 2614 |
# File 'lib/recurly/client/operations.rb', line 2611 def update_invoice(invoice_id:, body:, **) path = interpolate_path("/invoices/{invoice_id}", invoice_id: invoice_id) put(path, body, Requests::InvoiceUpdate, **) end |
#update_item(item_id:, body:, **options) ⇒ Resources::Item
Update an active item
2135 2136 2137 2138 |
# File 'lib/recurly/client/operations.rb', line 2135 def update_item(item_id:, body:, **) path = interpolate_path("/items/{item_id}", item_id: item_id) put(path, body, Requests::ItemUpdate, **) end |
#update_measured_unit(measured_unit_id:, body:, **options) ⇒ Resources::MeasuredUnit
Update a measured unit
2262 2263 2264 2265 |
# File 'lib/recurly/client/operations.rb', line 2262 def update_measured_unit(measured_unit_id:, body:, **) path = interpolate_path("/measured_units/{measured_unit_id}", measured_unit_id: measured_unit_id) put(path, body, Requests::MeasuredUnitUpdate, **) end |
#update_plan(plan_id:, body:, **options) ⇒ Resources::Plan
Update a plan
3181 3182 3183 3184 |
# File 'lib/recurly/client/operations.rb', line 3181 def update_plan(plan_id:, body:, **) path = interpolate_path("/plans/{plan_id}", plan_id: plan_id) put(path, body, Requests::PlanUpdate, **) end |
#update_plan_add_on(plan_id:, add_on_id:, body:, **options) ⇒ Resources::AddOn
Update an add-on
3347 3348 3349 3350 |
# File 'lib/recurly/client/operations.rb', line 3347 def update_plan_add_on(plan_id:, add_on_id:, body:, **) path = interpolate_path("/plans/{plan_id}/add_ons/{add_on_id}", plan_id: plan_id, add_on_id: add_on_id) put(path, body, Requests::AddOnUpdate, **) end |
#update_shipping_address(account_id:, shipping_address_id:, body:, **options) ⇒ Resources::ShippingAddress
Update an account's shipping address
1282 1283 1284 1285 |
# File 'lib/recurly/client/operations.rb', line 1282 def update_shipping_address(account_id:, shipping_address_id:, body:, **) path = interpolate_path("/accounts/{account_id}/shipping_addresses/{shipping_address_id}", account_id: account_id, shipping_address_id: shipping_address_id) put(path, body, Requests::ShippingAddressUpdate, **) end |
#update_shipping_method(shipping_method_id:, body:, **options) ⇒ Resources::ShippingMethod
Update an active Shipping Method
3535 3536 3537 3538 |
# File 'lib/recurly/client/operations.rb', line 3535 def update_shipping_method(shipping_method_id:, body:, **) path = interpolate_path("/shipping_methods/{shipping_method_id}", shipping_method_id: shipping_method_id) put(path, body, Requests::ShippingMethodUpdate, **) end |
#update_subscription(subscription_id:, body:, **options) ⇒ Resources::Subscription
Update a subscription
3689 3690 3691 3692 |
# File 'lib/recurly/client/operations.rb', line 3689 def update_subscription(subscription_id:, body:, **) path = interpolate_path("/subscriptions/{subscription_id}", subscription_id: subscription_id) put(path, body, Requests::SubscriptionUpdate, **) end |
#update_usage(usage_id:, body:, **options) ⇒ Resources::Usage
Update a usage record
4206 4207 4208 4209 |
# File 'lib/recurly/client/operations.rb', line 4206 def update_usage(usage_id:, body:, **) path = interpolate_path("/usage/{usage_id}", usage_id: usage_id) put(path, body, Requests::UsageCreate, **) end |
#verify_billing_info(account_id:, **options) ⇒ Resources::Transaction
Verify an account's credit card billing information
475 476 477 478 |
# File 'lib/recurly/client/operations.rb', line 475 def verify_billing_info(account_id:, **) path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: account_id) post(path, [:body], Requests::BillingInfoVerify, **) end |
#verify_billing_info_cvv(account_id:, body:, **options) ⇒ Resources::Transaction
Verify an account's credit card billing cvv
490 491 492 493 |
# File 'lib/recurly/client/operations.rb', line 490 def verify_billing_info_cvv(account_id:, body:, **) path = interpolate_path("/accounts/{account_id}/billing_info/verify_cvv", account_id: account_id) post(path, body, Requests::BillingInfoVerifyCVV, **) end |
#verify_billing_infos(account_id:, billing_info_id:, **options) ⇒ Resources::Transaction
Verify a billing information's credit card
603 604 605 606 |
# File 'lib/recurly/client/operations.rb', line 603 def verify_billing_infos(account_id:, billing_info_id:, **) path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}/verify", account_id: account_id, billing_info_id: billing_info_id) post(path, [:body], Requests::BillingInfoVerify, **) end |
#verify_billing_infos_cvv(account_id:, billing_info_id:, body:, **options) ⇒ Resources::Transaction
Verify a billing information's credit card cvv
619 620 621 622 |
# File 'lib/recurly/client/operations.rb', line 619 def verify_billing_infos_cvv(account_id:, billing_info_id:, body:, **) path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv", account_id: account_id, billing_info_id: billing_info_id) post(path, body, Requests::BillingInfoVerifyCVV, **) end |
#void_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Void a credit invoice.
2777 2778 2779 2780 |
# File 'lib/recurly/client/operations.rb', line 2777 def void_invoice(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/void", invoice_id: invoice_id) put(path, **) end |