Class: Recurly::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/recurly/client.rb,
lib/recurly/client/operations.rb

Constant Summary collapse

BASE_HOST =
"v3.recurly.com"
BASE_PORT =
443
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

Constructor Details

#initialize(api_key:, logger: nil) {|_self| ... } ⇒ Client

Initialize a client. It requires an API key.

Examples:

API_KEY = '83749879bbde395b5fe0cc1a5abf8e5'
client = Recurly::Client.new(api_key: API_KEY)
sub = client.get_subscription(subscription_id: 'abcd123456')
# You can also pass the initializer a block. This will give you
# a client scoped for just that block
Recurly::Client.new(api_key: API_KEY) do |client|
  sub = client.get_subscription(subscription_id: 'abcd123456')
end
# If you only plan on using the client for more than one site,
# you should initialize a new client for each site.

client = Recurly::Client.new(api_key: API_KEY1)
sub = client.get_subscription(subscription_id: 'uuid-abcd123456')

# you should create a new client to connect to another site
client = Recurly::Client.new(api_key: API_KEY2)
sub = client.get_subscription(subscription_id: 'uuid-abcd7890')

Parameters:

  • api_key (String)

    The private API key

  • logger (Logger) (defaults to: nil)

    A logger to use. Defaults to creating a new STDOUT logger with level WARN.

Yields:

  • (_self)

Yield Parameters:

Raises:

  • (ArgumentError)

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/recurly/client.rb', line 57

def initialize(api_key:, logger: nil)
  raise ArgumentError, "'api_key' must be set to a non-nil value" if api_key.nil?

  set_api_key(api_key)

  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_poolRecurly::ConnectionPool


157
158
159
# File 'lib/recurly/client.rb', line 157

def connection_pool
  @connection_pool
end

Instance Method Details

#api_versionObject


7
8
9
# File 'lib/recurly/client/operations.rb', line 7

def api_version
  "v2021-02-25"
end

#cancel_subscription(subscription_id:, **options) ⇒ Resources::Subscription

Cancel a subscription

cancel_subscription api documenation

Examples:

begin
  subscription = @client.cancel_subscription(
    subscription_id: subscription_id
  )
  puts "Canceled Subscription #{subscription}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters: :body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::SubscriptionCancel

Returns:


3180
3181
3182
3183
# File 'lib/recurly/client/operations.rb', line 3180

def cancel_subscription(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/cancel", subscription_id: subscription_id)
  put(path, options[:body], Requests::SubscriptionCancel, **options)
end

#collect_invoice(invoice_id:, **options) ⇒ Resources::Invoice

Collect a pending or past due, automatic invoice

collect_invoice api documenation

Examples:

begin
  invoice = @client.collect_invoice(invoice_id: invoice_id)
  puts "Collected invoice #{invoice}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters: :body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::InvoiceCollect

Returns:


2114
2115
2116
2117
# File 'lib/recurly/client/operations.rb', line 2114

def collect_invoice(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}/collect", invoice_id: invoice_id)
  put(path, options[:body], Requests::InvoiceCollect, **options)
end

#convert_trial(subscription_id:, **options) ⇒ Resources::Subscription

Convert trial subscription

convert_trial api documenation

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters:

Returns:


3274
3275
3276
3277
# File 'lib/recurly/client/operations.rb', line 3274

def convert_trial(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/convert_trial", subscription_id: subscription_id)
  put(path, **options)
end

#create_account(body:, **options) ⇒ Resources::Account

Examples:

begin
   = {
    code: ,
    first_name: "Benjamin",
    last_name: "Du Monde",
    acquisition: {
      campaign: "podcast-marketing",
      channel: "social_media",
      subchannel: "twitter",
      cost: {
        currency: "USD",
        amount: 0.50
      }
    },
    shipping_addresses: [
      {
        nickname: "Home",
        street1: "1 Tchoupitoulas St",
        city: "New Orleans",
        region: "LA",
        country: "US",
        postal_code: "70115",
        first_name: "Benjamin",
        last_name: "Du Monde"
      }
    ]
  }
   = @client.(body: )
  puts "Created Account #{}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

Returns:


168
169
170
171
# File 'lib/recurly/client/operations.rb', line 168

def (body:, **options)
  path = "/accounts"
  post(path, body, Requests::AccountCreate, **options)
end

#create_billing_info(account_id:, body:, **options) ⇒ Resources::BillingInfo

Set an account's billing information when the wallet feature is enabled

create_billing_info api documenation

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::BillingInfoCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::BillingInfoCreate

  • params (Hash)

    Optional query string parameters:

Returns:


501
502
503
504
# File 'lib/recurly/client/operations.rb', line 501

def create_billing_info(account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_infos", account_id: )
  post(path, body, Requests::BillingInfoCreate, **options)
end

#create_coupon(body:, **options) ⇒ Resources::Coupon

Create a new coupon

create_coupon api documenation

Examples:

begin
  coupon_create = {
    name: "Promotional Coupon",
    code: coupon_code,
    discount_type: 'fixed',
    currencies: [
      {
        currency: 'USD',
        discount: 10_000
      }
    ]
  }
  coupon = @client.create_coupon(
    body: coupon_create
  )
  puts "Created Coupon #{coupon}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

Returns:


1427
1428
1429
1430
# File 'lib/recurly/client/operations.rb', line 1427

def create_coupon(body:, **options)
  path = "/coupons"
  post(path, body, Requests::CouponCreate, **options)
end

#create_coupon_redemption(account_id:, body:, **options) ⇒ Resources::CouponRedemption

Generate an active coupon redemption on an account or subscription

create_coupon_redemption api documenation

Examples:

begin
  redemption_create = {
    currency: 'USD',
    coupon_id: coupon_id
  }
  redemption = @client.create_coupon_redemption(
    account_id: ,
    body: redemption_create
  )
  puts "Created CouponRedemption #{redemption}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::CouponRedemptionCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::CouponRedemptionCreate

  • params (Hash)

    Optional query string parameters:

Returns:


648
649
650
651
# File 'lib/recurly/client/operations.rb', line 648

def create_coupon_redemption(account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/coupon_redemptions/active", account_id: )
  post(path, body, Requests::CouponRedemptionCreate, **options)
end

#create_invoice(account_id:, body:, **options) ⇒ Resources::InvoiceCollection

Create an invoice for pending line items

create_invoice api documenation

Examples:

begin
  invoice_create = {
    currency: 'USD',
    collection_method: 'automatic'
  }
  collection = @client.create_invoice(
    account_id: ,
    body: invoice_create
  )
  puts "Created InvoiceCollection #{collection}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::InvoiceCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::InvoiceCreate

  • params (Hash)

    Optional query string parameters:

Returns:


794
795
796
797
# File 'lib/recurly/client/operations.rb', line 794

def create_invoice(account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/invoices", account_id: )
  post(path, body, Requests::InvoiceCreate, **options)
end

#create_item(body:, **options) ⇒ Resources::Item

Create a new item

create_item api documenation

Examples:

begin
  item_create = {
    code: item_code,
    name: "Item Name",
    description: "Item Description",
    external_sku: "a35JE-44",
    accounting_code: "item-code-127",
    revenue_schedule_type: "at_range_end",
    custom_fields: [{
      name: "custom-field-1",
      value: "Custom Field 1 value"
    }]
  }
  item = @client.create_item(body: item_create)
  puts "Created Item #{item}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • body (Requests::ItemCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::ItemCreate

  • params (Hash)

    Optional query string parameters:

Returns:


1767
1768
1769
1770
# File 'lib/recurly/client/operations.rb', line 1767

def create_item(body:, **options)
  path = "/items"
  post(path, body, Requests::ItemCreate, **options)
end

#create_line_item(account_id:, body:, **options) ⇒ Resources::LineItem

Create a new line item for the account

create_line_item api documenation

Examples:

begin
  line_item_create = {
    currency: 'USD',
    unit_amount: 1_000,
    type: :charge
  }
  line_item = @client.create_line_item(
    account_id: ,
    body: line_item_create
  )
  puts "Created LineItem #{line_item}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::LineItemCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::LineItemCreate

  • params (Hash)

    Optional query string parameters:

Returns:


909
910
911
912
# File 'lib/recurly/client/operations.rb', line 909

def create_line_item(account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/line_items", account_id: )
  post(path, body, Requests::LineItemCreate, **options)
end

#create_measured_unit(body:, **options) ⇒ Resources::MeasuredUnit

Create a new measured unit

create_measured_unit api documenation

Parameters:

Returns:


1919
1920
1921
1922
# File 'lib/recurly/client/operations.rb', line 1919

def create_measured_unit(body:, **options)
  path = "/measured_units"
  post(path, body, Requests::MeasuredUnitCreate, **options)
end

#create_plan(body:, **options) ⇒ Resources::Plan

Examples:

begin
  plan_create = {
    code: plan_code,
    name: plan_name,
    currencies: [
      currency: "USD",
      setup_fee: 1_000
    ],
    add_ons: [
      {
        name: 'Extra User',
        code: 'extra_user',
        currencies: [
          { currency: 'USD', unit_amount: 10_000 }
        ]
      }
    ]
  }
  plan = @client.create_plan(body: plan_create)
  puts "Created Plan #{plan}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • body (Requests::PlanCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::PlanCreate

  • params (Hash)

    Optional query string parameters:

Returns:


2560
2561
2562
2563
# File 'lib/recurly/client/operations.rb', line 2560

def create_plan(body:, **options)
  path = "/plans"
  post(path, body, Requests::PlanCreate, **options)
end

#create_plan_add_on(plan_id:, body:, **options) ⇒ Resources::AddOn

Examples:

begin
  new_add_on = {
    code: 'coffee_grinder',
    name: 'A quality grinder for your beans',
    default_quantity: 1,
    currencies: [
      {
        currency: 'USD',
        unit_amount: 10_000
      }
    ]
  }
  add_on = @client.create_plan_add_on(plan_id: plan_id, body: new_add_on)
  puts "Created plan add-on #{add_on}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • plan_id (String)

    Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • body (Requests::AddOnCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::AddOnCreate

  • params (Hash)

    Optional query string parameters:

Returns:


2718
2719
2720
2721
# File 'lib/recurly/client/operations.rb', line 2718

def create_plan_add_on(plan_id:, body:, **options)
  path = interpolate_path("/plans/{plan_id}/add_ons", plan_id: plan_id)
  post(path, body, Requests::AddOnCreate, **options)
end

#create_purchase(body:, **options) ⇒ Resources::InvoiceCollection

Create a new purchase

create_purchase api documenation

Examples:

begin
  purchase = {
    currency: "USD",
    account: {
      code: ,
      first_name: "Benjamin",
      last_name: "Du Monde",
      billing_info: {
        token_id: rjs_token_id
      },
    },
    subscriptions: [
      { plan_code: plan_code }
    ]
  }
  invoice_collection = @client.create_purchase(
    body: purchase
  )
  puts "Created Charge Invoice #{invoice_collection.charge_invoice}"
  puts "Created Credit Invoices #{invoice_collection.credit_invoices}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

Returns:


3775
3776
3777
3778
# File 'lib/recurly/client/operations.rb', line 3775

def create_purchase(body:, **options)
  path = "/purchases"
  post(path, body, Requests::PurchaseCreate, **options)
end

#create_shipping_address(account_id:, body:, **options) ⇒ Resources::ShippingAddress

Create a new shipping address for the account

create_shipping_address api documenation

Examples:

begin
  shipping_address_create = {
    nickname: 'Work',
    street1: '900 Camp St',
    city: 'New Orleans',
    region: 'LA',
    country: 'US',
    postal_code: '70115',
    first_name: 'Joanna',
    last_name: 'Du Monde'
  }
  shipping_address = @client.create_shipping_address(account_id: , body: shipping_address_create)
  puts "Created Shipping Address #{shipping_address}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::ShippingAddressCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::ShippingAddressCreate

  • params (Hash)

    Optional query string parameters:

Returns:


1053
1054
1055
1056
# File 'lib/recurly/client/operations.rb', line 1053

def create_shipping_address(account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/shipping_addresses", account_id: )
  post(path, body, Requests::ShippingAddressCreate, **options)
end

#create_shipping_method(body:, **options) ⇒ Resources::ShippingMethod

Create a new shipping method

create_shipping_method api documenation

Parameters:

Returns:


2935
2936
2937
2938
# File 'lib/recurly/client/operations.rb', line 2935

def create_shipping_method(body:, **options)
  path = "/shipping_methods"
  post(path, body, Requests::ShippingMethodCreate, **options)
end

#create_subscription(body:, **options) ⇒ Resources::Subscription

Create a new subscription

create_subscription api documenation

Examples:

begin
  subscription_create = {
    plan_code: plan_code,
    currency: "USD",
    # This can be an existing account or a new account
    account: {
      code: ,
    }
  }
  subscription = @client.create_subscription(
    body: subscription_create
  )
  puts "Created Subscription #{subscription}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

Returns:


3062
3063
3064
3065
# File 'lib/recurly/client/operations.rb', line 3062

def create_subscription(body:, **options)
  path = "/subscriptions"
  post(path, body, Requests::SubscriptionCreate, **options)
end

#create_subscription_change(subscription_id:, body:, **options) ⇒ Resources::SubscriptionChange

Create a new subscription change

create_subscription_change api documenation

Examples:

begin
  change_create = {
    timeframe: "now",
    plan_code: new_plan_code
  }
  change = @client.create_subscription_change(
    subscription_id: subscription_id,
    body: change_create
  )
  puts "Created SubscriptionChange #{change}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • body (Requests::SubscriptionChangeCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::SubscriptionChangeCreate

  • params (Hash)

    Optional query string parameters:

Returns:


3330
3331
3332
3333
# File 'lib/recurly/client/operations.rb', line 3330

def create_subscription_change(subscription_id:, body:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/change", subscription_id: subscription_id)
  post(path, body, Requests::SubscriptionChangeCreate, **options)
end

#create_usage(subscription_id:, add_on_id:, body:, **options) ⇒ Resources::Usage

Log a usage record on this subscription add-on

create_usage api documenation

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • add_on_id (String)

    Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • body (Requests::UsageCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::UsageCreate

  • params (Hash)

    Optional query string parameters:

Returns:


3580
3581
3582
3583
# File 'lib/recurly/client/operations.rb', line 3580

def create_usage(subscription_id:, add_on_id:, body:, **options)
  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, **options)
end

#deactivate_account(account_id:, **options) ⇒ Resources::Account

Deactivate an account

deactivate_account api documenation

Examples:

begin
   = @client.(account_id: )
  puts "Deactivated Account #{}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


245
246
247
248
# File 'lib/recurly/client/operations.rb', line 245

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}", account_id: )
  delete(path, **options)
end

#deactivate_coupon(coupon_id:, **options) ⇒ Resources::Coupon

Examples:

begin
  coupon = @client.deactivate_coupon(coupon_id: coupon_id)
  puts "Deactivated Coupon #{coupon}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • coupon_id (String)

    Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.

  • params (Hash)

    Optional query string parameters:

Returns:


1500
1501
1502
1503
# File 'lib/recurly/client/operations.rb', line 1500

def deactivate_coupon(coupon_id:, **options)
  path = interpolate_path("/coupons/{coupon_id}", coupon_id: coupon_id)
  delete(path, **options)
end

#deactivate_item(item_id:, **options) ⇒ Resources::Item

Examples:

begin
  item = @client.deactivate_item(item_id: item_id)
  puts "Deactivated Item #{item}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • item_id (String)

    Item ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-red.

  • params (Hash)

    Optional query string parameters:

Returns:


1844
1845
1846
1847
# File 'lib/recurly/client/operations.rb', line 1844

def deactivate_item(item_id:, **options)
  path = interpolate_path("/items/{item_id}", item_id: item_id)
  delete(path, **options)
end

#deactivate_shipping_method(shipping_method_id:, **options) ⇒ Resources::ShippingMethod

Deactivate a shipping method

deactivate_shipping_method api documenation

Parameters:

  • shipping_method_id (String)

    Shipping Method ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-usps_2-day.

  • params (Hash)

    Optional query string parameters:

Returns:


2978
2979
2980
2981
# File 'lib/recurly/client/operations.rb', line 2978

def deactivate_shipping_method(shipping_method_id:, **options)
  path = interpolate_path("/shipping_methods/{shipping_method_id}", shipping_method_id: shipping_method_id)
  delete(path, **options)
end

#deactivate_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode

Deactivate a unique coupon code

deactivate_unique_coupon_code api documenation

Parameters:

  • unique_coupon_code_id (String)

    Unique Coupon Code ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-abc-8dh2-def.

  • params (Hash)

    Optional query string parameters:

Returns:


3721
3722
3723
3724
# File 'lib/recurly/client/operations.rb', line 3721

def deactivate_unique_coupon_code(unique_coupon_code_id:, **options)
  path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}", unique_coupon_code_id: unique_coupon_code_id)
  delete(path, **options)
end

#generate_unique_coupon_codes(coupon_id:, body:, **options) ⇒ Resources::UniqueCouponCodeParams

Generate unique coupon codes

generate_unique_coupon_codes api documenation

Parameters:

  • coupon_id (String)

    Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.

  • body (Requests::CouponBulkCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::CouponBulkCreate

  • params (Hash)

    Optional query string parameters:

Returns:

  • (Resources::UniqueCouponCodeParams)

    A set of parameters that can be passed to the `list_unique_coupon_codes` endpoint to obtain only the newly generated `UniqueCouponCodes`.


1515
1516
1517
1518
# File 'lib/recurly/client/operations.rb', line 1515

def generate_unique_coupon_codes(coupon_id:, body:, **options)
  path = interpolate_path("/coupons/{coupon_id}/generate", coupon_id: coupon_id)
  post(path, body, Requests::CouponBulkCreate, **options)
end

#get_a_billing_info(account_id:, billing_info_id:, **options) ⇒ Resources::BillingInfo

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • billing_info_id (String)

    Billing Info ID.

  • params (Hash)

    Optional query string parameters:

Returns:


516
517
518
519
# File 'lib/recurly/client/operations.rb', line 516

def get_a_billing_info(account_id:, billing_info_id:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: , billing_info_id: billing_info_id)
  get(path, **options)
end

#get_account(account_id:, **options) ⇒ Resources::Account

Fetch an account

get_account api documenation

Examples:

begin
   = @client.(account_id: )
  puts "Got Account #{}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


191
192
193
194
# File 'lib/recurly/client/operations.rb', line 191

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}", account_id: )
  get(path, **options)
end

#get_account_acquisition(account_id:, **options) ⇒ Resources::AccountAcquisition

Fetch an account's acquisition data

get_account_acquisition api documenation

Examples:

begin
  @client.(account_id: )
  puts "Got AccountAcquisition"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


268
269
270
271
# File 'lib/recurly/client/operations.rb', line 268

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/acquisition", account_id: )
  get(path, **options)
end

#get_account_balance(account_id:, **options) ⇒ Resources::AccountBalance

Fetch an account's balance and past due status

get_account_balance api documenation

Examples:

begin
  balance = @client.(account_id: )
  puts "Got AccountBalance #{balance}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


373
374
375
376
# File 'lib/recurly/client/operations.rb', line 373

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/balance", account_id: )
  get(path, **options)
end

#get_account_note(account_id:, account_note_id:, **options) ⇒ Resources::AccountNote

Fetch an account note

get_account_note api documenation

Examples:

begin
  note = @client.(
    account_id: ,
    account_note_id: note_id
  )
  puts "Got AccountNote #{note}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • account_note_id (String)

    Account Note ID.

  • params (Hash)

    Optional query string parameters:

Returns:


970
971
972
973
# File 'lib/recurly/client/operations.rb', line 970

def (account_id:, account_note_id:, **options)
  path = interpolate_path("/accounts/{account_id}/notes/{account_note_id}", account_id: , account_note_id: )
  get(path, **options)
end

#get_add_on(add_on_id:, **options) ⇒ Resources::AddOn

Fetch an add-on

get_add_on api documenation

Examples:

begin
  add_on = @client.get_add_on(add_on_id: add_on_id)
  puts "Got add-on #{add_on}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • add_on_id (String)

    Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • params (Hash)

    Optional query string parameters:

Returns:


2874
2875
2876
2877
# File 'lib/recurly/client/operations.rb', line 2874

def get_add_on(add_on_id:, **options)
  path = interpolate_path("/add_ons/{add_on_id}", add_on_id: add_on_id)
  get(path, **options)
end

#get_billing_info(account_id:, **options) ⇒ Resources::BillingInfo

Fetch an account's billing information

get_billing_info api documenation

Examples:

begin
  billing = @client.get_billing_info(account_id: )
  puts "Got BillingInfo #{billing}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


396
397
398
399
# File 'lib/recurly/client/operations.rb', line 396

def get_billing_info(account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_info", account_id: )
  get(path, **options)
end

#get_coupon(coupon_id:, **options) ⇒ Resources::Coupon

Examples:

begin
  coupon = @client.get_coupon(coupon_id: coupon_id)
  puts "Got Coupon #{coupon}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • coupon_id (String)

    Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.

  • params (Hash)

    Optional query string parameters:

Returns:


1450
1451
1452
1453
# File 'lib/recurly/client/operations.rb', line 1450

def get_coupon(coupon_id:, **options)
  path = interpolate_path("/coupons/{coupon_id}", coupon_id: coupon_id)
  get(path, **options)
end

#get_credit_payment(credit_payment_id:, **options) ⇒ Resources::CreditPayment

Fetch a credit payment

get_credit_payment api documenation

Parameters:

  • credit_payment_id (String)

    Credit Payment ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters:

Returns:


1615
1616
1617
1618
# File 'lib/recurly/client/operations.rb', line 1615

def get_credit_payment(credit_payment_id:, **options)
  path = interpolate_path("/credit_payments/{credit_payment_id}", credit_payment_id: credit_payment_id)
  get(path, **options)
end

#get_custom_field_definition(custom_field_definition_id:, **options) ⇒ Resources::CustomFieldDefinition

Fetch an custom field definition

get_custom_field_definition api documenation

Examples:

begin
  custom_field_definition = @client.get_custom_field_definition(
    custom_field_definition_id: custom_field_definition_id
  )
  puts "Got Custom Field Definition #{custom_field_definition}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • custom_field_definition_id (String)

    Custom Field Definition ID

  • params (Hash)

    Optional query string parameters:

Returns:


1686
1687
1688
1689
# File 'lib/recurly/client/operations.rb', line 1686

def get_custom_field_definition(custom_field_definition_id:, **options)
  path = interpolate_path("/custom_field_definitions/{custom_field_definition_id}", custom_field_definition_id: custom_field_definition_id)
  get(path, **options)
end

#get_export_dates(**options) ⇒ Resources::ExportDates

List the dates that have an available export to download.

get_export_dates api documenation

Examples:

begin
  export_dates = @client.get_export_dates()
  export_dates.dates.each do |date|
    puts "Exports are available for: #{date}"
  end
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • params (Hash)

    Optional query string parameters:

Returns:


3839
3840
3841
3842
# File 'lib/recurly/client/operations.rb', line 3839

def get_export_dates(**options)
  path = "/export_dates"
  get(path, **options)
end

#get_export_files(export_date:, **options) ⇒ Resources::ExportFiles

List of the export files that are available to download.

get_export_files api documenation

Examples:

begin
  export_files = @client.get_export_files(export_date: export_date)
  export_files.files.each do |file|
    puts "Export file download URL: #{file.href}"
  end
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • export_date (String)

    Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.

  • params (Hash)

    Optional query string parameters:

Returns:


3864
3865
3866
3867
# File 'lib/recurly/client/operations.rb', line 3864

def get_export_files(export_date:, **options)
  path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date)
  get(path, **options)
end

#get_invoice(invoice_id:, **options) ⇒ Resources::Invoice

Fetch an invoice

get_invoice api documenation

Examples:

begin
  invoice = @client.get_invoice(invoice_id: invoice_id)
  puts "Got invoice #{invoice}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters:

Returns:


2036
2037
2038
2039
# File 'lib/recurly/client/operations.rb', line 2036

def get_invoice(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}", invoice_id: invoice_id)
  get(path, **options)
end

#get_invoice_pdf(invoice_id:, **options) ⇒ Resources::BinaryFile

Fetch an invoice as a PDF

get_invoice_pdf api documenation

Examples:

begin
  invoice = @client.get_invoice_pdf(invoice_id: invoice_id)
  puts "Got invoice #{invoice}"
  filename = "#{download_directory}/rubyinvoice-#{invoice_id}.pdf"
  IO.write(filename, invoice.data)
  puts "Saved Invoice PDF to #{filename}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters:

Returns:


2090
2091
2092
2093
# File 'lib/recurly/client/operations.rb', line 2090

def get_invoice_pdf(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}.pdf", invoice_id: invoice_id)
  get(path, **options)
end

#get_item(item_id:, **options) ⇒ Resources::Item

Examples:

begin
  item = @client.get_item(item_id: item_id)
  puts "Got Item #{item}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • item_id (String)

    Item ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-red.

  • params (Hash)

    Optional query string parameters:

Returns:


1790
1791
1792
1793
# File 'lib/recurly/client/operations.rb', line 1790

def get_item(item_id:, **options)
  path = interpolate_path("/items/{item_id}", item_id: item_id)
  get(path, **options)
end

#get_line_item(line_item_id:, **options) ⇒ Resources::LineItem

Fetch a line item

get_line_item api documenation

Examples:

begin
  line_item = @client.get_line_item(line_item_id: line_item_id)
  puts "Got LineItem #{line_item}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • line_item_id (String)

    Line Item ID.

  • params (Hash)

    Optional query string parameters:

Returns:


2449
2450
2451
2452
# File 'lib/recurly/client/operations.rb', line 2449

def get_line_item(line_item_id:, **options)
  path = interpolate_path("/line_items/{line_item_id}", line_item_id: line_item_id)
  get(path, **options)
end

#get_measured_unit(measured_unit_id:, **options) ⇒ Resources::MeasuredUnit

Fetch a measured unit

get_measured_unit api documenation

Parameters:

  • measured_unit_id (String)

    Measured unit ID or name. For ID no prefix is used e.g. e28zov4fw0v2. For name use prefix name-, e.g. name-Storage.

  • params (Hash)

    Optional query string parameters:

Returns:


1933
1934
1935
1936
# File 'lib/recurly/client/operations.rb', line 1933

def get_measured_unit(measured_unit_id:, **options)
  path = interpolate_path("/measured_units/{measured_unit_id}", measured_unit_id: measured_unit_id)
  get(path, **options)
end

#get_plan(plan_id:, **options) ⇒ Resources::Plan

Examples:

begin
  plan = @client.get_plan(plan_id: plan_id)
  puts "Got plan #{plan}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • plan_id (String)

    Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • params (Hash)

    Optional query string parameters:

Returns:


2583
2584
2585
2586
# File 'lib/recurly/client/operations.rb', line 2583

def get_plan(plan_id:, **options)
  path = interpolate_path("/plans/{plan_id}", plan_id: plan_id)
  get(path, **options)
end

#get_plan_add_on(plan_id:, add_on_id:, **options) ⇒ Resources::AddOn

Fetch a plan's add-on

get_plan_add_on api documenation

Examples:

begin
  add_on = @client.get_plan_add_on(
    plan_id: plan_id, add_on_id: add_on_id
  )
  puts "Got plan add-on #{add_on}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • plan_id (String)

    Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • add_on_id (String)

    Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • params (Hash)

    Optional query string parameters:

Returns:


2744
2745
2746
2747
# File 'lib/recurly/client/operations.rb', line 2744

def get_plan_add_on(plan_id:, add_on_id:, **options)
  path = interpolate_path("/plans/{plan_id}/add_ons/{add_on_id}", plan_id: plan_id, add_on_id: add_on_id)
  get(path, **options)
end

#get_shipping_address(account_id:, shipping_address_id:, **options) ⇒ Resources::ShippingAddress

Fetch an account's shipping address

get_shipping_address api documenation

Examples:

begin
  address = @client.get_shipping_address(
    account_id: ,
    shipping_address_id: shipping_address_id
  )
  puts "Got ShippingAddress #{address}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • shipping_address_id (String)

    Shipping Address ID.

  • params (Hash)

    Optional query string parameters:

Returns:


1080
1081
1082
1083
# File 'lib/recurly/client/operations.rb', line 1080

def get_shipping_address(account_id:, shipping_address_id:, **options)
  path = interpolate_path("/accounts/{account_id}/shipping_addresses/{shipping_address_id}", account_id: , shipping_address_id: shipping_address_id)
  get(path, **options)
end

#get_shipping_method(shipping_method_id:, **options) ⇒ Resources::ShippingMethod

Fetch a shipping method

get_shipping_method api documenation

Parameters:

  • shipping_method_id (String)

    Shipping Method ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-usps_2-day.

  • params (Hash)

    Optional query string parameters:

Returns:


2949
2950
2951
2952
# File 'lib/recurly/client/operations.rb', line 2949

def get_shipping_method(shipping_method_id:, **options)
  path = interpolate_path("/shipping_methods/{shipping_method_id}", shipping_method_id: shipping_method_id)
  get(path, **options)
end

#get_site(site_id:, **options) ⇒ Resources::Site

Examples:

begin
  site = @client.get_site(site_id: site_id)
  puts "Got Site #{site}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • site_id (String)

    Site ID or subdomain. For ID no prefix is used e.g. e28zov4fw0v2. For subdomain use prefix subdomain-, e.g. subdomain-recurly.

  • params (Hash)

    Optional query string parameters:

Returns:


69
70
71
72
# File 'lib/recurly/client/operations.rb', line 69

def get_site(site_id:, **options)
  path = interpolate_path("/sites/{site_id}", site_id: site_id)
  get(path, **options)
end

#get_subscription(subscription_id:, **options) ⇒ Resources::Subscription

Fetch a subscription

get_subscription api documenation

Examples:

begin
  subscription = @client.get_subscription(
    subscription_id: subscription_id
  )
  puts "Got Subscription #{subscription}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters:

Returns:


3087
3088
3089
3090
# File 'lib/recurly/client/operations.rb', line 3087

def get_subscription(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}", subscription_id: subscription_id)
  get(path, **options)
end

#get_subscription_change(subscription_id:, **options) ⇒ Resources::SubscriptionChange

Fetch a subscription's pending change

get_subscription_change api documenation

Examples:

begin
  change = @client.get_subscription_change(
    subscription_id: subscription_id
  )
  puts "Got SubscriptionChange #{change}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters:

Returns:


3299
3300
3301
3302
# File 'lib/recurly/client/operations.rb', line 3299

def get_subscription_change(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/change", subscription_id: subscription_id)
  get(path, **options)
end

#get_transaction(transaction_id:, **options) ⇒ Resources::Transaction

Fetch a transaction

get_transaction api documenation

Examples:

begin
  transaction = @client.get_transaction(transaction_id: transaction_id)
  puts "Got Transaction #{transaction}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • transaction_id (String)

    Transaction ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters:

Returns:


3693
3694
3695
3696
# File 'lib/recurly/client/operations.rb', line 3693

def get_transaction(transaction_id:, **options)
  path = interpolate_path("/transactions/{transaction_id}", transaction_id: transaction_id)
  get(path, **options)
end

#get_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode

Fetch a unique coupon code

get_unique_coupon_code api documenation

Parameters:

  • unique_coupon_code_id (String)

    Unique Coupon Code ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-abc-8dh2-def.

  • params (Hash)

    Optional query string parameters:

Returns:


3707
3708
3709
3710
# File 'lib/recurly/client/operations.rb', line 3707

def get_unique_coupon_code(unique_coupon_code_id:, **options)
  path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}", unique_coupon_code_id: unique_coupon_code_id)
  get(path, **options)
end

#get_usage(usage_id:, **options) ⇒ Resources::Usage

Get a usage record

get_usage api documenation

Parameters:

  • usage_id (String)

    Usage Record ID.

  • params (Hash)

    Optional query string parameters:

Returns:


3594
3595
3596
3597
# File 'lib/recurly/client/operations.rb', line 3594

def get_usage(usage_id:, **options)
  path = interpolate_path("/usage/{usage_id}", usage_id: usage_id)
  get(path, **options)
end

#list_account_acquisition(**options) ⇒ Pager<Resources::AccountAcquisition>

List a site's account acquisition data

list_account_acquisition api documenation

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.

Examples:

params = {
  limit: 200
}
acquisitions = @client.(params: params)
acquisitions.each do |acquisition|
  puts "AccountAcquisition: #{acquisition.cost}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1346
1347
1348
1349
# File 'lib/recurly/client/operations.rb', line 1346

def (**options)
  path = "/acquisitions"
  pager(path, **options)
end

#list_account_coupon_redemptions(account_id:, **options) ⇒ Pager<Resources::CouponRedemption>

Show the coupon redemptions for an account

list_account_coupon_redemptions api documenation

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.

Examples:

params = {
  limit: 200
}
redemptions = @client.(
  account_id: ,
  params: params
)
redemptions.each do |redemption|
  puts "CouponRedemption: #{redemption.id}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


595
596
597
598
# File 'lib/recurly/client/operations.rb', line 595

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/coupon_redemptions", account_id: )
  pager(path, **options)
end

#list_account_credit_payments(account_id:, **options) ⇒ Pager<Resources::CreditPayment>

List an account's credit payments

list_account_credit_payments api documenation

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.

Examples:

params = {
  limit: 200
}
payments = @client.(
  account_id: ,
  params: params
)
payments.each do |payment|
  puts "CreditPayment: #{payment.id}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :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

Returns:


708
709
710
711
# File 'lib/recurly/client/operations.rb', line 708

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/credit_payments", account_id: )
  pager(path, **options)
end

#list_account_invoices(account_id:, **options) ⇒ Pager<Resources::Invoice>

List an account's invoices

list_account_invoices api documenation

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.

Examples:

params = {
  limit: 200
}
invoices = @client.(
  account_id: ,
  params: params
)
invoices.each do |invoice|
  puts "Invoice: #{invoice.number}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


763
764
765
766
# File 'lib/recurly/client/operations.rb', line 763

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/invoices", account_id: )
  pager(path, **options)
end

#list_account_line_items(account_id:, **options) ⇒ Pager<Resources::LineItem>

List an account's line items

list_account_line_items api documenation

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.

Examples:

params = {
  limit: 200
}
line_items = @client.(
  account_id: ,
  params: params
)
line_items.each do |line_item|
  puts "LineItem: #{line_item.id}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


877
878
879
880
# File 'lib/recurly/client/operations.rb', line 877

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/line_items", account_id: )
  pager(path, **options)
end

#list_account_notes(account_id:, **options) ⇒ Pager<Resources::AccountNote>

Fetch a list of an account's notes

list_account_notes api documenation

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.

Examples:

params = {
  limit: 200
}
 = @client.(account_id: , params: params)
.each do |note|
  puts "AccountNote: #{note.message}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


943
944
945
946
# File 'lib/recurly/client/operations.rb', line 943

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/notes", account_id: )
  pager(path, **options)
end

#list_account_subscriptions(account_id:, **options) ⇒ Pager<Resources::Subscription>

List an account's subscriptions

list_account_subscriptions api documenation

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.

Examples:

params = {
  limit: 200
}
subscriptions = @client.(
  account_id: ,
  params: params
)
subscriptions.each do |subscription|
  puts "Subscription: #{subscription.uuid}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1196
1197
1198
1199
# File 'lib/recurly/client/operations.rb', line 1196

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/subscriptions", account_id: )
  pager(path, **options)
end

#list_account_transactions(account_id:, **options) ⇒ Pager<Resources::Transaction>

List an account's transactions

list_account_transactions api documenation

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.

Examples:

params = {
  limit: 200
}
transactions = @client.(
  account_id: ,
  params: params
)
transactions.each do |transaction|
  puts "Transaction: #{transaction.uuid}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1247
1248
1249
1250
# File 'lib/recurly/client/operations.rb', line 1247

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/transactions", account_id: )
  pager(path, **options)
end

#list_accounts(**options) ⇒ Pager<Resources::Account>

List a site's accounts

list_accounts api documenation

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.

Examples:

params = {
  limit: 200
}
accounts = @client.list_accounts(params: params)
accounts.each do ||
  puts "Account: #{.code}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


119
120
121
122
# File 'lib/recurly/client/operations.rb', line 119

def list_accounts(**options)
  path = "/accounts"
  pager(path, **options)
end

#list_active_coupon_redemptions(account_id:, **options) ⇒ Pager<Resources::CouponRedemption>

Show the coupon redemptions that are active on an account

list_active_coupon_redemptions api documenation

Examples:

params = {
  limit: 200
}
redemptions = @client.list_active_coupon_redemptions(account_id: , params: params)
redemptions.each do |redemption|
  puts "Redemption: #{redemption.id}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


617
618
619
620
# File 'lib/recurly/client/operations.rb', line 617

def list_active_coupon_redemptions(account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/coupon_redemptions/active", account_id: )
  pager(path, **options)
end

#list_add_ons(**options) ⇒ Pager<Resources::AddOn>

List a site's add-ons

list_add_ons api documenation

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.

Examples:

params = {
  limit: 200
}
add_ons = @client.list_add_ons(
  params: params
)
add_ons.each do |add_on|
  puts "AddOn: #{add_on.code}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


2851
2852
2853
2854
# File 'lib/recurly/client/operations.rb', line 2851

def list_add_ons(**options)
  path = "/add_ons"
  pager(path, **options)
end

#list_billing_infos(account_id:, **options) ⇒ Pager<Resources::BillingInfo>

Get the list of billing information associated with an account

list_billing_infos api documenation

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.

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


486
487
488
489
# File 'lib/recurly/client/operations.rb', line 486

def list_billing_infos(account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_infos", account_id: )
  pager(path, **options)
end

#list_child_accounts(account_id:, **options) ⇒ Pager<Resources::Account>

List an account's child accounts

list_child_accounts api documenation

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.

Examples:

params = {
  limit: 200
}
child_accounts = @client.list_child_accounts(
  account_id: ,
  params: params
)
child_accounts.each do |child|
  puts "Account: #{child.code}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1301
1302
1303
1304
# File 'lib/recurly/client/operations.rb', line 1301

def list_child_accounts(account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/accounts", account_id: )
  pager(path, **options)
end

#list_coupons(**options) ⇒ Pager<Resources::Coupon>

List a site's coupons

list_coupons api documenation

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.

Examples:

params = {
  limit: 200
}
coupons = @client.list_coupons(params: params)
coupons.each do |coupon|
  puts "coupon: #{coupon.code}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1391
1392
1393
1394
# File 'lib/recurly/client/operations.rb', line 1391

def list_coupons(**options)
  path = "/coupons"
  pager(path, **options)
end

#list_credit_payments(**options) ⇒ Pager<Resources::CreditPayment>

List a site's credit payments

list_credit_payments api documenation

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.

Examples:

params = {
  limit: 200
}
payments = @client.list_credit_payments(params: params)
payments.each do |payment|
  puts "CreditPayment: #{payment.id}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :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

Returns:


1601
1602
1603
1604
# File 'lib/recurly/client/operations.rb', line 1601

def list_credit_payments(**options)
  path = "/credit_payments"
  pager(path, **options)
end

#list_custom_field_definitions(**options) ⇒ Pager<Resources::CustomFieldDefinition>

List a site's custom field definitions

list_custom_field_definitions api documenation

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.

Examples:

params = {
  limit: 200
}
custom_fields = @client.list_custom_field_definitions(params: params)
custom_fields.each do |field|
  puts "CustomFieldDefinition: #{field.name}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1661
1662
1663
1664
# File 'lib/recurly/client/operations.rb', line 1661

def list_custom_field_definitions(**options)
  path = "/custom_field_definitions"
  pager(path, **options)
end

#list_invoice_coupon_redemptions(invoice_id:, **options) ⇒ Pager<Resources::CouponRedemption>

Show the coupon redemptions applied to an invoice

list_invoice_coupon_redemptions api documenation

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.

Examples:

params = {
  limit: 200
}
coupon_redemptions = @client.list_invoice_coupon_redemptions(
  invoice_id: invoice_id,
  params: params
)
coupon_redemptions.each do |redemption|
  puts "CouponRedemption: #{redemption.id}"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


2320
2321
2322
2323
# File 'lib/recurly/client/operations.rb', line 2320

def list_invoice_coupon_redemptions(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}/coupon_redemptions", invoice_id: invoice_id)
  pager(path, **options)
end

#list_invoice_line_items(invoice_id:, **options) ⇒ Pager<Resources::LineItem>

List an invoice's line items

list_invoice_line_items api documenation

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.

Examples:

params = {
  limit: 200
}
line_items = @client.list_invoice_line_items(
  invoice_id: invoice_id,
  params: params
)
line_items.each do |line_item|
  puts "Line Item: #{line_item.id}"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


2273
2274
2275
2276
# File 'lib/recurly/client/operations.rb', line 2273

def list_invoice_line_items(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}/line_items", invoice_id: invoice_id)
  pager(path, **options)
end

#list_invoices(**options) ⇒ Pager<Resources::Invoice>

List a site's invoices

list_invoices api documenation

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.

Examples:

params = {
  limit: 200
}
invoices = @client.list_invoices(params: params)
invoices.each do |invoice|
  puts "Invoice: #{invoice.number}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


2013
2014
2015
2016
# File 'lib/recurly/client/operations.rb', line 2013

def list_invoices(**options)
  path = "/invoices"
  pager(path, **options)
end

#list_items(**options) ⇒ Pager<Resources::Item>

List a site's items

list_items api documenation

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.

Examples:

params = {
  limit: 200
}
items = @client.list_items(params: params)
items.each do |item|
  puts "Item: #{item.code}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1732
1733
1734
1735
# File 'lib/recurly/client/operations.rb', line 1732

def list_items(**options)
  path = "/items"
  pager(path, **options)
end

#list_line_items(**options) ⇒ Pager<Resources::LineItem>

List a site's line items

list_line_items api documenation

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.

Examples:

params = {
  limit: 200
}
line_items = @client.list_line_items(
  params: params
)
line_items.each do |line_item|
  puts "LineItem: #{line_item.id}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


2426
2427
2428
2429
# File 'lib/recurly/client/operations.rb', line 2426

def list_line_items(**options)
  path = "/line_items"
  pager(path, **options)
end

#list_measured_unit(**options) ⇒ Pager<Resources::MeasuredUnit>

List a site's measured units

list_measured_unit api documenation

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.

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1905
1906
1907
1908
# File 'lib/recurly/client/operations.rb', line 1905

def list_measured_unit(**options)
  path = "/measured_units"
  pager(path, **options)
end

#list_plan_add_ons(plan_id:, **options) ⇒ Pager<Resources::AddOn>

List a plan's add-ons

list_plan_add_ons api documenation

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.

Examples:

params = {
  limit: 200
}
add_ons = @client.list_plan_add_ons(
  plan_id: plan_id,
  params: params
)
add_ons.each do |add_on|
  puts "AddOn: #{add_on.code}"
end

Parameters:

  • plan_id (String)

    Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


2683
2684
2685
2686
# File 'lib/recurly/client/operations.rb', line 2683

def list_plan_add_ons(plan_id:, **options)
  path = interpolate_path("/plans/{plan_id}/add_ons", plan_id: plan_id)
  pager(path, **options)
end

#list_plans(**options) ⇒ Pager<Resources::Plan>

List a site's plans

list_plans api documenation

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.

Examples:

params = {
  limit: 200
}
plans = @client.list_plans(params: params)
plans.each do |plan|
  puts "Plan: #{plan.code}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


2520
2521
2522
2523
# File 'lib/recurly/client/operations.rb', line 2520

def list_plans(**options)
  path = "/plans"
  pager(path, **options)
end

List an invoice's related credit or charge invoices

list_related_invoices api documenation

Examples:

params = {
  limit: 200
}
invoices = @client.list_related_invoices(
  invoice_id: invoice_id,
  params: params
)
invoices.each do |invoice|
  puts "Invoice: #{invoice.number}"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters:

Returns:


2345
2346
2347
2348
# File 'lib/recurly/client/operations.rb', line 2345

def list_related_invoices(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}/related_invoices", invoice_id: invoice_id)
  pager(path, **options)
end

#list_shipping_addresses(account_id:, **options) ⇒ Pager<Resources::ShippingAddress>

Fetch a list of an account's shipping addresses

list_shipping_addresses api documenation

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.

Examples:

params = {
  limit: 200
}
shipping_addresses = @client.list_shipping_addresses(
  account_id: ,
  params: params
)
shipping_addresses.each do |addr|
  puts "ShippingAddress: #{addr.nickname} - #{addr.street1}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1019
1020
1021
1022
# File 'lib/recurly/client/operations.rb', line 1019

def list_shipping_addresses(account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/shipping_addresses", account_id: )
  pager(path, **options)
end

#list_shipping_methods(**options) ⇒ Pager<Resources::ShippingMethod>

List a site's shipping methods

list_shipping_methods api documenation

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.

Examples:

params = {
  limit: 200
}
shipping_methods = @client.list_shipping_methods(
  params: params
)
shipping_methods.each do |shipping_method|
  puts "Shipping Method: #{shipping_method.code}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


2921
2922
2923
2924
# File 'lib/recurly/client/operations.rb', line 2921

def list_shipping_methods(**options)
  path = "/shipping_methods"
  pager(path, **options)
end

#list_sites(**options) ⇒ Pager<Resources::Site>

List sites

list_sites api documenation

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.

Examples:

params = {
  limit: 200
}
sites = @client.list_sites(params: params)
sites.each do |site|
  puts "Site: #{site.subdomain}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


46
47
48
49
# File 'lib/recurly/client/operations.rb', line 46

def list_sites(**options)
  path = "/sites"
  pager(path, **options)
end

#list_subscription_coupon_redemptions(subscription_id:, **options) ⇒ Pager<Resources::CouponRedemption>

Show the coupon redemptions for a subscription

list_subscription_coupon_redemptions api documenation

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.

Examples:

params = {
  limit: 200
}
coupon_redemptions = @client.list_subscription_coupon_redemptions(
  subscription_id: subscription_id,
  params: params
)
coupon_redemptions.each do |redemption|
  puts "CouponRedemption: #{redemption.id}"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


3524
3525
3526
3527
# File 'lib/recurly/client/operations.rb', line 3524

def list_subscription_coupon_redemptions(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/coupon_redemptions", subscription_id: subscription_id)
  pager(path, **options)
end

#list_subscription_invoices(subscription_id:, **options) ⇒ Pager<Resources::Invoice>

List a subscription's invoices

list_subscription_invoices api documenation

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.

Examples:

params = {
  limit: 200
}
invoices = @client.list_subscription_invoices(
  subscription_id: subscription_id,
  params: params
)
invoices.each do |invoice|
  puts "Invoice: #{invoice.number}"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


3425
3426
3427
3428
# File 'lib/recurly/client/operations.rb', line 3425

def list_subscription_invoices(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/invoices", subscription_id: subscription_id)
  pager(path, **options)
end

#list_subscription_line_items(subscription_id:, **options) ⇒ Pager<Resources::LineItem>

List a subscription's line items

list_subscription_line_items api documenation

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.

Examples:

params = {
  limit: 200
}
line_items = @client.list_subscription_line_items(
  subscription_id: subscription_id,
  params: params
)
line_items.each do |line_item|
  puts "LineItem: #{line_item.id}"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


3477
3478
3479
3480
# File 'lib/recurly/client/operations.rb', line 3477

def list_subscription_line_items(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/line_items", subscription_id: subscription_id)
  pager(path, **options)
end

#list_subscriptions(**options) ⇒ Pager<Resources::Subscription>

List a site's subscriptions

list_subscriptions api documenation

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.

Examples:

params = {
  limit: 200
}
subscriptions = @client.list_subscriptions(params: params)
subscriptions.each do |subscription|
  puts "Subscription: #{subscription.uuid}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


3029
3030
3031
3032
# File 'lib/recurly/client/operations.rb', line 3029

def list_subscriptions(**options)
  path = "/subscriptions"
  pager(path, **options)
end

#list_transactions(**options) ⇒ Pager<Resources::Transaction>

List a site's transactions

list_transactions api documenation

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.

Examples:

params = {
  limit: 200
}
transactions = @client.list_transactions(params: params)
transactions.each do |transaction|
  puts "Transaction: #{transaction.uuid}"
end

Parameters:

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


3670
3671
3672
3673
# File 'lib/recurly/client/operations.rb', line 3670

def list_transactions(**options)
  path = "/transactions"
  pager(path, **options)
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 documenation

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.

Parameters:

  • coupon_id (String)

    Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


1568
1569
1570
1571
# File 'lib/recurly/client/operations.rb', line 1568

def list_unique_coupon_codes(coupon_id:, **options)
  path = interpolate_path("/coupons/{coupon_id}/unique_coupon_codes", coupon_id: coupon_id)
  pager(path, **options)
end

#list_usage(subscription_id:, add_on_id:, **options) ⇒ Pager<Resources::Usage>

List a subscription add-on's usage records

list_usage api documenation

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

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • add_on_id (String)

    Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • params (Hash)

    Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using

Returns:


3564
3565
3566
3567
# File 'lib/recurly/client/operations.rb', line 3564

def list_usage(subscription_id:, add_on_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/add_ons/{add_on_id}/usage", subscription_id: subscription_id, add_on_id: add_on_id)
  pager(path, **options)
end

#mark_invoice_failed(invoice_id:, **options) ⇒ Resources::Invoice

Mark an open invoice as failed

mark_invoice_failed api documenation

Examples:

begin
  invoice = @client.mark_invoice_failed(invoice_id: invoice_id)
  puts "Failed invoice #{invoice}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters:

Returns:


2137
2138
2139
2140
# File 'lib/recurly/client/operations.rb', line 2137

def mark_invoice_failed(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}/mark_failed", invoice_id: invoice_id)
  put(path, **options)
end

#mark_invoice_successful(invoice_id:, **options) ⇒ Resources::Invoice

Mark an open invoice as successful

mark_invoice_successful api documenation

Examples:

begin
  invoice = @client.mark_invoice_successful(invoice_id: invoice_id)
  puts "Marked invoice sucessful #{invoice}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters:

Returns:


2160
2161
2162
2163
# File 'lib/recurly/client/operations.rb', line 2160

def mark_invoice_successful(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}/mark_successful", invoice_id: invoice_id)
  put(path, **options)
end

#pause_subscription(subscription_id:, body:, **options) ⇒ Resources::Subscription

Examples:

begin
  subscription_pause = {
    remaining_pause_cycles: 10
  }
  subscription = @client.pause_subscription(
    subscription_id: subscription_id,
    body: subscription_pause
  )
  puts "Paused Subscription #{subscription}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • body (Requests::SubscriptionPause)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::SubscriptionPause

  • params (Hash)

    Optional query string parameters:

Returns:


3235
3236
3237
3238
# File 'lib/recurly/client/operations.rb', line 3235

def pause_subscription(subscription_id:, body:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/pause", subscription_id: subscription_id)
  put(path, body, Requests::SubscriptionPause, **options)
end

#preview_invoice(account_id:, body:, **options) ⇒ Resources::InvoiceCollection

Preview new invoice for pending line items

preview_invoice api documenation

Examples:

begin
  invoice_preview = {
    currency: "USD",
    collection_method: "automatic"
  }
  collection = @client.create_invoice(
    account_id: ,
    body: invoice_preview
  )
  puts "Created InvoiceCollection #{collection}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::InvoiceCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::InvoiceCreate

  • params (Hash)

    Optional query string parameters:

Returns:


825
826
827
828
# File 'lib/recurly/client/operations.rb', line 825

def preview_invoice(account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/invoices/preview", account_id: )
  post(path, body, Requests::InvoiceCreate, **options)
end

#preview_purchase(body:, **options) ⇒ Resources::InvoiceCollection

Preview a new purchase

preview_purchase api documenation

Examples:

begin
  purchase = {
    currency: "USD",
    account: {
      code: ,
      first_name: "Benjamin",
      last_name: "Du Monde",
      billing_info: {
        token_id: rjs_token_id
      },
    },
    subscriptions: [
      { plan_code: plan_code }
    ]
  }
  invoice_collection = @client.preview_purchase(
    body: purchase
  )
  puts "Preview Charge Invoice #{invoice_collection.charge_invoice}"
  puts "Preview Credit Invoices #{invoice_collection.credit_invoices}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

Returns:


3815
3816
3817
3818
# File 'lib/recurly/client/operations.rb', line 3815

def preview_purchase(body:, **options)
  path = "/purchases/preview"
  post(path, body, Requests::PurchaseCreate, **options)
end

#preview_subscription_change(subscription_id:, body:, **options) ⇒ Resources::SubscriptionChange

Preview a new subscription change

preview_subscription_change api documenation

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • body (Requests::SubscriptionChangeCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::SubscriptionChangeCreate

  • params (Hash)

    Optional query string parameters:

Returns:


3370
3371
3372
3373
# File 'lib/recurly/client/operations.rb', line 3370

def preview_subscription_change(subscription_id:, body:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/change/preview", subscription_id: subscription_id)
  post(path, body, Requests::SubscriptionChangeCreate, **options)
end

#reactivate_account(account_id:, **options) ⇒ Resources::Account

Reactivate an inactive account

reactivate_account api documenation

Examples:

begin
   = @client.(account_id: )
  puts "Reactivated account #{}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


350
351
352
353
# File 'lib/recurly/client/operations.rb', line 350

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/reactivate", account_id: )
  put(path, **options)
end

#reactivate_item(item_id:, **options) ⇒ Resources::Item

Reactivate an inactive item

reactivate_item api documenation

Examples:

begin
  item = @client.reactivate_item(item_id: item_id)
  puts "Reactivated Item #{item}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • item_id (String)

    Item ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-red.

  • params (Hash)

    Optional query string parameters:

Returns:


1867
1868
1869
1870
# File 'lib/recurly/client/operations.rb', line 1867

def reactivate_item(item_id:, **options)
  path = interpolate_path("/items/{item_id}/reactivate", item_id: item_id)
  put(path, **options)
end

#reactivate_subscription(subscription_id:, **options) ⇒ Resources::Subscription

Reactivate a canceled subscription

reactivate_subscription api documenation

Examples:

begin
  subscription = @client.reactivate_subscription(
    subscription_id: subscription_id
  )
  puts "Reactivated Canceled Subscription #{subscription}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters:

Returns:


3205
3206
3207
3208
# File 'lib/recurly/client/operations.rb', line 3205

def reactivate_subscription(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/reactivate", subscription_id: subscription_id)
  put(path, **options)
end

#reactivate_unique_coupon_code(unique_coupon_code_id:, **options) ⇒ Resources::UniqueCouponCode

Restore a unique coupon code

reactivate_unique_coupon_code api documenation

Parameters:

  • unique_coupon_code_id (String)

    Unique Coupon Code ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-abc-8dh2-def.

  • params (Hash)

    Optional query string parameters:

Returns:


3735
3736
3737
3738
# File 'lib/recurly/client/operations.rb', line 3735

def reactivate_unique_coupon_code(unique_coupon_code_id:, **options)
  path = interpolate_path("/unique_coupon_codes/{unique_coupon_code_id}/restore", unique_coupon_code_id: unique_coupon_code_id)
  put(path, **options)
end

#record_external_transaction(invoice_id:, body:, **options) ⇒ Resources::Transaction

Record an external payment for a manual invoices.

record_external_transaction api documenation

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • body (Requests::ExternalTransaction)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::ExternalTransaction

  • params (Hash)

    Optional query string parameters:

Returns:


2221
2222
2223
2224
# File 'lib/recurly/client/operations.rb', line 2221

def record_external_transaction(invoice_id:, body:, **options)
  path = interpolate_path("/invoices/{invoice_id}/transactions", invoice_id: invoice_id)
  post(path, body, Requests::ExternalTransaction, **options)
end

#refund_invoice(invoice_id:, body:, **options) ⇒ Resources::Invoice

Examples:

begin
  invoice_refund = {
    type: "amount",
    amount: 100,
  }
  invoice = @client.refund_invoice(
    invoice_id: invoice_id,
    body: invoice_refund
  )
  puts "Refunded invoice #{invoice}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • body (Requests::InvoiceRefund)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::InvoiceRefund

  • params (Hash)

    Optional query string parameters:

Returns:


2376
2377
2378
2379
# File 'lib/recurly/client/operations.rb', line 2376

def refund_invoice(invoice_id:, body:, **options)
  path = interpolate_path("/invoices/{invoice_id}/refund", invoice_id: invoice_id)
  post(path, body, Requests::InvoiceRefund, **options)
end

#remove_a_billing_info(account_id:, billing_info_id:, **options) ⇒ Resources::Empty

Remove an account's billing information

remove_a_billing_info api documenation

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • billing_info_id (String)

    Billing Info ID.

  • params (Hash)

    Optional query string parameters:

Returns:


547
548
549
550
# File 'lib/recurly/client/operations.rb', line 547

def remove_a_billing_info(account_id:, billing_info_id:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: , billing_info_id: billing_info_id)
  delete(path, **options)
end

#remove_account_acquisition(account_id:, **options) ⇒ Resources::Empty

Remove an account's acquisition data

remove_account_acquisition api documenation

Examples:

begin
  acquisition = @client.(account_id: )
  puts "Removed AccountAcqusition #{acquisition}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


327
328
329
330
# File 'lib/recurly/client/operations.rb', line 327

def (account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/acquisition", account_id: )
  delete(path, **options)
end

#remove_billing_info(account_id:, **options) ⇒ Resources::Empty

Remove an account's billing information

remove_billing_info api documenation

Examples:

begin
  @client.remove_billing_info(account_id: )
  puts "Removed BillingInfo #{}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


450
451
452
453
# File 'lib/recurly/client/operations.rb', line 450

def remove_billing_info(account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_info", account_id: )
  delete(path, **options)
end

#remove_coupon_redemption(account_id:, **options) ⇒ Resources::CouponRedemption

Delete the active coupon redemption from an account

remove_coupon_redemption api documenation

Examples:

begin
  @client.remove_coupon_redemption(account_id: )
  puts "Removed CouponRedemption #{}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • params (Hash)

    Optional query string parameters:

Returns:


671
672
673
674
# File 'lib/recurly/client/operations.rb', line 671

def remove_coupon_redemption(account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/coupon_redemptions/active", account_id: )
  delete(path, **options)
end

#remove_line_item(line_item_id:, **options) ⇒ Resources::Empty

Delete an uninvoiced line item

remove_line_item api documenation

Examples:

begin
  @client.remove_line_item(
    line_item_id: line_item_id
  )
  puts "Removed LineItem #{line_item_id}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • line_item_id (String)

    Line Item ID.

  • params (Hash)

    Optional query string parameters:

Returns:


2474
2475
2476
2477
# File 'lib/recurly/client/operations.rb', line 2474

def remove_line_item(line_item_id:, **options)
  path = interpolate_path("/line_items/{line_item_id}", line_item_id: line_item_id)
  delete(path, **options)
end

#remove_measured_unit(measured_unit_id:, **options) ⇒ Resources::MeasuredUnit

Remove a measured unit

remove_measured_unit api documenation

Parameters:

  • measured_unit_id (String)

    Measured unit ID or name. For ID no prefix is used e.g. e28zov4fw0v2. For name use prefix name-, e.g. name-Storage.

  • params (Hash)

    Optional query string parameters:

Returns:


1962
1963
1964
1965
# File 'lib/recurly/client/operations.rb', line 1962

def remove_measured_unit(measured_unit_id:, **options)
  path = interpolate_path("/measured_units/{measured_unit_id}", measured_unit_id: measured_unit_id)
  delete(path, **options)
end

#remove_plan(plan_id:, **options) ⇒ Resources::Plan

Examples:

begin
  plan = @client.remove_plan(plan_id: plan_id)
  puts "Removed plan #{plan}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • plan_id (String)

    Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • params (Hash)

    Optional query string parameters:

Returns:


2633
2634
2635
2636
# File 'lib/recurly/client/operations.rb', line 2633

def remove_plan(plan_id:, **options)
  path = interpolate_path("/plans/{plan_id}", plan_id: plan_id)
  delete(path, **options)
end

#remove_plan_add_on(plan_id:, add_on_id:, **options) ⇒ Resources::AddOn

Examples:

begin
  add_on = @client.remove_plan_add_on(
    plan_id: plan_id,
    add_on_id: add_on_id
  )
  puts "Removed add-on #{add_on}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • plan_id (String)

    Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • add_on_id (String)

    Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • params (Hash)

    Optional query string parameters:

Returns:


2803
2804
2805
2806
# File 'lib/recurly/client/operations.rb', line 2803

def remove_plan_add_on(plan_id:, add_on_id:, **options)
  path = interpolate_path("/plans/{plan_id}/add_ons/{add_on_id}", plan_id: plan_id, add_on_id: add_on_id)
  delete(path, **options)
end

#remove_shipping_address(account_id:, shipping_address_id:, **options) ⇒ Resources::Empty

Remove an account's shipping address

remove_shipping_address api documenation

Examples:

begin
  @client.remove_shipping_address(
    account_id: ,
    shipping_address_id: shipping_address_id
  )
  puts "Removed ShippingAddress #{shipping_address_id}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • shipping_address_id (String)

    Shipping Address ID.

  • params (Hash)

    Optional query string parameters:

Returns:


1141
1142
1143
1144
# File 'lib/recurly/client/operations.rb', line 1141

def remove_shipping_address(account_id:, shipping_address_id:, **options)
  path = interpolate_path("/accounts/{account_id}/shipping_addresses/{shipping_address_id}", account_id: , shipping_address_id: shipping_address_id)
  delete(path, **options)
end

#remove_subscription_change(subscription_id:, **options) ⇒ Resources::Empty

Delete the pending subscription change

remove_subscription_change api documenation

Examples:

begin
  @client.remove_subscription_change(
    subscription_id: subscription_id
  )
  puts "Removed SubscriptionChange #{subscription_id}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters:

Returns:


3355
3356
3357
3358
# File 'lib/recurly/client/operations.rb', line 3355

def remove_subscription_change(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/change", subscription_id: subscription_id)
  delete(path, **options)
end

#remove_usage(usage_id:, **options) ⇒ Resources::Empty

Delete a usage record.

remove_usage api documenation

Parameters:

  • usage_id (String)

    Usage Record ID.

  • params (Hash)

    Optional query string parameters:

Returns:


3623
3624
3625
3626
# File 'lib/recurly/client/operations.rb', line 3623

def remove_usage(usage_id:, **options)
  path = interpolate_path("/usage/{usage_id}", usage_id: usage_id)
  delete(path, **options)
end

#reopen_invoice(invoice_id:, **options) ⇒ Resources::Invoice

Reopen a closed, manual invoice

reopen_invoice api documenation

Examples:

begin
  invoice = @client.reopen_invoice(invoice_id: invoice_id)
  puts "Reopened invoice #{invoice}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters:

Returns:


2183
2184
2185
2186
# File 'lib/recurly/client/operations.rb', line 2183

def reopen_invoice(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}/reopen", invoice_id: invoice_id)
  put(path, **options)
end

#restore_coupon(coupon_id:, body:, **options) ⇒ Resources::Coupon

Restore an inactive coupon

restore_coupon api documenation

Parameters:

  • coupon_id (String)

    Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.

  • body (Requests::CouponUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::CouponUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


1530
1531
1532
1533
# File 'lib/recurly/client/operations.rb', line 1530

def restore_coupon(coupon_id:, body:, **options)
  path = interpolate_path("/coupons/{coupon_id}/restore", coupon_id: coupon_id)
  put(path, body, Requests::CouponUpdate, **options)
end

#resume_subscription(subscription_id:, **options) ⇒ Resources::Subscription

Examples:

begin
  subscription = @client.resume_subscription(
    subscription_id: subscription_id
  )
  puts "Resumed Subscription #{subscription}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters:

Returns:


3260
3261
3262
3263
# File 'lib/recurly/client/operations.rb', line 3260

def resume_subscription(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/resume", subscription_id: subscription_id)
  put(path, **options)
end

#terminate_subscription(subscription_id:, **options) ⇒ Resources::Subscription

Terminate a subscription

terminate_subscription api documenation

* +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.

Examples:

begin
  subscription = @client.terminate_subscription(
    subscription_id: subscription_id,
  )
  puts "Terminated Subscription #{subscription}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • params (Hash)

    Optional query string parameters: :refund [String] The type of refund to perform:

Returns:


3154
3155
3156
3157
# File 'lib/recurly/client/operations.rb', line 3154

def terminate_subscription(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}", subscription_id: subscription_id)
  delete(path, **options)
end

#update_a_billing_info(account_id:, billing_info_id:, body:, **options) ⇒ Resources::BillingInfo

Update an account's billing information

update_a_billing_info api documenation

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • billing_info_id (String)

    Billing Info ID.

  • body (Requests::BillingInfoCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::BillingInfoCreate

  • params (Hash)

    Optional query string parameters:

Returns:


532
533
534
535
# File 'lib/recurly/client/operations.rb', line 532

def update_a_billing_info(account_id:, billing_info_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: , billing_info_id: billing_info_id)
  put(path, body, Requests::BillingInfoCreate, **options)
end

#update_account(account_id:, body:, **options) ⇒ Resources::Account

Examples:

begin
   = {
    first_name: "Aaron",
    last_name: "Du Monde",
  }
   = @client.(
    account_id: ,
    body: 
  )
  puts "Updated Account #{}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::AccountUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::AccountUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


222
223
224
225
# File 'lib/recurly/client/operations.rb', line 222

def (account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}", account_id: )
  put(path, body, Requests::AccountUpdate, **options)
end

#update_account_acquisition(account_id:, body:, **options) ⇒ Resources::AccountAcquisition

Update an account's acquisition data

update_account_acquisition api documenation

Examples:

begin
  acquisition_update = {
    campaign: "podcast-marketing",
    channel: "social_media",
    subchannel: "twitter",
    cost: {
      currency: "USD",
      amount: 0.50
    }
  }
  acquisition = @client.(
    account_id: ,
    body: acquisition_update
  )
  puts "Updated AccountAcqusition #{acquisition}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::AccountAcquisitionUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::AccountAcquisitionUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


304
305
306
307
# File 'lib/recurly/client/operations.rb', line 304

def (account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/acquisition", account_id: )
  put(path, body, Requests::AccountAcquisitionUpdate, **options)
end

#update_billing_info(account_id:, body:, **options) ⇒ Resources::BillingInfo

Set an account's billing information

update_billing_info api documenation

Examples:

begin
  billing_update = {
    first_name: "Aaron",
    last_name: "Du Monde",
  }
  billing = @client.update_billing_info(
    account_id: ,
    body: billing_update
  )
  puts "Updated BillingInfo #{billing}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • body (Requests::BillingInfoCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::BillingInfoCreate

  • params (Hash)

    Optional query string parameters:

Returns:


427
428
429
430
# File 'lib/recurly/client/operations.rb', line 427

def update_billing_info(account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_info", account_id: )
  put(path, body, Requests::BillingInfoCreate, **options)
end

#update_coupon(coupon_id:, body:, **options) ⇒ Resources::Coupon

Update an active coupon

update_coupon api documenation

Examples:

begin
  coupon_update = {
    name: "New Coupon Name"
  }
  coupon = @client.update_coupon(coupon_id: coupon_id, body: coupon_update)
  puts "Updated Coupon #{coupon}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • coupon_id (String)

    Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.

  • body (Requests::CouponUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::CouponUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


1477
1478
1479
1480
# File 'lib/recurly/client/operations.rb', line 1477

def update_coupon(coupon_id:, body:, **options)
  path = interpolate_path("/coupons/{coupon_id}", coupon_id: coupon_id)
  put(path, body, Requests::CouponUpdate, **options)
end

#update_invoice(invoice_id:, body:, **options) ⇒ Resources::Invoice

Examples:

begin
  invoice_update = {
    customer_notes: "New Notes",
    terms_and_conditions: "New Terms and Conditions"
  }
  invoice = @client.update_invoice(invoice_id: invoice_id, body: invoice_update)
  puts "Updated invoice #{invoice}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • body (Requests::InvoiceUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::InvoiceUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


2064
2065
2066
2067
# File 'lib/recurly/client/operations.rb', line 2064

def update_invoice(invoice_id:, body:, **options)
  path = interpolate_path("/invoices/{invoice_id}", invoice_id: invoice_id)
  put(path, body, Requests::InvoiceUpdate, **options)
end

#update_item(item_id:, body:, **options) ⇒ Resources::Item

Update an active item

update_item api documenation

Examples:

begin
  item_update = {
    name: "New Item Name",
    description: "New Item Description"
  }
  item = @client.update_item(
    item_id: item_id,
    body: item_update
  )
  puts "Updated Item #{item}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • item_id (String)

    Item ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-red.

  • body (Requests::ItemUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::ItemUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


1821
1822
1823
1824
# File 'lib/recurly/client/operations.rb', line 1821

def update_item(item_id:, body:, **options)
  path = interpolate_path("/items/{item_id}", item_id: item_id)
  put(path, body, Requests::ItemUpdate, **options)
end

#update_measured_unit(measured_unit_id:, body:, **options) ⇒ Resources::MeasuredUnit

Update a measured unit

update_measured_unit api documenation

Parameters:

  • measured_unit_id (String)

    Measured unit ID or name. For ID no prefix is used e.g. e28zov4fw0v2. For name use prefix name-, e.g. name-Storage.

  • body (Requests::MeasuredUnitUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::MeasuredUnitUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


1948
1949
1950
1951
# File 'lib/recurly/client/operations.rb', line 1948

def update_measured_unit(measured_unit_id:, body:, **options)
  path = interpolate_path("/measured_units/{measured_unit_id}", measured_unit_id: measured_unit_id)
  put(path, body, Requests::MeasuredUnitUpdate, **options)
end

#update_plan(plan_id:, body:, **options) ⇒ Resources::Plan

Examples:

begin
  plan_update = {
    name: "Monthly Kombucha Subscription"
  }
  plan = @client.update_plan(plan_id: plan_id, body: plan_update)
  puts "Updated plan #{plan}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • plan_id (String)

    Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • body (Requests::PlanUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::PlanUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


2610
2611
2612
2613
# File 'lib/recurly/client/operations.rb', line 2610

def update_plan(plan_id:, body:, **options)
  path = interpolate_path("/plans/{plan_id}", plan_id: plan_id)
  put(path, body, Requests::PlanUpdate, **options)
end

#update_plan_add_on(plan_id:, add_on_id:, body:, **options) ⇒ Resources::AddOn

Examples:

begin
  add_on_update = {
    name: "A quality grinder for your finest beans"
  }
  add_on = @client.update_plan_add_on(
    plan_id: plan_id,
    add_on_id: add_on_id,
    body: add_on_update
  )
  puts "Updated add-on #{add_on}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • plan_id (String)

    Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • add_on_id (String)

    Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

  • body (Requests::AddOnUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::AddOnUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


2776
2777
2778
2779
# File 'lib/recurly/client/operations.rb', line 2776

def update_plan_add_on(plan_id:, add_on_id:, body:, **options)
  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, **options)
end

#update_shipping_address(account_id:, shipping_address_id:, body:, **options) ⇒ Resources::ShippingAddress

Update an account's shipping address

update_shipping_address api documenation

Examples:

begin
  address_update = {
    first_name: "Aaron",
    last_name: "Du Monde",
    postal_code: "70130"
  }
  address = @client.update_shipping_address(
    account_id: ,
    shipping_address_id: shipping_address_id,
    body: address_update
  )
  puts "Updated ShippingAddress #{address}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • account_id (String)

    Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

  • shipping_address_id (String)

    Shipping Address ID.

  • body (Requests::ShippingAddressUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::ShippingAddressUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


1114
1115
1116
1117
# File 'lib/recurly/client/operations.rb', line 1114

def update_shipping_address(account_id:, shipping_address_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/shipping_addresses/{shipping_address_id}", account_id: , shipping_address_id: shipping_address_id)
  put(path, body, Requests::ShippingAddressUpdate, **options)
end

#update_shipping_method(shipping_method_id:, body:, **options) ⇒ Resources::ShippingMethod

Update an active Shipping Method

update_shipping_method api documenation

Parameters:

  • shipping_method_id (String)

    Shipping Method ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-usps_2-day.

  • body (Requests::ShippingMethodUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::ShippingMethodUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


2964
2965
2966
2967
# File 'lib/recurly/client/operations.rb', line 2964

def update_shipping_method(shipping_method_id:, body:, **options)
  path = interpolate_path("/shipping_methods/{shipping_method_id}", shipping_method_id: shipping_method_id)
  put(path, body, Requests::ShippingMethodUpdate, **options)
end

#update_subscription(subscription_id:, body:, **options) ⇒ Resources::Subscription

Update a subscription

update_subscription api documenation

Examples:

begin
  subscription_update = {
    customer_notes: "New Notes",
    terms_and_conditions: "New ToC"
  }
  subscription = @client.update_subscription(
    subscription_id: subscription_id,
    body: subscription_update
  )
  puts "Modified Subscription #{subscription}"
rescue Recurly::Errors::ValidationError => e
  # If the request was invalid, you may want to tell your user
  # why. You can find the invalid params and reasons in e.recurly_error.params
  puts "ValidationError: #{e.recurly_error.params}"
end

Parameters:

  • subscription_id (String)

    Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

  • body (Requests::SubscriptionUpdate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::SubscriptionUpdate

  • params (Hash)

    Optional query string parameters:

Returns:


3118
3119
3120
3121
# File 'lib/recurly/client/operations.rb', line 3118

def update_subscription(subscription_id:, body:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}", subscription_id: subscription_id)
  put(path, body, Requests::SubscriptionUpdate, **options)
end

#update_usage(usage_id:, body:, **options) ⇒ Resources::Usage

Update a usage record

update_usage api documenation

Parameters:

  • usage_id (String)

    Usage Record ID.

  • body (Requests::UsageCreate)

    The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::UsageCreate

  • params (Hash)

    Optional query string parameters:

Returns:


3609
3610
3611
3612
# File 'lib/recurly/client/operations.rb', line 3609

def update_usage(usage_id:, body:, **options)
  path = interpolate_path("/usage/{usage_id}", usage_id: usage_id)
  put(path, body, Requests::UsageCreate, **options)
end

#void_invoice(invoice_id:, **options) ⇒ Resources::Invoice

Void a credit invoice.

void_invoice api documenation

Examples:

begin
  invoice = @client.void_invoice(invoice_id: invoice_id)
  puts "Voided invoice #{invoice}"
rescue Recurly::Errors::NotFoundError
  # If the resource was not found, you may want to alert the user or
  # just return nil
  puts "Resource Not Found"
end

Parameters:

  • invoice_id (String)

    Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

  • params (Hash)

    Optional query string parameters:

Returns:


2206
2207
2208
2209
# File 'lib/recurly/client/operations.rb', line 2206

def void_invoice(invoice_id:, **options)
  path = interpolate_path("/invoices/{invoice_id}/void", invoice_id: invoice_id)
  put(path, **options)
end