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
REQUEST_OPTIONS = 
[:headers].freeze

Class Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, site_id: nil, subdomain: nil, 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:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/recurly/client.rb', line 50

def initialize(api_key:, site_id: nil, subdomain: nil, logger: nil)
  set_site_id(site_id, subdomain)
  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_pool ⇒ Recurly::ConnectionPool

Returns:



144
145
146
 
# File 'lib/recurly/client.rb', line 144

def connection_pool
  @connection_pool
end

Instance Method Details

#api_version ⇒ Object 



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

def api_version
  "v2019-10-10"
end

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

Apply available credit to a pending or past due charge invoice

apply_credit_balance api documentation

Examples:

begin
  invoice = @client.apply_credit_balance(invoice_id: invoice_id)
  puts "Applied credit balance to 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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • 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.

Returns:



2131
2132
2133
2134
 
# File 'lib/recurly/client/operations.rb', line 2131

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

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

Cancel a subscription

cancel_subscription api documentation

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.

  • body (Requests::SubscriptionCancel) —

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

  • 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.

Returns:



3194
3195
3196
3197
 
# File 'lib/recurly/client/operations.rb', line 3194

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 documentation

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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • body (Requests::InvoiceCollect) —

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

  • 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.

Returns:



2155
2156
2157
2158
 
# File 'lib/recurly/client/operations.rb', line 2155

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 documentation

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.

  • 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.

Returns:



3288
3289
3290
3291
 
# File 'lib/recurly/client/operations.rb', line 3288

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

Create an account

create_account api documentation

Examples:

begin
   = {
    code: ,
    first_name: "Benjamin",
    last_name: "Du Monde",
    preferred_time_zone: "America/Chicago",
    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:

  • body (Requests::AccountCreate) —

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

  • 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.

Returns:



161
162
163
164
 
# File 'lib/recurly/client/operations.rb', line 161

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

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

Add new billing information on an account

create_billing_info api documentation

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

  • 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.

Returns:



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

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 documentation

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:

  • body (Requests::CouponCreate) —

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

  • 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.

Returns:



1460
1461
1462
1463
 
# File 'lib/recurly/client/operations.rb', line 1460

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 documentation

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

  • 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.

Returns:



710
711
712
713
 
# File 'lib/recurly/client/operations.rb', line 710

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 documentation

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

  • 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.

Returns:



851
852
853
854
 
# File 'lib/recurly/client/operations.rb', line 851

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 documentation

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

  • 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.

Returns:



1787
1788
1789
1790
 
# File 'lib/recurly/client/operations.rb', line 1787

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 documentation

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

  • 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.

Returns:



963
964
965
966
 
# File 'lib/recurly/client/operations.rb', line 963

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 documentation

Parameters:

  • body (Requests::MeasuredUnitCreate) —

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

  • 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.

Returns:



1939
1940
1941
1942
 
# File 'lib/recurly/client/operations.rb', line 1939

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

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

Create a plan

create_plan api documentation

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

  • 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.

Returns:



2586
2587
2588
2589
 
# File 'lib/recurly/client/operations.rb', line 2586

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

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

Create an add-on

create_plan_add_on api documentation

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

  • 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.

Returns:



2741
2742
2743
2744
 
# File 'lib/recurly/client/operations.rb', line 2741

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 documentation

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:

  • body (Requests::PurchaseCreate) —

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

  • 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.

Returns:



3792
3793
3794
3795
 
# File 'lib/recurly/client/operations.rb', line 3792

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 documentation

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

  • 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.

Returns:



1101
1102
1103
1104
 
# File 'lib/recurly/client/operations.rb', line 1101

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 documentation

Parameters:

  • body (Requests::ShippingMethodCreate) —

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

  • 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.

Returns:



2952
2953
2954
2955
 
# File 'lib/recurly/client/operations.rb', line 2952

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 documentation

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:

  • body (Requests::SubscriptionCreate) —

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

  • 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.

Returns:



3076
3077
3078
3079
 
# File 'lib/recurly/client/operations.rb', line 3076

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 documentation

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

  • 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.

Returns:



3358
3359
3360
3361
 
# File 'lib/recurly/client/operations.rb', line 3358

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 documentation

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

  • 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.

Returns:



3600
3601
3602
3603
 
# File 'lib/recurly/client/operations.rb', line 3600

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 documentation

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.

  • 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.

Returns:



238
239
240
241
 
# File 'lib/recurly/client/operations.rb', line 238

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

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

Expire a coupon

deactivate_coupon api documentation

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.

  • 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.

Returns:



1533
1534
1535
1536
 
# File 'lib/recurly/client/operations.rb', line 1533

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

Deactivate an item

deactivate_item api documentation

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.

  • 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.

Returns:



1864
1865
1866
1867
 
# File 'lib/recurly/client/operations.rb', line 1864

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 documentation

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.

  • 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.

Returns:



2995
2996
2997
2998
 
# File 'lib/recurly/client/operations.rb', line 2995

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 documentation

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.

  • 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.

Returns:



3738
3739
3740
3741
 
# File 'lib/recurly/client/operations.rb', line 3738

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

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

Mark an open invoice as failed

fail_invoice api documentation

Examples:

begin
  invoice = @client.fail_invoice(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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • 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.

Returns:



2178
2179
2180
2181
 
# File 'lib/recurly/client/operations.rb', line 2178

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

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

Fetch a billing info

get_a_billing_info api documentation

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. Can ONLY be used for sites utilizing the Wallet feature.

  • 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.

Returns:



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

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 documentation

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.

  • 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.

Returns:



184
185
186
187
 
# File 'lib/recurly/client/operations.rb', line 184

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 documentation

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.

  • 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.

Returns:



261
262
263
264
 
# File 'lib/recurly/client/operations.rb', line 261

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 documentation

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.

  • 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.

Returns:



366
367
368
369
 
# File 'lib/recurly/client/operations.rb', line 366

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 documentation

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.

  • 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.

Returns:



1021
1022
1023
1024
 
# File 'lib/recurly/client/operations.rb', line 1021

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_active_coupon_redemption(account_id:, **options) ⇒ Resources::CouponRedemption

Fetch the coupon redemption that is active on an account

get_active_coupon_redemption api documentation

Examples:

begin
  redemption = @client.get_active_coupon_redemption(account_id: )
  puts "Got CouponRedemption #{redemption}"
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.

  • 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.

Returns:



679
680
681
682
 
# File 'lib/recurly/client/operations.rb', line 679

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

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

Fetch an add-on

get_add_on api documentation

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.

  • 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.

Returns:



2894
2895
2896
2897
 
# File 'lib/recurly/client/operations.rb', line 2894

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 documentation

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.

  • 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.

Returns:



389
390
391
392
 
# File 'lib/recurly/client/operations.rb', line 389

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

Fetch a coupon

get_coupon api documentation

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.

  • 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.

Returns:



1483
1484
1485
1486
 
# File 'lib/recurly/client/operations.rb', line 1483

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 documentation

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.

  • 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.

Returns:



1641
1642
1643
1644
 
# File 'lib/recurly/client/operations.rb', line 1641

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 documentation

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

  • 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.

Returns:



1709
1710
1711
1712
 
# File 'lib/recurly/client/operations.rb', line 1709

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_dunning_campaign(dunning_campaign_id:) ⇒ Resources::DunningCampaign

Fetch a dunning campaign

get_dunning_campaign api documentation

Parameters:

  • dunning_campaign_id (String) —

    Dunning Campaign ID, e.g. e28zov4fw0v2.

Returns:



3911
3912
3913
3914
 
# File 'lib/recurly/client/operations.rb', line 3911

def get_dunning_campaign(dunning_campaign_id:)
  path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id)
  get(path)
end

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

List the dates that have an available export to download.

get_export_dates api documentation

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:

  • 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.

Returns:



3856
3857
3858
3859
 
# File 'lib/recurly/client/operations.rb', line 3856

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 documentation

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.

  • 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.

Returns:



3881
3882
3883
3884
 
# File 'lib/recurly/client/operations.rb', line 3881

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 documentation

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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • 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.

Returns:



2054
2055
2056
2057
 
# File 'lib/recurly/client/operations.rb', line 2054

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 documentation

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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • 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.

Returns:



2108
2109
2110
2111
 
# File 'lib/recurly/client/operations.rb', line 2108

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

Fetch an item

get_item api documentation

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.

  • 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.

Returns:



1810
1811
1812
1813
 
# File 'lib/recurly/client/operations.rb', line 1810

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 documentation

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.

  • 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.

Returns:



2478
2479
2480
2481
 
# File 'lib/recurly/client/operations.rb', line 2478

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 documentation

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.

  • 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.

Returns:



1953
1954
1955
1956
 
# File 'lib/recurly/client/operations.rb', line 1953

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

Fetch a plan

get_plan api documentation

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.

  • 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.

Returns:



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

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 documentation

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.

  • 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.

Returns:



2767
2768
2769
2770
 
# File 'lib/recurly/client/operations.rb', line 2767

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_preview_renewal(subscription_id:, **options) ⇒ Resources::InvoiceCollection

Fetch a preview of a subscription's renewal invoice(s)

get_preview_renewal api documentation

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.

  • 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.

Returns:



3302
3303
3304
3305
 
# File 'lib/recurly/client/operations.rb', line 3302

def get_preview_renewal(subscription_id:, **options)
  path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_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 documentation

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.

  • 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.

Returns:



1128
1129
1130
1131
 
# File 'lib/recurly/client/operations.rb', line 1128

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(id:, **options) ⇒ Resources::ShippingMethod

Fetch a shipping method

get_shipping_method api documentation

Parameters:

  • 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.

  • 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.

Returns:



2966
2967
2968
2969
 
# File 'lib/recurly/client/operations.rb', line 2966

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

#get_site(site_id:) ⇒ Resources::Site

Fetch a site

get_site api documentation

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.

Returns:



64
65
66
67
 
# File 'lib/recurly/client/operations.rb', line 64

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

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

Fetch a subscription

get_subscription api documentation

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.

  • 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.

Returns:



3101
3102
3103
3104
 
# File 'lib/recurly/client/operations.rb', line 3101

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 documentation

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.

  • 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.

Returns:



3327
3328
3329
3330
 
# File 'lib/recurly/client/operations.rb', line 3327

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 documentation

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.

  • 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.

Returns:



3710
3711
3712
3713
 
# File 'lib/recurly/client/operations.rb', line 3710

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 documentation

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.

  • 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.

Returns:



3724
3725
3726
3727
 
# File 'lib/recurly/client/operations.rb', line 3724

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 documentation

Parameters:

  • usage_id (String) —

    Usage Record ID.

  • 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.

Returns:



3614
3615
3616
3617
 
# File 'lib/recurly/client/operations.rb', line 3614

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1382
1383
1384
1385
 
# File 'lib/recurly/client/operations.rb', line 1382

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

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

List the coupon redemptions for an account

list_account_coupon_redemptions api documentation

Examples:

redemptions = @client.(
  account_id: ,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



656
657
658
659
 
# File 'lib/recurly/client/operations.rb', line 656

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 documentation

Examples:

payments = @client.(
  account_id: ,
  limit: 200
)
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.

  • 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.

  • 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.

Returns:



767
768
769
770
 
# File 'lib/recurly/client/operations.rb', line 767

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 documentation

Examples:

invoices = @client.(
  account_id: ,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

    Important notes:

    • The ids parameter cannot be used with any other ordering or filtering parameters (+limit+, order, sort, begin_time, end_time, etc)
    • Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
    • Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
  • state (String) —

    Invoice state.

  • limit (Integer) —

    Limit number of records 1-200.

  • order (String) —

    Sort order.

  • sort (String) —

    Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

  • begin_time (DateTime) —

    Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note: this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

  • end_time (DateTime) —

    Inclusively filter by end_time when sort=created_at or sort=updated_at. Note: this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

  • type (String) —

    Filter by type when:

    • type=charge, only charge invoices will be returned.
    • type=credit, only credit invoices will be returned.
    • type=non-legacy, only charge and credit invoices will be returned.
    • type=legacy, only legacy invoices will be returned.
  • 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.

Returns:



820
821
822
823
 
# File 'lib/recurly/client/operations.rb', line 820

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 documentation

Examples:

line_items = @client.(
  account_id: ,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



931
932
933
934
 
# File 'lib/recurly/client/operations.rb', line 931

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>

List an account's notes

list_account_notes api documentation

Examples:

 = @client.(account_id: , limit: 200)
.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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.
  • 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.

Returns:



994
995
996
997
 
# File 'lib/recurly/client/operations.rb', line 994

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 documentation

Examples:

subscriptions = @client.(
  account_id: ,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.
  • 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.

Returns:



1241
1242
1243
1244
 
# File 'lib/recurly/client/operations.rb', line 1241

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 documentation

Examples:

transactions = @client.(
  account_id: ,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1289
1290
1291
1292
 
# File 'lib/recurly/client/operations.rb', line 1289

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



111
112
113
114
 
# File 'lib/recurly/client/operations.rb', line 111

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

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

List a site's add-ons

list_add_ons api documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



2871
2872
2873
2874
 
# File 'lib/recurly/client/operations.rb', line 2871

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 documentation

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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



518
519
520
521
 
# File 'lib/recurly/client/operations.rb', line 518

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 documentation

Examples:

child_accounts = @client.list_child_accounts(
  account_id: ,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1340
1341
1342
1343
 
# File 'lib/recurly/client/operations.rb', line 1340

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1424
1425
1426
1427
 
# File 'lib/recurly/client/operations.rb', line 1424

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 documentation

Examples:

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

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

  • 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.

Returns:



1627
1628
1629
1630
 
# File 'lib/recurly/client/operations.rb', line 1627

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1684
1685
1686
1687
 
# File 'lib/recurly/client/operations.rb', line 1684

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

#list_dunning_campaigns(**options) ⇒ Pager<Resources::DunningCampaign>

List the dunning campaigns for a site

list_dunning_campaigns api documentation

Parameters:

  • 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.

  • 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.

Returns:



3898
3899
3900
3901
 
# File 'lib/recurly/client/operations.rb', line 3898

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

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

List the coupon redemptions applied to an invoice

list_invoice_coupon_redemptions api documentation

Examples:

coupon_redemptions = @client.list_invoice_coupon_redemptions(
  invoice_id: invoice_id,
  limit: 200
)
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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



2355
2356
2357
2358
 
# File 'lib/recurly/client/operations.rb', line 2355

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 documentation

Examples:

line_items = @client.list_invoice_line_items(
  invoice_id: invoice_id,
  limit: 200
)
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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



2311
2312
2313
2314
 
# File 'lib/recurly/client/operations.rb', line 2311

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

    Important notes:

    • The ids parameter cannot be used with any other ordering or filtering parameters (+limit+, order, sort, begin_time, end_time, etc)
    • Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
    • Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
  • state (String) —

    Invoice state.

  • limit (Integer) —

    Limit number of records 1-200.

  • order (String) —

    Sort order.

  • sort (String) —

    Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

  • begin_time (DateTime) —

    Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note: this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

  • end_time (DateTime) —

    Inclusively filter by end_time when sort=created_at or sort=updated_at. Note: this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

  • type (String) —

    Filter by type when:

    • type=charge, only charge invoices will be returned.
    • type=credit, only credit invoices will be returned.
    • type=non-legacy, only charge and credit invoices will be returned.
    • type=legacy, only legacy invoices will be returned.
  • 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.

Returns:



2031
2032
2033
2034
 
# File 'lib/recurly/client/operations.rb', line 2031

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

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

List a site's items

list_items api documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1752
1753
1754
1755
 
# File 'lib/recurly/client/operations.rb', line 1752

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



2455
2456
2457
2458
 
# File 'lib/recurly/client/operations.rb', line 2455

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 documentation

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1925
1926
1927
1928
 
# File 'lib/recurly/client/operations.rb', line 1925

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 documentation

Examples:

add_ons = @client.list_plan_add_ons(
  plan_id: plan_id,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



2706
2707
2708
2709
 
# File 'lib/recurly/client/operations.rb', line 2706

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



2546
2547
2548
2549
 
# File 'lib/recurly/client/operations.rb', line 2546

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

#list_related_invoices(invoice_id:, **options) ⇒ Pager<Resources::Invoice>

List an invoice's related credit or charge invoices

list_related_invoices api documentation

Examples:

invoices = @client.list_related_invoices(
  invoice_id: invoice_id,
  limit: 200
)
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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • 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.

Returns:



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

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 documentation

Examples:

shipping_addresses = @client.list_shipping_addresses(
  account_id: ,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1067
1068
1069
1070
 
# File 'lib/recurly/client/operations.rb', line 1067

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



2938
2939
2940
2941
 
# File 'lib/recurly/client/operations.rb', line 2938

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

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

List sites

list_sites api documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

Returns:



42
43
44
45
 
# File 'lib/recurly/client/operations.rb', line 42

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

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

List the coupon redemptions for a subscription

list_subscription_coupon_redemptions api documentation

Examples:

coupon_redemptions = @client.list_subscription_coupon_redemptions(
  subscription_id: subscription_id,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



3544
3545
3546
3547
 
# File 'lib/recurly/client/operations.rb', line 3544

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 documentation

Examples:

invoices = @client.list_subscription_invoices(
  subscription_id: subscription_id,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

    Important notes:

    • The ids parameter cannot be used with any other ordering or filtering parameters (+limit+, order, sort, begin_time, end_time, etc)
    • Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
    • Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
  • state (String) —

    Invoice state.

  • limit (Integer) —

    Limit number of records 1-200.

  • order (String) —

    Sort order.

  • sort (String) —

    Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

  • begin_time (DateTime) —

    Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note: this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

  • end_time (DateTime) —

    Inclusively filter by end_time when sort=created_at or sort=updated_at. Note: this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

  • type (String) —

    Filter by type when:

    • type=charge, only charge invoices will be returned.
    • type=credit, only credit invoices will be returned.
    • type=non-legacy, only charge and credit invoices will be returned.
    • type=legacy, only legacy invoices will be returned.
  • 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.

Returns:



3451
3452
3453
3454
 
# File 'lib/recurly/client/operations.rb', line 3451

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 documentation

Examples:

line_items = @client.list_subscription_line_items(
  subscription_id: subscription_id,
  limit: 200
)
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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



3500
3501
3502
3503
 
# File 'lib/recurly/client/operations.rb', line 3500

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 documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.
  • 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.

Returns:



3043
3044
3045
3046
 
# File 'lib/recurly/client/operations.rb', line 3043

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

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

List a site's transactions

list_transactions api documentation

Examples:

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

Parameters:

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



3687
3688
3689
3690
 
# File 'lib/recurly/client/operations.rb', line 3687

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 documentation

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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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.

  • 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.

Returns:



1597
1598
1599
1600
 
# File 'lib/recurly/client/operations.rb', line 1597

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 documentation

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.

  • ids (String) —

    Filter results by their IDs. Up to 200 IDs can be passed at once using 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

  • 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.

Returns:



3584
3585
3586
3587
 
# File 'lib/recurly/client/operations.rb', line 3584

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_successful(invoice_id:, **options) ⇒ Resources::Invoice

Mark an open invoice as successful

mark_invoice_successful api documentation

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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • 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.

Returns:



2201
2202
2203
2204
 
# File 'lib/recurly/client/operations.rb', line 2201

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

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

Modify a subscription

modify_subscription api documentation

Examples:

begin
  subscription_update = {
    customer_notes: "New Notes",
    terms_and_conditions: "New ToC"
  }
  subscription = @client.modify_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

  • 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.

Returns:



3132
3133
3134
3135
 
# File 'lib/recurly/client/operations.rb', line 3132

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

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

Pause subscription

pause_subscription api documentation

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

  • 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.

Returns:



3249
3250
3251
3252
 
# File 'lib/recurly/client/operations.rb', line 3249

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 documentation

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

  • 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.

Returns:



882
883
884
885
 
# File 'lib/recurly/client/operations.rb', line 882

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 documentation

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:

  • body (Requests::PurchaseCreate) —

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

  • 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.

Returns:



3832
3833
3834
3835
 
# File 'lib/recurly/client/operations.rb', line 3832

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

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

Preview a new subscription change

preview_subscription_change api documentation

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

  • 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.

Returns:



3398
3399
3400
3401
 
# File 'lib/recurly/client/operations.rb', line 3398

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

#put_dunning_campaign_bulk_update(dunning_campaign_id:, body:) ⇒ Resources::DunningCampaignsBulkUpdateResponse

Assign a dunning campaign to multiple plans

put_dunning_campaign_bulk_update api documentation

Parameters:

Returns:



3925
3926
3927
3928
 
# File 'lib/recurly/client/operations.rb', line 3925

def put_dunning_campaign_bulk_update(dunning_campaign_id:, body:)
  path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}/bulk_update", dunning_campaign_id: dunning_campaign_id)
  put(path, body, Requests::DunningCampaignsBulkUpdate)
end

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

Update an invoice

put_invoice api documentation

Examples:

begin
  invoice_update = {
    customer_notes: "New Notes",
    terms_and_conditions: "New Terms and Conditions"
  }
  invoice = @client.put_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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • body (Requests::InvoiceUpdatable) —

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

  • 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.

Returns:



2082
2083
2084
2085
 
# File 'lib/recurly/client/operations.rb', line 2082

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

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

Reactivate an inactive account

reactivate_account api documentation

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.

  • 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.

Returns:



343
344
345
346
 
# File 'lib/recurly/client/operations.rb', line 343

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 documentation

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.

  • 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.

Returns:



1887
1888
1889
1890
 
# File 'lib/recurly/client/operations.rb', line 1887

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 documentation

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.

  • 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.

Returns:



3219
3220
3221
3222
 
# File 'lib/recurly/client/operations.rb', line 3219

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 documentation

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.

  • 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.

Returns:



3752
3753
3754
3755
 
# File 'lib/recurly/client/operations.rb', line 3752

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 documentation

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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • body (Requests::ExternalTransaction) —

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

  • 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.

Returns:



2262
2263
2264
2265
 
# File 'lib/recurly/client/operations.rb', line 2262

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

Refund an invoice

refund_invoice api documentation

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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • body (Requests::InvoiceRefund) —

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

  • 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.

Returns:



2408
2409
2410
2411
 
# File 'lib/recurly/client/operations.rb', line 2408

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 documentation

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. Can ONLY be used for sites utilizing the Wallet feature.

  • 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.

Returns:



579
580
581
582
 
# File 'lib/recurly/client/operations.rb', line 579

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 documentation

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.

  • 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.

Returns:



320
321
322
323
 
# File 'lib/recurly/client/operations.rb', line 320

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 documentation

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.

  • 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.

Returns:



443
444
445
446
 
# File 'lib/recurly/client/operations.rb', line 443

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 documentation

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.

  • 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.

Returns:



733
734
735
736
 
# File 'lib/recurly/client/operations.rb', line 733

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 documentation

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.

  • 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.

Returns:



2503
2504
2505
2506
 
# File 'lib/recurly/client/operations.rb', line 2503

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 documentation

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.

  • 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.

Returns:



1982
1983
1984
1985
 
# File 'lib/recurly/client/operations.rb', line 1982

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

Remove a plan

remove_plan api documentation

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.

  • 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.

Returns:



2659
2660
2661
2662
 
# File 'lib/recurly/client/operations.rb', line 2659

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

Remove an add-on

remove_plan_add_on api documentation

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.

  • 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.

Returns:



2826
2827
2828
2829
 
# File 'lib/recurly/client/operations.rb', line 2826

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 documentation

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.

  • 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.

Returns:



1189
1190
1191
1192
 
# File 'lib/recurly/client/operations.rb', line 1189

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 documentation

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.

  • 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.

Returns:



3383
3384
3385
3386
 
# File 'lib/recurly/client/operations.rb', line 3383

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 documentation

Parameters:

  • usage_id (String) —

    Usage Record ID.

  • 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.

Returns:



3643
3644
3645
3646
 
# File 'lib/recurly/client/operations.rb', line 3643

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 documentation

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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • 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.

Returns:



2224
2225
2226
2227
 
# File 'lib/recurly/client/operations.rb', line 2224

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 documentation

Examples:

begin
  coupon = @client.restore_coupon(coupon_id: coupon_id, body: {
    name: "New Coupon Name"
  })
  puts "Restored 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

  • 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.

Returns:



1559
1560
1561
1562
 
# File 'lib/recurly/client/operations.rb', line 1559

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

Resume subscription

resume_subscription api documentation

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.

  • 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.

Returns:



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

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 documentation

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.

  • refund (String) —

    The type of refund to perform:

    • 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.

  • 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.

Returns:



3168
3169
3170
3171
 
# File 'lib/recurly/client/operations.rb', line 3168

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 documentation

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. Can ONLY be used for sites utilizing the Wallet feature.

  • body (Requests::BillingInfoCreate) —

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

  • 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.

Returns:



564
565
566
567
 
# File 'lib/recurly/client/operations.rb', line 564

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

Modify an account

update_account api documentation

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

  • 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.

Returns:



215
216
217
218
 
# File 'lib/recurly/client/operations.rb', line 215

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 documentation

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::AccountAcquisitionUpdatable) —

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

  • 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.

Returns:



297
298
299
300
 
# File 'lib/recurly/client/operations.rb', line 297

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

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

Set an account's billing information

update_billing_info api documentation

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

  • 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.

Returns:



420
421
422
423
 
# File 'lib/recurly/client/operations.rb', line 420

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 documentation

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

  • 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.

Returns:



1510
1511
1512
1513
 
# File 'lib/recurly/client/operations.rb', line 1510

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_item(item_id:, body:, **options) ⇒ Resources::Item

Update an active item

update_item api documentation

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

  • 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.

Returns:



1841
1842
1843
1844
 
# File 'lib/recurly/client/operations.rb', line 1841

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 documentation

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

  • 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.

Returns:



1968
1969
1970
1971
 
# File 'lib/recurly/client/operations.rb', line 1968

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

Update a plan

update_plan api documentation

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

  • 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.

Returns:



2636
2637
2638
2639
 
# File 'lib/recurly/client/operations.rb', line 2636

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

Update an add-on

update_plan_add_on api documentation

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

  • 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.

Returns:



2799
2800
2801
2802
 
# File 'lib/recurly/client/operations.rb', line 2799

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 documentation

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

  • 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.

Returns:



1162
1163
1164
1165
 
# File 'lib/recurly/client/operations.rb', line 1162

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 documentation

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

  • 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.

Returns:



2981
2982
2983
2984
 
# File 'lib/recurly/client/operations.rb', line 2981

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_usage(usage_id:, body:, **options) ⇒ Resources::Usage

Update a usage record

update_usage api documentation

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

  • 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.

Returns:



3629
3630
3631
3632
 
# File 'lib/recurly/client/operations.rb', line 3629

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

#verify_billing_info(account_id:, **options) ⇒ Resources::Transaction

Verify an account's credit card billing information

verify_billing_info api documentation

Examples:

begin
  transaction = @client.verify_billing_info(account_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:

  • 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::BillingInfoVerify) —

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

  • 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.

Returns:



467
468
469
470
 
# File 'lib/recurly/client/operations.rb', line 467

def verify_billing_info(account_id:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: )
  post(path, options[:body], Requests::BillingInfoVerify, **options)
end

#verify_billing_info_cvv(account_id:, body:, **options) ⇒ Resources::Transaction

Verify an account's credit card billing cvv

verify_billing_info_cvv api documentation

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::BillingInfoVerifyCVV) —

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

  • 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.

Returns:



482
483
484
485
 
# File 'lib/recurly/client/operations.rb', line 482

def verify_billing_info_cvv(account_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_info/verify_cvv", account_id: )
  post(path, body, Requests::BillingInfoVerifyCVV, **options)
end

#verify_billing_infos(account_id:, billing_info_id:, **options) ⇒ Resources::Transaction

Verify a billing information's credit card

verify_billing_infos api documentation

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. Can ONLY be used for sites utilizing the Wallet feature.

  • body (Requests::BillingInfoVerify) —

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

  • 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.

Returns:



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

def verify_billing_infos(account_id:, billing_info_id:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}/verify", account_id: , billing_info_id: billing_info_id)
  post(path, options[:body], Requests::BillingInfoVerify, **options)
end

#verify_billing_infos_cvv(account_id:, billing_info_id:, body:, **options) ⇒ Resources::Transaction

Verify a billing information's credit card cvv

verify_billing_infos_cvv api documentation

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. Can ONLY be used for sites utilizing the Wallet feature.

  • body (Requests::BillingInfoVerifyCVV) —

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

  • 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.

Returns:



611
612
613
614
 
# File 'lib/recurly/client/operations.rb', line 611

def verify_billing_infos_cvv(account_id:, billing_info_id:, body:, **options)
  path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv", account_id: , billing_info_id: billing_info_id)
  post(path, body, Requests::BillingInfoVerifyCVV, **options)
end

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

Void a credit invoice.

void_invoice api documentation

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. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

  • 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.

Returns:



2247
2248
2249
2250
 
# File 'lib/recurly/client/operations.rb', line 2247

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