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.
-
#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_billing_info(account_id:, body:, **options) ⇒ Resources::BillingInfo
Add new billing information on an account.
-
#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_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_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_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_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) {|_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_subscriptions(**options) ⇒ Pager<Resources::ExternalSubscription>
List a site’s external subscriptions.
-
#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.
-
#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_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.
-
#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) {|_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) 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) 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
2480 2481 2482 2483 |
# File 'lib/recurly/client/operations.rb', line 2480 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
3570 3571 3572 3573 |
# File 'lib/recurly/client/operations.rb', line 3570 def cancel_subscription(subscription_id:, **) path = interpolate_path("/subscriptions/{subscription_id}/cancel", subscription_id: subscription_id) put(path, [:body], Requests::SubscriptionCancel, **) end |
#collect_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Collect a pending or past due, automatic invoice
2504 2505 2506 2507 |
# File 'lib/recurly/client/operations.rb', line 2504 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
3664 3665 3666 3667 |
# File 'lib/recurly/client/operations.rb', line 3664 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
777 778 779 780 |
# File 'lib/recurly/client/operations.rb', line 777 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_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_coupon(body:, **options) ⇒ Resources::Coupon
Create a new coupon
1562 1563 1564 1565 |
# File 'lib/recurly/client/operations.rb', line 1562 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
688 689 690 691 |
# File 'lib/recurly/client/operations.rb', line 688 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_product(body:, **options) ⇒ Resources::ExternalProduct
Create an external product
2171 2172 2173 2174 |
# File 'lib/recurly/client/operations.rb', line 2171 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
2247 2248 2249 2250 |
# File 'lib/recurly/client/operations.rb', line 2247 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_gift_card(body:, **options) ⇒ Resources::GiftCard
Create gift card
4522 4523 4524 4525 |
# File 'lib/recurly/client/operations.rb', line 4522 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
929 930 931 932 |
# File 'lib/recurly/client/operations.rb', line 929 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
1945 1946 1947 1948 |
# File 'lib/recurly/client/operations.rb', line 1945 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
1044 1045 1046 1047 |
# File 'lib/recurly/client/operations.rb', line 1044 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
2097 2098 2099 2100 |
# File 'lib/recurly/client/operations.rb', line 2097 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
4272 4273 4274 4275 |
# File 'lib/recurly/client/operations.rb', line 4272 def create_pending_purchase(body:, **) path = "/purchases/pending" post(path, body, Requests::PurchaseCreate, **) end |
#create_plan(body:, **options) ⇒ Resources::Plan
Create a plan
2950 2951 2952 2953 |
# File 'lib/recurly/client/operations.rb', line 2950 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
3108 3109 3110 3111 |
# File 'lib/recurly/client/operations.rb', line 3108 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
4190 4191 4192 4193 |
# File 'lib/recurly/client/operations.rb', line 4190 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
1188 1189 1190 1191 |
# File 'lib/recurly/client/operations.rb', line 1188 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
3325 3326 3327 3328 |
# File 'lib/recurly/client/operations.rb', line 3325 def create_shipping_method(body:, **) path = "/shipping_methods" post(path, body, Requests::ShippingMethodCreate, **) end |
#create_subscription(body:, **options) ⇒ Resources::Subscription
Create a new subscription
3452 3453 3454 3455 |
# File 'lib/recurly/client/operations.rb', line 3452 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
3745 3746 3747 3748 |
# File 'lib/recurly/client/operations.rb', line 3745 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
3995 3996 3997 3998 |
# File 'lib/recurly/client/operations.rb', line 3995 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
1635 1636 1637 1638 |
# File 'lib/recurly/client/operations.rb', line 1635 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
2277 2278 2279 2280 |
# File 'lib/recurly/client/operations.rb', line 2277 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
2214 2215 2216 2217 |
# File 'lib/recurly/client/operations.rb', line 2214 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
2022 2023 2024 2025 |
# File 'lib/recurly/client/operations.rb', line 2022 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
3368 3369 3370 3371 |
# File 'lib/recurly/client/operations.rb', line 3368 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
4136 4137 4138 4139 |
# File 'lib/recurly/client/operations.rb', line 4136 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
823 824 825 826 |
# File 'lib/recurly/client/operations.rb', line 823 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
1650 1651 1652 1653 |
# File 'lib/recurly/client/operations.rb', line 1650 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
792 793 794 795 |
# File 'lib/recurly/client/operations.rb', line 792 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
1105 1106 1107 1108 |
# File 'lib/recurly/client/operations.rb', line 1105 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
3264 3265 3266 3267 |
# File 'lib/recurly/client/operations.rb', line 3264 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
4482 4483 4484 4485 |
# File 'lib/recurly/client/operations.rb', line 4482 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
1585 1586 1587 1588 |
# File 'lib/recurly/client/operations.rb', line 1585 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
1750 1751 1752 1753 |
# File 'lib/recurly/client/operations.rb', line 1750 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
1821 1822 1823 1824 |
# File 'lib/recurly/client/operations.rb', line 1821 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
4352 4353 4354 4355 |
# File 'lib/recurly/client/operations.rb', line 4352 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.
4296 4297 4298 4299 |
# File 'lib/recurly/client/operations.rb', line 4296 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.
4321 4322 4323 4324 |
# File 'lib/recurly/client/operations.rb', line 4321 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
2185 2186 2187 2188 |
# File 'lib/recurly/client/operations.rb', line 2185 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
2262 2263 2264 2265 |
# File 'lib/recurly/client/operations.rb', line 2262 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
2308 2309 2310 2311 |
# File 'lib/recurly/client/operations.rb', line 2308 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_gift_card(gift_card_id:, **options) ⇒ Resources::GiftCard
Fetch a gift card
4536 4537 4538 4539 |
# File 'lib/recurly/client/operations.rb', line 4536 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
2402 2403 2404 2405 |
# File 'lib/recurly/client/operations.rb', line 2402 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
2456 2457 2458 2459 |
# File 'lib/recurly/client/operations.rb', line 2456 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
4398 4399 4400 4401 |
# File 'lib/recurly/client/operations.rb', line 4398 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
1968 1969 1970 1971 |
# File 'lib/recurly/client/operations.rb', line 1968 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
2839 2840 2841 2842 |
# File 'lib/recurly/client/operations.rb', line 2839 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
2111 2112 2113 2114 |
# File 'lib/recurly/client/operations.rb', line 2111 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_plan(plan_id:, **options) ⇒ Resources::Plan
Fetch a plan
2973 2974 2975 2976 |
# File 'lib/recurly/client/operations.rb', line 2973 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
3134 3135 3136 3137 |
# File 'lib/recurly/client/operations.rb', line 3134 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)
3689 3690 3691 3692 |
# File 'lib/recurly/client/operations.rb', line 3689 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
1215 1216 1217 1218 |
# File 'lib/recurly/client/operations.rb', line 1215 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
3339 3340 3341 3342 |
# File 'lib/recurly/client/operations.rb', line 3339 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
3477 3478 3479 3480 |
# File 'lib/recurly/client/operations.rb', line 3477 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
3714 3715 3716 3717 |
# File 'lib/recurly/client/operations.rb', line 3714 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
4108 4109 4110 4111 |
# File 'lib/recurly/client/operations.rb', line 4108 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
4122 4123 4124 4125 |
# File 'lib/recurly/client/operations.rb', line 4122 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
4009 4010 4011 4012 |
# File 'lib/recurly/client/operations.rb', line 4009 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.
1481 1482 1483 1484 |
# File 'lib/recurly/client/operations.rb', line 1481 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.
635 636 637 638 |
# File 'lib/recurly/client/operations.rb', line 635 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.
748 749 750 751 |
# File 'lib/recurly/client/operations.rb', line 748 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
762 763 764 765 |
# File 'lib/recurly/client/operations.rb', line 762 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.
843 844 845 846 |
# File 'lib/recurly/client/operations.rb', line 843 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.
4468 4469 4470 4471 |
# File 'lib/recurly/client/operations.rb', line 4468 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.
: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.
898 899 900 901 |
# File 'lib/recurly/client/operations.rb', line 898 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.
1012 1013 1014 1015 |
# File 'lib/recurly/client/operations.rb', line 1012 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.
1078 1079 1080 1081 |
# File 'lib/recurly/client/operations.rb', line 1078 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.
1331 1332 1333 1334 |
# File 'lib/recurly/client/operations.rb', line 1331 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.
1382 1383 1384 1385 |
# File 'lib/recurly/client/operations.rb', line 1382 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
657 658 659 660 |
# File 'lib/recurly/client/operations.rb', line 657 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.
3241 3242 3243 3244 |
# File 'lib/recurly/client/operations.rb', line 3241 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
4495 4496 4497 4498 |
# File 'lib/recurly/client/operations.rb', line 4495 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.
: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.
4609 4610 4611 4612 |
# File 'lib/recurly/client/operations.rb', line 4609 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.
1436 1437 1438 1439 |
# File 'lib/recurly/client/operations.rb', line 1436 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.
1526 1527 1528 1529 |
# File 'lib/recurly/client/operations.rb', line 1526 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.
1736 1737 1738 1739 |
# File 'lib/recurly/client/operations.rb', line 1736 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.
1796 1797 1798 1799 |
# File 'lib/recurly/client/operations.rb', line 1796 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.
4338 4339 4340 4341 |
# File 'lib/recurly/client/operations.rb', line 4338 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.
4450 4451 4452 4453 |
# File 'lib/recurly/client/operations.rb', line 4450 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.
4417 4418 4419 4420 |
# File 'lib/recurly/client/operations.rb', line 4417 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.
2232 2233 2234 2235 |
# File 'lib/recurly/client/operations.rb', line 2232 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.
2157 2158 2159 2160 |
# File 'lib/recurly/client/operations.rb', line 2157 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.
2328 2329 2330 2331 |
# File 'lib/recurly/client/operations.rb', line 2328 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_subscriptions(**options) ⇒ Pager<Resources::ExternalSubscription>
List a site’s external subscriptions
list_external_subscriptions api documentation
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
2294 2295 2296 2297 |
# File 'lib/recurly/client/operations.rb', line 2294 def list_external_subscriptions(**) path = "/external_subscriptions" pager(path, **) end |
#list_gift_cards(**options) ⇒ Pager<Resources::GiftCard>
List gift cards
4508 4509 4510 4511 |
# File 'lib/recurly/client/operations.rb', line 4508 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.
2710 2711 2712 2713 |
# File 'lib/recurly/client/operations.rb', line 2710 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.
2663 2664 2665 2666 |
# File 'lib/recurly/client/operations.rb', line 2663 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.
1864 1865 1866 1867 |
# File 'lib/recurly/client/operations.rb', line 1864 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.
4384 4385 4386 4387 |
# File 'lib/recurly/client/operations.rb', line 4384 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.
: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.
2379 2380 2381 2382 |
# File 'lib/recurly/client/operations.rb', line 2379 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.
1910 1911 1912 1913 |
# File 'lib/recurly/client/operations.rb', line 1910 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.
2816 2817 2818 2819 |
# File 'lib/recurly/client/operations.rb', line 2816 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.
2083 2084 2085 2086 |
# File 'lib/recurly/client/operations.rb', line 2083 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.
3073 3074 3075 3076 |
# File 'lib/recurly/client/operations.rb', line 3073 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.
2910 2911 2912 2913 |
# File 'lib/recurly/client/operations.rb', line 2910 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
2735 2736 2737 2738 |
# File 'lib/recurly/client/operations.rb', line 2735 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.
1154 1155 1156 1157 |
# File 'lib/recurly/client/operations.rb', line 1154 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.
3311 3312 3313 3314 |
# File 'lib/recurly/client/operations.rb', line 3311 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.
3939 3940 3941 3942 |
# File 'lib/recurly/client/operations.rb', line 3939 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.
: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.
3840 3841 3842 3843 |
# File 'lib/recurly/client/operations.rb', line 3840 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.
3892 3893 3894 3895 |
# File 'lib/recurly/client/operations.rb', line 3892 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.
3419 3420 3421 3422 |
# File 'lib/recurly/client/operations.rb', line 3419 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.
4085 4086 4087 4088 |
# File 'lib/recurly/client/operations.rb', line 4085 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.
1703 1704 1705 1706 |
# File 'lib/recurly/client/operations.rb', line 1703 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
3979 3980 3981 3982 |
# File 'lib/recurly/client/operations.rb', line 3979 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
2527 2528 2529 2530 |
# File 'lib/recurly/client/operations.rb', line 2527 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
2550 2551 2552 2553 |
# File 'lib/recurly/client/operations.rb', line 2550 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
3625 3626 3627 3628 |
# File 'lib/recurly/client/operations.rb', line 3625 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
4550 4551 4552 4553 |
# File 'lib/recurly/client/operations.rb', line 4550 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
960 961 962 963 |
# File 'lib/recurly/client/operations.rb', line 960 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
4230 4231 4232 4233 |
# File 'lib/recurly/client/operations.rb', line 4230 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
3785 3786 3787 3788 |
# File 'lib/recurly/client/operations.rb', line 3785 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
4367 4368 4369 4370 |
# File 'lib/recurly/client/operations.rb', line 4367 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 |
#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
2045 2046 2047 2048 |
# File 'lib/recurly/client/operations.rb', line 2045 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
3595 3596 3597 3598 |
# File 'lib/recurly/client/operations.rb', line 3595 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
4150 4151 4152 4153 |
# File 'lib/recurly/client/operations.rb', line 4150 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.
2611 2612 2613 2614 |
# File 'lib/recurly/client/operations.rb', line 2611 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
4565 4566 4567 4568 |
# File 'lib/recurly/client/operations.rb', line 4565 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
2766 2767 2768 2769 |
# File 'lib/recurly/client/operations.rb', line 2766 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
711 712 713 714 |
# File 'lib/recurly/client/operations.rb', line 711 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
2864 2865 2866 2867 |
# File 'lib/recurly/client/operations.rb', line 2864 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
2140 2141 2142 2143 |
# File 'lib/recurly/client/operations.rb', line 2140 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
3023 3024 3025 3026 |
# File 'lib/recurly/client/operations.rb', line 3023 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
3193 3194 3195 3196 |
# File 'lib/recurly/client/operations.rb', line 3193 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
1276 1277 1278 1279 |
# File 'lib/recurly/client/operations.rb', line 1276 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
3770 3771 3772 3773 |
# File 'lib/recurly/client/operations.rb', line 3770 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.
4038 4039 4040 4041 |
# File 'lib/recurly/client/operations.rb', line 4038 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
2573 2574 2575 2576 |
# File 'lib/recurly/client/operations.rb', line 2573 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
1665 1666 1667 1668 |
# File 'lib/recurly/client/operations.rb', line 1665 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
3650 3651 3652 3653 |
# File 'lib/recurly/client/operations.rb', line 3650 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
4431 4432 4433 4434 |
# File 'lib/recurly/client/operations.rb', line 4431 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.
3544 3545 3546 3547 |
# File 'lib/recurly/client/operations.rb', line 3544 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
808 809 810 811 |
# File 'lib/recurly/client/operations.rb', line 808 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
1612 1613 1614 1615 |
# File 'lib/recurly/client/operations.rb', line 1612 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
2200 2201 2202 2203 |
# File 'lib/recurly/client/operations.rb', line 2200 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_invoice(invoice_id:, body:, **options) ⇒ Resources::Invoice
Update an invoice
2430 2431 2432 2433 |
# File 'lib/recurly/client/operations.rb', line 2430 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
1999 2000 2001 2002 |
# File 'lib/recurly/client/operations.rb', line 1999 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
2126 2127 2128 2129 |
# File 'lib/recurly/client/operations.rb', line 2126 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
3000 3001 3002 3003 |
# File 'lib/recurly/client/operations.rb', line 3000 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
3166 3167 3168 3169 |
# File 'lib/recurly/client/operations.rb', line 3166 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
1249 1250 1251 1252 |
# File 'lib/recurly/client/operations.rb', line 1249 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
3354 3355 3356 3357 |
# File 'lib/recurly/client/operations.rb', line 3354 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
3508 3509 3510 3511 |
# File 'lib/recurly/client/operations.rb', line 3508 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
4024 4025 4026 4027 |
# File 'lib/recurly/client/operations.rb', line 4024 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 |
#void_invoice(invoice_id:, **options) ⇒ Resources::Invoice
Void a credit invoice.
2596 2597 2598 2599 |
# File 'lib/recurly/client/operations.rb', line 2596 def void_invoice(invoice_id:, **) path = interpolate_path("/invoices/{invoice_id}/void", invoice_id: invoice_id) put(path, **) end |