This file is automatically created by Recurly's OpenAPI generation process and thus any edits you make by hand will be lost. If you wish to make a change to this file, please create a Github issue explaining the changes you need and we will usher them to the appropriate places.
# 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:
+
+
+
+
+ region
+
+
+ (String)
+
+
+ (defaults to: REGION)
+
+
+ —
+
+
The DataCenter that is called by the API. Default to “us”
# File 'lib/recurly/client.rb', line 64
+
+definitialize(region:REGION,base_url:API_HOSTS[:us],ca_file:CA_FILE,api_key:,logger:nil)
+ raiseArgumentError,"'api_key' must be set to a non-nil value"ifapi_key.nil?
+
+ raiseArgumentError,"Invalid region type. Expected one of: #{API_HOSTS.keys.join(", ")}"if!API_HOSTS.key?(region)
+
+ base_url=API_HOSTS[region]ifbase_url==API_HOSTS[:us]&&API_HOSTS.key?(region)
+
+ set_api_key(api_key)
+ set_connection_options(base_url,ca_file)
+
+ iflogger.nil?
+ @logger=Logger.new(STDOUT).tapdo|l|
+ l.level=Logger::WARN
+ end
+ else
+ unlessLOG_LEVELS.all?{|lev|logger.respond_to?(lev)}
+ raiseArgumentError,"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)ifblock_given?
+end
begin
+ invoice=@client.apply_credit_balance(invoice_id:invoice_id)
+ puts"Applied credit balance to invoice #{invoice}"
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
+
+
+
Parameters:
+
+
+
+
+ invoice_id
+
+
+ (String)
+
+
+
+ —
+
+
Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :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.
begin
+ subscription=@client.cancel_subscription(
+ subscription_id:subscription_id
+ )
+ puts"Canceled Subscription #{subscription}"
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
+
+
+
Parameters:
+
+
+
+
+ subscription_id
+
+
+ (String)
+
+
+
+ —
+
+
Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::SubscriptionCancel
begin
+ invoice=@client.collect_invoice(invoice_id:invoice_id)
+ puts"Collected invoice #{invoice}"
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
+
+
+
Parameters:
+
+
+
+
+ invoice_id
+
+
+ (String)
+
+
+
+ —
+
+
Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::InvoiceCollect
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}"
+rescueRecurly::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
begin
+ redemption_create={
+ currency:'USD',
+ coupon_id:coupon_id
+ }
+ redemption=@client.create_coupon_redemption(
+ account_id:account_id,
+ body:redemption_create
+ )
+ puts"Created CouponRedemption #{redemption}"
+rescueRecurly::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.
begin
+ invoice_create={
+ currency:'USD',
+ collection_method:'automatic'
+ }
+ collection=@client.create_invoice(
+ account_id:account_id,
+ body:invoice_create
+ )
+ puts"Created InvoiceCollection #{collection}"
+rescueRecurly::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.
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}"
+rescueRecurly::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
begin
+ line_item_create={
+ currency:'USD',
+ unit_amount:1_000,
+ type::charge
+ }
+ line_item=@client.create_line_item(
+ account_id:account_id,
+ body:line_item_create
+ )
+ puts"Created LineItem #{line_item}"
+rescueRecurly::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.
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}"
+rescueRecurly::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
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}"
+rescueRecurly::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.
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:account_id,body:shipping_address_create)
+ puts"Created Shipping Address #{shipping_address}"
+rescueRecurly::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.
begin
+ subscription_create={
+ plan_code:plan_code,
+ currency:"USD",
+ # This can be an existing account or a new account
+account:{
+ code:account_code,
+ }
+ }
+ subscription=@client.create_subscription(
+ body:subscription_create
+ )
+ puts"Created Subscription #{subscription}"
+rescueRecurly::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
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}"
+rescueRecurly::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.
begin
+ account=@client.deactivate_account(account_id:account_id)
+ puts"Deactivated Account #{account}"
+rescueRecurly::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.
begin
+ coupon=@client.deactivate_coupon(coupon_id:coupon_id)
+ puts"Deactivated Coupon #{coupon}"
+rescueRecurly::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.
begin
+ item=@client.deactivate_item(item_id:item_id)
+ puts"Deactivated Item #{item}"
+rescueRecurly::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.
begin
+ account=@client.get_account(account_id:account_id)
+ puts"Got Account #{account}"
+rescueRecurly::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.
begin
+ @client.get_account_acquisition(account_id:account_id)
+ puts"Got AccountAcquisition"
+rescueRecurly::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.
begin
+ balance=@client.get_account_balance(account_id:account_id)
+ puts"Got AccountBalance #{balance}"
+rescueRecurly::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.
begin
+ note=@client.get_account_note(
+ account_id:account_id,
+ account_note_id:note_id
+ )
+ puts"Got AccountNote #{note}"
+rescueRecurly::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.
begin
+ add_on=@client.get_add_on(add_on_id:add_on_id)
+ puts"Got add-on #{add_on}"
+rescueRecurly::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.
begin
+ billing=@client.get_billing_info(account_id:account_id)
+ puts"Got BillingInfo #{billing}"
+rescueRecurly::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.
begin
+ coupon=@client.get_coupon(coupon_id:coupon_id)
+ puts"Got Coupon #{coupon}"
+rescueRecurly::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.
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}"
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
begin
+ export_dates=@client.get_export_dates()
+ export_dates.dates.eachdo|date|
+ puts"Exports are available for: #{date}"
+ end
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
begin
+ export_files=@client.get_export_files(export_date:export_date)
+ export_files.files.eachdo|file|
+ puts"Export file download URL: #{file.href}"
+ end
+rescueRecurly::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.
begin
+ invoice=@client.get_invoice(invoice_id:invoice_id)
+ puts"Got invoice #{invoice}"
+rescueRecurly::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.
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}"
+rescueRecurly::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.
begin
+ item=@client.get_item(item_id:item_id)
+ puts"Got Item #{item}"
+rescueRecurly::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.
begin
+ line_item=@client.get_line_item(line_item_id:line_item_id)
+ puts"Got LineItem #{line_item}"
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
begin
+ plan=@client.get_plan(plan_id:plan_id)
+ puts"Got plan #{plan}"
+rescueRecurly::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.
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}"
+rescueRecurly::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.
begin
+ invoice_collection=@client.get_preview_renewal(
+ subscription_id:subscription_id
+ )
+ puts"Fetched Renewal Preview with total: #{invoice_collection.charge_invoice.total}"
+rescueRecurly::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.
begin
+ address=@client.get_shipping_address(
+ account_id:account_id,
+ shipping_address_id:shipping_address_id
+ )
+ puts"Got ShippingAddress #{address}"
+rescueRecurly::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.
begin
+ site=@client.get_site(site_id:site_id)
+ puts"Got Site #{site}"
+rescueRecurly::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.
begin
+ subscription=@client.get_subscription(
+ subscription_id:subscription_id
+ )
+ puts"Got Subscription #{subscription}"
+rescueRecurly::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.
begin
+ change=@client.get_subscription_change(
+ subscription_id:subscription_id
+ )
+ puts"Got SubscriptionChange #{change}"
+rescueRecurly::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.
begin
+ transaction=@client.get_transaction(transaction_id:transaction_id)
+ puts"Got Transaction #{transaction}"
+rescueRecurly::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.
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.
+
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.
+
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.
+
Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :limit [Integer] Limit number of records 1-200. :order [String] Sort order. :sort [String] Sort field. You really only want to sort by updated_at in ascending
order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+ account_id
+
+
+ (String)
+
+
+
+ —
+
+
Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :sort [String] Sort field. You really only want to sort by updated_at in ascending
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+
+*Important notes:*
+
+* The +ids+ parameter cannot be used with any other ordering or filtering
+ parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+* Invalid or unknown IDs will be ignored, so you should check that the
+ results correspond to your request.
+* Records are returned in an arbitrary order. Since results are all
+ returned at once you can sort the records yourself.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+ :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :type [String] Filter by type when:
+- +type=charge+, only charge invoices will be returned.
+- +type=credit+, only credit invoices will be returned.
+- +type=non-legacy+, only charge and credit invoices will be returned.
+- +type=legacy+, only legacy invoices will be returned.
+
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.
+
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.
+
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.
+
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.
+
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.
+
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.
+
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+
+*Important notes:*
+
+* The +ids+ parameter cannot be used with any other ordering or filtering
+ parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+* Invalid or unknown IDs will be ignored, so you should check that the
+ results correspond to your request.
+* Records are returned in an arbitrary order. Since results are all
+ returned at once you can sort the records yourself.
+
+ :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+ account_id
+
+
+ (String)
+
+
+
+ —
+
+
Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
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.
+
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.
+
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.
+
Optional query string parameters: :limit [Integer] Limit number of records 1-200. :order [String] Sort order. :sort [String] Sort field. You really only want to sort by updated_at in ascending
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.
+
- When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
+- When no state is provided, subscriptions with active or canceled states will be returned.
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+ account_id
+
+
+ (String)
+
+
+
+ —
+
+
Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :state [String] Filter the entitlements based on the state of the applicable subscription.
order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string 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.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+
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.
+
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.
+
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.
+
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+
+*Important notes:*
+
+* The +ids+ parameter cannot be used with any other ordering or filtering
+ parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+* Invalid or unknown IDs will be ignored, so you should check that the
+ results correspond to your request.
+* Records are returned in an arbitrary order. Since results are all
+ returned at once you can sort the records yourself.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+ :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :type [String] Filter by type when:
+- +type=charge+, only charge invoices will be returned.
+- +type=credit+, only credit invoices will be returned.
+- +type=non-legacy+, only charge and credit invoices will be returned.
+- +type=legacy+, only legacy invoices will be returned.
+
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.
+
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.
+
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+
+*Important notes:*
+
+* The +ids+ parameter cannot be used with any other ordering or filtering
+ parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+* Invalid or unknown IDs will be ignored, so you should check that the
+ results correspond to your request.
+* Records are returned in an arbitrary order. Since results are all
+ returned at once you can sort the records yourself.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+ :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :state [String] Filter by state.
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
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.
+
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.
+
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.
+
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.
+
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.
+
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.
+
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+
+*Important notes:*
+
+* The +ids+ parameter cannot be used with any other ordering or filtering
+ parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+* Invalid or unknown IDs will be ignored, so you should check that the
+ results correspond to your request.
+* Records are returned in an arbitrary order. Since results are all
+ returned at once you can sort the records yourself.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+ :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :type [String] Filter by type when:
+- +type=charge+, only charge invoices will be returned.
+- +type=credit+, only credit invoices will be returned.
+- +type=non-legacy+, only charge and credit invoices will be returned.
+- +type=legacy+, only legacy invoices will be returned.
+
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.
+
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.
+
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.
+
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+
+*Important notes:*
+
+* The +ids+ parameter cannot be used with any other ordering or filtering
+ parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+* Invalid or unknown IDs will be ignored, so you should check that the
+ results correspond to your request.
+* Records are returned in an arbitrary order. Since results are all
+ returned at once you can sort the records yourself.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+ :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+ coupon_id
+
+
+ (String)
+
+
+
+ —
+
+
Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+
+*Important notes:*
+
+* The +ids+ parameter cannot be used with any other ordering or filtering
+ parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+* Invalid or unknown IDs will be ignored, so you should check that the
+ results correspond to your request.
+* Records are returned in an arbitrary order. Since results are all
+ returned at once you can sort the records yourself.
+
+ :limit [Integer] Limit number of records 1-200.
+ :order [String] Sort order.
+ :sort [String] Sort field. You *really* only want to sort by +usage_timestamp+ in ascending
+order. In descending order updated records will move behind the cursor and could
+prevent some records from being returned.
+
+ :begin_time [DateTime] Inclusively filter by begin_time when +sort=usage_timestamp+ or +sort=recorded_timestamp+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :end_time [DateTime] Inclusively filter by end_time when +sort=usage_timestamp+ or +sort=recorded_timestamp+.
+*Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+
+ :billing_status [String] Filter by usage record's billing status
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+ subscription_id
+
+
+ (String)
+
+
+
+ —
+
+
Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
+
+
+
+
+
+
+ add_on_id
+
+
+ (String)
+
+
+
+ —
+
+
Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
begin
+ invoice=@client.mark_invoice_failed(invoice_id:invoice_id)
+ puts"Failed invoice #{invoice}"
+rescueRecurly::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.
begin
+ invoice=@client.mark_invoice_successful(invoice_id:invoice_id)
+ puts"Marked invoice sucessful #{invoice}"
+rescueRecurly::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.
begin
+ subscription_pause={
+ remaining_pause_cycles:10
+ }
+ subscription=@client.pause_subscription(
+ subscription_id:subscription_id,
+ body:subscription_pause
+ )
+ puts"Paused Subscription #{subscription}"
+rescueRecurly::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.
begin
+ invoice_preview={
+ currency:"USD",
+ collection_method:"automatic"
+ }
+ collection=@client.create_invoice(
+ account_id:account_id,
+ body:invoice_preview
+ )
+ puts"Created InvoiceCollection #{collection}"
+rescueRecurly::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.
begin
+ account=@client.reactivate_account(account_id:account_id)
+ puts"Reactivated account #{account}"
+rescueRecurly::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.
begin
+ item=@client.reactivate_item(item_id:item_id)
+ puts"Reactivated Item #{item}"
+rescueRecurly::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.
begin
+ subscription=@client.reactivate_subscription(
+ subscription_id:subscription_id
+ )
+ puts"Reactivated Canceled Subscription #{subscription}"
+rescueRecurly::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.
begin
+ invoice_refund={
+ type:"amount",
+ amount:100,
+ }
+ invoice=@client.refund_invoice(
+ invoice_id:invoice_id,
+ body:invoice_refund
+ )
+ puts"Refunded invoice #{invoice}"
+rescueRecurly::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.
begin
+ acquisition=@client.remove_account_acquisition(account_id:account_id)
+ puts"Removed AccountAcqusition #{acquisition}"
+rescueRecurly::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.
begin
+ @client.remove_billing_info(account_id:account_id)
+ puts"Removed BillingInfo #{account_id}"
+rescueRecurly::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.
begin
+ @client.remove_coupon_redemption(account_id:account_id)
+ puts"Removed CouponRedemption #{account_id}"
+rescueRecurly::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.
begin
+ @client.remove_line_item(
+ line_item_id:line_item_id
+ )
+ puts"Removed LineItem #{line_item_id}"
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
begin
+ plan=@client.remove_plan(plan_id:plan_id)
+ puts"Removed plan #{plan}"
+rescueRecurly::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.
begin
+ add_on=@client.remove_plan_add_on(
+ plan_id:plan_id,
+ add_on_id:add_on_id
+ )
+ puts"Removed add-on #{add_on}"
+rescueRecurly::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.
begin
+ @client.remove_shipping_address(
+ account_id:account_id,
+ shipping_address_id:shipping_address_id
+ )
+ puts"Removed ShippingAddress #{shipping_address_id}"
+rescueRecurly::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.
begin
+ @client.remove_subscription_change(
+ subscription_id:subscription_id
+ )
+ puts"Removed SubscriptionChange #{subscription_id}"
+rescueRecurly::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.
begin
+ invoice=@client.reopen_invoice(invoice_id:invoice_id)
+ puts"Reopened invoice #{invoice}"
+rescueRecurly::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.
begin
+ subscription=@client.resume_subscription(
+ subscription_id:subscription_id
+ )
+ puts"Resumed Subscription #{subscription}"
+rescueRecurly::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.
* +full+ - Performs a full refund of the last invoice for the current subscription term.
+* +partial+ - Prorates a refund based on the amount of time remaining in the current bill cycle.
+* +none+ - Terminates the subscription without a refund.
+
+In the event that the most recent invoice is a $0 invoice paid entirely by credit, Recurly will apply the credit back to the customer’s account.
+
+You may also terminate a subscription with no refund and then manually refund specific invoices.
+
+ :charge [Boolean] Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.
+
+
+
+
+
+
+
+
+
Examples:
+
+
+
begin
+ subscription=@client.terminate_subscription(
+ subscription_id:subscription_id,
+ )
+ puts"Terminated Subscription #{subscription}"
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
+
+
+
Parameters:
+
+
+
+
+ subscription_id
+
+
+ (String)
+
+
+
+ —
+
+
Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :refund [String] The type of refund to perform:
begin
+ account_update={
+ first_name:"Aaron",
+ last_name:"Du Monde",
+ }
+ account=@client.update_account(
+ account_id:account_id,
+ body:account_update
+ )
+ puts"Updated Account #{account}"
+rescueRecurly::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.
begin
+ acquisition_update={
+ campaign:"podcast-marketing",
+ channel:"social_media",
+ subchannel:"twitter",
+ cost:{
+ currency:"USD",
+ amount:0.50
+ }
+ }
+ acquisition=@client.update_account_acquisition(
+ account_id:account_id,
+ body:acquisition_update
+ )
+ puts"Updated AccountAcqusition #{acquisition}"
+rescueRecurly::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.
begin
+ billing_update={
+ first_name:"Aaron",
+ last_name:"Du Monde",
+ }
+ billing=@client.update_billing_info(
+ account_id:account_id,
+ body:billing_update
+ )
+ puts"Updated BillingInfo #{billing}"
+rescueRecurly::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.
begin
+ coupon_update={
+ name:"New Coupon Name"
+ }
+ coupon=@client.update_coupon(coupon_id:coupon_id,body:coupon_update)
+ puts"Updated Coupon #{coupon}"
+rescueRecurly::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.
begin
+ invoice_update={
+ customer_notes:"New Notes",
+ terms_and_conditions:"New Terms and Conditions"
+ }
+ invoice=@client.update_invoice(invoice_id:invoice_id,body:invoice_update)
+ puts"Updated invoice #{invoice}"
+rescueRecurly::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.
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}"
+rescueRecurly::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.
begin
+ plan_update={
+ name:"Monthly Kombucha Subscription"
+ }
+ plan=@client.update_plan(plan_id:plan_id,body:plan_update)
+ puts"Updated plan #{plan}"
+rescueRecurly::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.
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}"
+rescueRecurly::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.
begin
+ address_update={
+ first_name:"Aaron",
+ last_name:"Du Monde",
+ postal_code:"70130"
+ }
+ address=@client.update_shipping_address(
+ account_id:account_id,
+ shipping_address_id:shipping_address_id,
+ body:address_update
+ )
+ puts"Updated ShippingAddress #{address}"
+rescueRecurly::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.
begin
+ subscription_update={
+ customer_notes:"New Notes",
+ terms_and_conditions:"New ToC"
+ }
+ subscription=@client.update_subscription(
+ subscription_id:subscription_id,
+ body:subscription_update
+ )
+ puts"Modified Subscription #{subscription}"
+rescueRecurly::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.
begin
+ transaction=@client.verify_billing_info(account_id:account_id)
+ puts"Got Transaction #{transaction}"
+rescueRecurly::Errors::NotFoundError
+ # If the resource was not found, you may want to alert the user or
+# just return nil
+puts"Resource Not Found"
+end
+
+
+
Parameters:
+
+
+
+
+ account_id
+
+
+ (String)
+
+
+
+ —
+
+
Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
+
+
+
+
+
+
+ params
+
+
+ (Hash)
+
+
+
+ —
+
+
Optional query string parameters: :body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of Requests::BillingInfoVerify
begin
+ invoice=@client.void_invoice(invoice_id:invoice_id)
+ puts"Voided invoice #{invoice}"
+rescueRecurly::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.
When the response does not have a JSON body, this determines the appropriate Error class based on the response code. This may occur when a load balancer returns an error before it reaches Recurly's API.
TODO: Instead of inferring this type from the `object` attribute. We should instead “register” the response type in the client/operations code. The `get`, `post`, etc methods could explicitly state their response types.
Enumerates each item on the server. Each item is yielded to the block presenting the effect of a continuous stream of items. In reality, the pager is fetching blocks of data (pages) under the hood. This method yields a given block with the next item to process.
# File 'lib/recurly/pager.rb', line 74
+
+defeach(&block)
+ ifblock_given?
+ item_enumerator.each(&block)
+ else
+ item_enumerator
+ end
+end
+
+
+
+
+
+
+
+
+ #each_page(&block) ⇒ Object
+
+
+
+
+
+
+
+
+
Enumerates each “page” from the server. This method yields a given block with the array of items in the page `data` and the page number the pagination is on `page_num` which is 0-indexed.
+
+
+
+
+
+
+
+
Examples:
+
+
+
plans=client.list_plans()
+plans.each_pagedo|data|
+ data.eachdo|plan|
+ puts"Plan: #{plan.id}"
+ end
+end
# File 'lib/recurly/pager.rb', line 51
+
+defeach_page(&block)
+ ifblock_given?
+ page_enumerator.each(&block)
+ else
+ page_enumerator
+ end
+end
+
+
+
+
+
+
+
+
+ #first ⇒ Object
+
+
+
+
+
+
+
+
+
Performs a request with the pager `limit` set to 1 and only returns the first result in the response.
+
+
+
+
+
+
+
+
+
+
+
+
+
+15
+16
+17
+18
+19
+20
+21
+22
+23
+
+
+
# File 'lib/recurly/pager.rb', line 15
+
+deffirst
+ # Modify the @next url to set the :limit to 1
+original_next=@next
+ @next=@path
+ fetch_next!(@options.merge(params:@options.fetch(:params,{}).merge({limit:1})))
+ # Restore the @next url to the original
+@next=original_next
+ @data.first
+end
+
+
+
+
+
+
+
+
+ #has_more? ⇒ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+
+
+
+
+
+
+
+
+
+
+82
+83
+84
+
+
+
# File 'lib/recurly/pager.rb', line 82
+
+defhas_more?
+ !!@has_more
+end
+
+
+
+
+
+
+
+
+ #requires_client? ⇒ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+
+
+
+
+
+
+
+
+
+
+86
+87
+88
+
+
+
# File 'lib/recurly/pager.rb', line 86
+
+defrequires_client?
+ true
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Request.html b/Recurly/Request.html
new file mode 100644
index 000000000..bbe6594ac
--- /dev/null
+++ b/Recurly/Request.html
@@ -0,0 +1,388 @@
+
+
+
+
+
+
+ Class: Recurly::Request
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
# File 'lib/recurly/requests/account_create.rb', line 15
+
+define_attribute:address,:Address
+
+
+
+
+
+
+
+
+
+
+ #bill_to ⇒ String
+
+
+
+
+
+
+
+
+
Returns An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 19
+
+define_attribute:bill_to,String
# File 'lib/recurly/requests/account_create.rb', line 23
+
+define_attribute:billing_info,:BillingInfoCreate
+
+
+
+
+
+
+
+
+
+
+ #cc_emails ⇒ String
+
+
+
+
+
+
+
+
+
Returns Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 27
+
+define_attribute:cc_emails,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The unique identifier of the account. This cannot be changed once the account is created.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The unique identifier of the account. This cannot be changed once the account is created.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 31
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #company ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 35
+
+define_attribute:company,String
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 39
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 43
+
+define_attribute:dunning_campaign_id,String
+
+
+
+
+
+
+
+
+
+
+ #email ⇒ String
+
+
+
+
+
+
+
+
+
Returns The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 47
+
+define_attribute:email,String
+
+
+
+
+
+
+
+
+
+
+ #exemption_certificate ⇒ String
+
+
+
+
+
+
+
+
+
Returns The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 51
+
+define_attribute:exemption_certificate,String
# File 'lib/recurly/requests/account_create.rb', line 55
+
+define_attribute:external_accounts,Array,{:item_type=>:ExternalAccountCreate}
+
+
+
+
+
+
+
+
+
+
+ #first_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 59
+
+define_attribute:first_name,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_template_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 63
+
+define_attribute:invoice_template_id,String
+
+
+
+
+
+
+
+
+
+
+ #last_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 67
+
+define_attribute:last_name,String
+
+
+
+
+
+
+
+
+
+
+ #parent_account_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 71
+
+define_attribute:parent_account_code,String
+
+
+
+
+
+
+
+
+
+
+ #parent_account_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 75
+
+define_attribute:parent_account_id,String
+
+
+
+
+
+
+
+
+
+
+ #preferred_locale ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 79
+
+define_attribute:preferred_locale,String
# File 'lib/recurly/requests/account_create.rb', line 87
+
+define_attribute:shipping_addresses,Array,{:item_type=>:ShippingAddressCreate}
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 91
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #transaction_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 95
+
+define_attribute:transaction_type,String
+
+
+
+
+
+
+
+
+
+
+ #username ⇒ String
+
+
+
+
+
+
+
+
+
Returns A secondary value for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A secondary value for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 99
+
+define_attribute:username,String
+
+
+
+
+
+
+
+
+
+
+ #vat_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/requests/account_create.rb', line 103
+
+define_attribute:vat_number,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/AccountPurchase.html b/Recurly/Requests/AccountPurchase.html
new file mode 100644
index 000000000..62c7f615d
--- /dev/null
+++ b/Recurly/Requests/AccountPurchase.html
@@ -0,0 +1,2071 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::AccountPurchase
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
# File 'lib/recurly/requests/account_purchase.rb', line 15
+
+define_attribute:address,:Address
+
+
+
+
+
+
+
+
+
+
+ #bill_to ⇒ String
+
+
+
+
+
+
+
+
+
Returns An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 19
+
+define_attribute:bill_to,String
# File 'lib/recurly/requests/account_purchase.rb', line 23
+
+define_attribute:billing_info,:BillingInfoCreate
+
+
+
+
+
+
+
+
+
+
+ #cc_emails ⇒ String
+
+
+
+
+
+
+
+
+
Returns Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 27
+
+define_attribute:cc_emails,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The unique identifier of the account. This cannot be changed once the account is created.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The unique identifier of the account. This cannot be changed once the account is created.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 31
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #company ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 35
+
+define_attribute:company,String
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 39
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 43
+
+define_attribute:dunning_campaign_id,String
+
+
+
+
+
+
+
+
+
+
+ #email ⇒ String
+
+
+
+
+
+
+
+
+
Returns The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 47
+
+define_attribute:email,String
+
+
+
+
+
+
+
+
+
+
+ #exemption_certificate ⇒ String
+
+
+
+
+
+
+
+
+
Returns The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 51
+
+define_attribute:exemption_certificate,String
+
+
+
+
+
+
+
+
+
+
+ #first_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 55
+
+define_attribute:first_name,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional, but if present allows an existing account to be used and updated as part of the purchase.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional, but if present allows an existing account to be used and updated as part of the purchase.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 59
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_template_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 63
+
+define_attribute:invoice_template_id,String
+
+
+
+
+
+
+
+
+
+
+ #last_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 67
+
+define_attribute:last_name,String
+
+
+
+
+
+
+
+
+
+
+ #parent_account_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 71
+
+define_attribute:parent_account_code,String
+
+
+
+
+
+
+
+
+
+
+ #parent_account_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 75
+
+define_attribute:parent_account_id,String
+
+
+
+
+
+
+
+
+
+
+ #preferred_locale ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 79
+
+define_attribute:preferred_locale,String
# File 'lib/recurly/requests/account_purchase.rb', line 83
+
+define_attribute:preferred_time_zone,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 87
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #transaction_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 91
+
+define_attribute:transaction_type,String
+
+
+
+
+
+
+
+
+
+
+ #username ⇒ String
+
+
+
+
+
+
+
+
+
Returns A secondary value for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A secondary value for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 95
+
+define_attribute:username,String
+
+
+
+
+
+
+
+
+
+
+ #vat_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/requests/account_purchase.rb', line 99
+
+define_attribute:vat_number,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/AccountReference.html b/Recurly/Requests/AccountReference.html
new file mode 100644
index 000000000..e179c497b
--- /dev/null
+++ b/Recurly/Requests/AccountReference.html
@@ -0,0 +1,343 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::AccountReference
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
# File 'lib/recurly/requests/account_update.rb', line 11
+
+define_attribute:address,:Address
+
+
+
+
+
+
+
+
+
+
+ #bill_to ⇒ String
+
+
+
+
+
+
+
+
+
Returns An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 15
+
+define_attribute:bill_to,String
# File 'lib/recurly/requests/account_update.rb', line 19
+
+define_attribute:billing_info,:BillingInfoCreate
+
+
+
+
+
+
+
+
+
+
+ #cc_emails ⇒ String
+
+
+
+
+
+
+
+
+
Returns Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 23
+
+define_attribute:cc_emails,String
+
+
+
+
+
+
+
+
+
+
+ #company ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 27
+
+define_attribute:company,String
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 31
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 35
+
+define_attribute:dunning_campaign_id,String
+
+
+
+
+
+
+
+
+
+
+ #email ⇒ String
+
+
+
+
+
+
+
+
+
Returns The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 39
+
+define_attribute:email,String
+
+
+
+
+
+
+
+
+
+
+ #exemption_certificate ⇒ String
+
+
+
+
+
+
+
+
+
Returns The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 43
+
+define_attribute:exemption_certificate,String
+
+
+
+
+
+
+
+
+
+
+ #first_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 47
+
+define_attribute:first_name,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_template_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 51
+
+define_attribute:invoice_template_id,String
+
+
+
+
+
+
+
+
+
+
+ #last_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 55
+
+define_attribute:last_name,String
+
+
+
+
+
+
+
+
+
+
+ #parent_account_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 59
+
+define_attribute:parent_account_code,String
+
+
+
+
+
+
+
+
+
+
+ #parent_account_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 63
+
+define_attribute:parent_account_id,String
+
+
+
+
+
+
+
+
+
+
+ #preferred_locale ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 67
+
+define_attribute:preferred_locale,String
# File 'lib/recurly/requests/account_update.rb', line 71
+
+define_attribute:preferred_time_zone,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 75
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #transaction_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 79
+
+define_attribute:transaction_type,String
+
+
+
+
+
+
+
+
+
+
+ #username ⇒ String
+
+
+
+
+
+
+
+
+
Returns A secondary value for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A secondary value for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 83
+
+define_attribute:username,String
+
+
+
+
+
+
+
+
+
+
+ #vat_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/requests/account_update.rb', line 87
+
+define_attribute:vat_number,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/AddOnCreate.html b/Recurly/Requests/AddOnCreate.html
new file mode 100644
index 000000000..013112103
--- /dev/null
+++ b/Recurly/Requests/AddOnCreate.html
@@ -0,0 +1,2211 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::AddOnCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 11
+
+define_attribute:accounting_code,String
+
+
+
+
+
+
+
+
+
+
+ #add_on_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Whether the add-on type is fixed, or usage-based.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Whether the add-on type is fixed, or usage-based.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 15
+
+define_attribute:add_on_type,String
# File 'lib/recurly/requests/add_on_create.rb', line 23
+
+define_attribute:avalara_transaction_type,Integer
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The unique identifier for the add-on within its plan. If `item_code`/`item_id` is part of the request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The unique identifier for the add-on within its plan. If `item_code`/`item_id` is part of the request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 27
+
+define_attribute:code,String
Returns * If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent. * Must be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent. * Must be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
+
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 31
+
+define_attribute:currencies,Array,{:item_type=>:AddOnPricing}
+
+
+
+
+
+
+
+
+
+
+ #default_quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Default quantity for the hosted pages.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Default quantity for the hosted pages.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 35
+
+define_attribute:default_quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #display_quantity ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Determines if the quantity field is displayed on the hosted pages for the add-on.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Determines if the quantity field is displayed on the hosted pages for the add-on.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 39
+
+define_attribute:display_quantity,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #item_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique code to identify an item. Available when the `Credit Invoices` feature are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique code to identify an item. Available when the `Credit Invoices` feature are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 43
+
+define_attribute:item_code,String
+
+
+
+
+
+
+
+
+
+
+ #item_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns System-generated unique identifier for an item. Available when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
System-generated unique identifier for an item. Available when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 47
+
+define_attribute:item_id,String
+
+
+
+
+
+
+
+
+
+
+ #measured_unit_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 51
+
+define_attribute:measured_unit_id,String
+
+
+
+
+
+
+
+
+
+
+ #measured_unit_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 55
+
+define_attribute:measured_unit_name,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `name` must be absent. If `item_code`/`item_id` is not present `name` is required.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `name` must be absent. If `item_code`/`item_id` is not present `name` is required.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 59
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #optional ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 63
+
+define_attribute:optional,:Boolean
Returns Array of objects which must have at least one set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
Array of objects which must have at least one set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 67
+
+define_attribute:percentage_tiers,Array,{:item_type=>:PercentageTiersByCurrency}
+
+
+
+
+
+
+
+
+
+
+ #plan_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Plan ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Plan ID
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 71
+
+define_attribute:plan_id,String
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 75
+
+define_attribute:revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 79
+
+define_attribute:tax_code,String
Returns If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier without an `ending_quantity` value which represents the final tier.
If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier without an `ending_quantity` value which represents the final tier.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 87
+
+define_attribute:tiers,Array,{:item_type=>:Tier}
+
+
+
+
+
+
+
+
+
+
+ #usage_calculation_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 91
+
+define_attribute:usage_calculation_type,String
+
+
+
+
+
+
+
+
+
+
+ #usage_percentage ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 95
+
+define_attribute:usage_percentage,Float
+
+
+
+
+
+
+
+
+
+
+ #usage_timeframe ⇒ String
+
+
+
+
+
+
+
+
+
Returns The time at which usage totals are reset for billing purposes. Allows for `tiered` add-ons to accumulate usage over the course of multiple billing periods.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The time at which usage totals are reset for billing purposes. Allows for `tiered` add-ons to accumulate usage over the course of multiple billing periods.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/requests/add_on_create.rb', line 99
+
+define_attribute:usage_timeframe,String
# File 'lib/recurly/requests/add_on_pricing.rb', line 11
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/add_on_pricing.rb', line 15
+
+define_attribute:tax_inclusive,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/add_on_pricing.rb', line 19
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/add_on_pricing.rb', line 23
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/AddOnUpdate.html b/Recurly/Requests/AddOnUpdate.html
new file mode 100644
index 000000000..784d01394
--- /dev/null
+++ b/Recurly/Requests/AddOnUpdate.html
@@ -0,0 +1,1705 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::AddOnUpdate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If an `Item` is associated to the `AddOn` then `accounting code` must be absent.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If an `Item` is associated to the `AddOn` then `accounting code` must be absent.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 11
+
+define_attribute:accounting_code,String
Returns If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then currencies must be absent. Must also be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then currencies must be absent. Must also be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 27
+
+define_attribute:currencies,Array,{:item_type=>:AddOnPricing}
+
+
+
+
+
+
+
+
+
+
+ #default_quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Default quantity for the hosted pages.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Default quantity for the hosted pages.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 31
+
+define_attribute:default_quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #display_quantity ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Determines if the quantity field is displayed on the hosted pages for the add-on.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Determines if the quantity field is displayed on the hosted pages for the add-on.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 35
+
+define_attribute:display_quantity,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Add-on ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Add-on ID
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 39
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #measured_unit_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 43
+
+define_attribute:measured_unit_id,String
+
+
+
+
+
+
+
+
+
+
+ #measured_unit_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 47
+
+define_attribute:measured_unit_name,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns Describes your add-on and will appear in subscribers' invoices. If an `Item` is associated to the `AddOn` then `name` must be absent.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Describes your add-on and will appear in subscribers' invoices. If an `Item` is associated to the `AddOn` then `name` must be absent.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 51
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #optional ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 55
+
+define_attribute:optional,:Boolean
Returns `percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
`percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 59
+
+define_attribute:percentage_tiers,Array,{:item_type=>:PercentageTiersByCurrency}
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 63
+
+define_attribute:revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If an `Item` is associated to the `AddOn` then `tax code` must be absent.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If an `Item` is associated to the `AddOn` then `tax code` must be absent.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 67
+
+define_attribute:tax_code,String
Returns If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier without an `ending_quantity` value which represents the final tier.
If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier without an `ending_quantity` value which represents the final tier.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 71
+
+define_attribute:tiers,Array,{:item_type=>:Tier}
+
+
+
+
+
+
+
+
+
+
+ #usage_calculation_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 75
+
+define_attribute:usage_calculation_type,String
+
+
+
+
+
+
+
+
+
+
+ #usage_percentage ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/add_on_update.rb', line 79
+
+define_attribute:usage_percentage,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/Address.html b/Recurly/Requests/Address.html
new file mode 100644
index 000000000..24f3e77e9
--- /dev/null
+++ b/Recurly/Requests/Address.html
@@ -0,0 +1,781 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::Address
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information.
# File 'lib/recurly/requests/billing_info_create.rb', line 23
+
+define_attribute:amazon_billing_agreement_id,String
+
+
+
+
+
+
+
+
+
+
+ #backup_payment_method ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 27
+
+define_attribute:backup_payment_method,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #card_type ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 31
+
+define_attribute:card_type,String
+
+
+
+
+
+
+
+
+
+
+ #company ⇒ String
+
+
+
+
+
+
+
+
+
Returns Company name.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Company name
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 35
+
+define_attribute:company,String
+
+
+
+
+
+
+
+
+
+
+ #currency ⇒ String
+
+
+
+
+
+
+
+
+
Returns 3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 39
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #cvv ⇒ String
+
+
+
+
+
+
+
+
+
Returns *STRONGLY RECOMMENDED*.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
*STRONGLY RECOMMENDED*
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 43
+
+define_attribute:cvv,String
+
+
+
+
+
+
+
+
+
+
+ #external_hpp_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Use for Adyen HPP billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Use for Adyen HPP billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 47
+
+define_attribute:external_hpp_type,String
+
+
+
+
+
+
+
+
+
+
+ #first_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns First name.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
First name
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 51
+
+define_attribute:first_name,String
+
+
+
+
+
+
+
+
+
+
+ #fraud_session_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Fraud Session ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Fraud Session ID
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 55
+
+define_attribute:fraud_session_id,String
+
+
+
+
+
+
+
+
+
+
+ #gateway_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 59
+
+define_attribute:gateway_code,String
+
+
+
+
+
+
+
+
+
+
+ #gateway_token ⇒ String
+
+
+
+
+
+
+
+
+
Returns A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 63
+
+define_attribute:gateway_token,String
+
+
+
+
+
+
+
+
+
+
+ #iban ⇒ String
+
+
+
+
+
+
+
+
+
Returns The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 67
+
+define_attribute:iban,String
+
+
+
+
+
+
+
+
+
+
+ #ip_address ⇒ String
+
+
+
+
+
+
+
+
+
Returns *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
*STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 71
+
+define_attribute:ip_address,String
+
+
+
+
+
+
+
+
+
+
+ #last_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns Last name.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Last name
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 75
+
+define_attribute:last_name,String
+
+
+
+
+
+
+
+
+
+
+ #month ⇒ String
+
+
+
+
+
+
+
+
+
Returns Expiration month.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Expiration month
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 79
+
+define_attribute:month,String
+
+
+
+
+
+
+
+
+
+
+ #name_on_account ⇒ String
+
+
+
+
+
+
+
+
+
Returns The name associated with the bank account (ACH, SEPA, Bacs only).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The name associated with the bank account (ACH, SEPA, Bacs only)
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 83
+
+define_attribute:name_on_account,String
+
+
+
+
+
+
+
+
+
+
+ #number ⇒ String
+
+
+
+
+
+
+
+
+
Returns Credit card number, spaces and dashes are accepted.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Credit card number, spaces and dashes are accepted.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 87
+
+define_attribute:number,String
Returns Use for Online Banking billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Use for Online Banking billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 91
+
+define_attribute:online_banking_payment_type,String
# File 'lib/recurly/requests/billing_info_create.rb', line 95
+
+define_attribute:paypal_billing_agreement_id,String
+
+
+
+
+
+
+
+
+
+
+ #primary_payment_method ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 99
+
+define_attribute:primary_payment_method,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #routing_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns The bank's rounting number. (ACH only).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The bank's rounting number. (ACH only)
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 103
+
+define_attribute:routing_number,String
+
+
+
+
+
+
+
+
+
+
+ #sort_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 107
+
+define_attribute:sort_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_identifier ⇒ String
+
+
+
+
+
+
+
+
+
Returns Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF/CNPJ (Brazil) and CUIT (Argentina). CPF, CNPJ and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF/CNPJ (Brazil) and CUIT (Argentina). CPF, CNPJ and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 111
+
+define_attribute:tax_identifier,String
+
+
+
+
+
+
+
+
+
+
+ #tax_identifier_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns This field and a value of `cpf`, `cnpj` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This field and a value of `cpf`, `cnpj` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.
+
+
+
+
+
+
+
+
+
+
+
+
+115
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 115
+
+define_attribute:tax_identifier_type,String
# File 'lib/recurly/requests/billing_info_create.rb', line 123
+
+define_attribute:token_id,String
+
+
+
+
+
+
+
+
+
+
+ #transaction_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+127
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 127
+
+define_attribute:transaction_type,String
+
+
+
+
+
+
+
+
+
+
+ #type ⇒ String
+
+
+
+
+
+
+
+
+
Returns The payment method type for a non-credit card based billing info. `bacs` and `becs` are the only accepted values.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The payment method type for a non-credit card based billing info. `bacs` and `becs` are the only accepted values.
+
+
+
+
+
+
+
+
+
+
+
+
+131
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 131
+
+define_attribute:type,String
+
+
+
+
+
+
+
+
+
+
+ #vat_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns VAT number.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
VAT number
+
+
+
+
+
+
+
+
+
+
+
+
+135
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 135
+
+define_attribute:vat_number,String
+
+
+
+
+
+
+
+
+
+
+ #year ⇒ String
+
+
+
+
+
+
+
+
+
Returns Expiration year.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Expiration year
+
+
+
+
+
+
+
+
+
+
+
+
+139
+
+
+
# File 'lib/recurly/requests/billing_info_create.rb', line 139
+
+define_attribute:year,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/BillingInfoVerify.html b/Recurly/Requests/BillingInfoVerify.html
new file mode 100644
index 000000000..79e589e54
--- /dev/null
+++ b/Recurly/Requests/BillingInfoVerify.html
@@ -0,0 +1,277 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::BillingInfoVerify
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
If `duration` is “temporal” than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
If `duration` is “temporal” than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
Returns To apply coupon to Items in your Catalog, include a list of `item_codes` in the request that the coupon will apply to. Or set value to true to apply to all Items in your Catalog. The following values are not permitted when `applies_to_all_items` is included: `free_trial_amount` and `free_trial_unit`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
To apply coupon to Items in your Catalog, include a list of `item_codes` in the request that the coupon will apply to. Or set value to true to apply to all Items in your Catalog. The following values are not permitted when `applies_to_all_items` is included: `free_trial_amount` and `free_trial_unit`.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 11
+
+define_attribute:applies_to_all_items,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #applies_to_all_plans ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns The coupon is valid for all plans if true. If false then `plans` will list the applicable plans.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The coupon is valid for all plans if true. If false then `plans` will list the applicable plans.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 15
+
+define_attribute:applies_to_all_plans,:Boolean
Returns The coupon is valid for one-time, non-plan charges if true.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The coupon is valid for one-time, non-plan charges if true.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 19
+
+define_attribute:applies_to_non_plan_charges,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The code the customer enters to redeem the coupon.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The code the customer enters to redeem the coupon.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 23
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #coupon_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Whether the coupon is “single_code” or “bulk”. Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Whether the coupon is “single_code” or “bulk”. Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 27
+
+define_attribute:coupon_type,String
Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 31
+
+define_attribute:currencies,Array,{:item_type=>:CouponPricing}
+
+
+
+
+
+
+
+
+
+
+ #discount_percent ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns The percent of the price discounted by the coupon. Required if `discount_type` is `percent`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
The percent of the price discounted by the coupon. Required if `discount_type` is `percent`.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 35
+
+define_attribute:discount_percent,Integer
+
+
+
+
+
+
+
+
+
+
+ #discount_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns The type of discount provided by the coupon (how the amount discounted is calculated).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The type of discount provided by the coupon (how the amount discounted is calculated)
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 39
+
+define_attribute:discount_type,String
+
+
+
+
+
+
+
+
+
+
+ #duration ⇒ String
+
+
+
+
+
+
+
+
+
Returns This field does not apply when the discount_type is `free_trial`. - “single_use” coupons applies to the first invoice only. - “temporal” coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes. - “forever” coupons will apply to invoices forever.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This field does not apply when the discount_type is `free_trial`. - “single_use” coupons applies to the first invoice only. - “temporal” coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes. - “forever” coupons will apply to invoices forever.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 43
+
+define_attribute:duration,String
+
+
+
+
+
+
+
+
+
+
+ #free_trial_amount ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 47
+
+define_attribute:free_trial_amount,Integer
+
+
+
+
+
+
+
+
+
+
+ #free_trial_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for. Required if `discount_type` is `free_trial`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for. Required if `discount_type` is `free_trial`.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 51
+
+define_attribute:free_trial_unit,String
+
+
+
+
+
+
+
+
+
+
+ #hosted_description ⇒ String
+
+
+
+
+
+
+
+
+
Returns This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 55
+
+define_attribute:hosted_description,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Description of the coupon on the invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Description of the coupon on the invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 59
+
+define_attribute:invoice_description,String
+
+
+
+
+
+
+
+
+
+
+ #item_codes ⇒ Array[String]
+
+
+
+
+
+
+
+
+
Returns List of item codes to which this coupon applies. Sending `item_codes` is only permitted when `applies_to_all_items` is set to false. The following values are not permitted when `item_codes` is included: `free_trial_amount` and `free_trial_unit`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Array[String])
+
+
+
+ —
+
+
List of item codes to which this coupon applies. Sending `item_codes` is only permitted when `applies_to_all_items` is set to false. The following values are not permitted when `item_codes` is included: `free_trial_amount` and `free_trial_unit`.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 63
+
+define_attribute:item_codes,Array,{:item_type=>String}
+
+
+
+
+
+
+
+
+
+
+ #max_redemptions ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 67
+
+define_attribute:max_redemptions,Integer
Returns Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 71
+
+define_attribute:max_redemptions_per_account,Integer
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The internal name for the coupon.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The internal name for the coupon.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 75
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #plan_codes ⇒ Array[String]
+
+
+
+
+
+
+
+
+
Returns List of plan codes to which this coupon applies. Required if `applies_to_all_plans` is false. Overrides `applies_to_all_plans` when `applies_to_all_plans` is true.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Array[String])
+
+
+
+ —
+
+
List of plan codes to which this coupon applies. Required if `applies_to_all_plans` is false. Overrides `applies_to_all_plans` when `applies_to_all_plans` is true.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 79
+
+define_attribute:plan_codes,Array,{:item_type=>String}
+
+
+
+
+
+
+
+
+
+
+ #redeem_by_date ⇒ String
+
+
+
+
+
+
+
+
+
Returns The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 83
+
+define_attribute:redeem_by_date,String
+
+
+
+
+
+
+
+
+
+
+ #redemption_resource ⇒ String
+
+
+
+
+
+
+
+
+
Returns Whether the discount is for all eligible charges on the account, or only a specific subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Whether the discount is for all eligible charges on the account, or only a specific subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 87
+
+define_attribute:redemption_resource,String
+
+
+
+
+
+
+
+
+
+
+ #temporal_amount ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns If `duration` is “temporal” than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
If `duration` is “temporal” than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 91
+
+define_attribute:temporal_amount,Integer
+
+
+
+
+
+
+
+
+
+
+ #temporal_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns If `duration` is “temporal” than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If `duration` is “temporal” than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 95
+
+define_attribute:temporal_unit,String
+
+
+
+
+
+
+
+
+
+
+ #unique_code_template ⇒ String
+
+
+
+
+
+
+
+
+
Returns On a bulk coupon, the template from which unique coupon codes are generated. - You must start the template with your coupon_code wrapped in single quotes. - Outside of single quotes, use a 9 for a character that you want to be a random number. - Outside of single quotes, use an “x” for a character that you want to be a random letter. - Outside of single quotes, use an * for a character that you want to be a random number or letter. - Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +. For example: “'abc-'****'-def'”.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
On a bulk coupon, the template from which unique coupon codes are generated. - You must start the template with your coupon_code wrapped in single quotes. - Outside of single quotes, use a 9 for a character that you want to be a random number. - Outside of single quotes, use an “x” for a character that you want to be a random letter. - Outside of single quotes, use an * for a character that you want to be a random number or letter. - Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +. For example: “'abc-'****'-def'”
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/requests/coupon_create.rb', line 99
+
+define_attribute:unique_code_template,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/CouponPricing.html b/Recurly/Requests/CouponPricing.html
new file mode 100644
index 000000000..192ebcec8
--- /dev/null
+++ b/Recurly/Requests/CouponPricing.html
@@ -0,0 +1,361 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::CouponPricing
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
Returns This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/coupon_update.rb', line 11
+
+define_attribute:hosted_description,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Description of the coupon on the invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Description of the coupon on the invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/coupon_update.rb', line 15
+
+define_attribute:invoice_description,String
+
+
+
+
+
+
+
+
+
+
+ #max_redemptions ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/coupon_update.rb', line 19
+
+define_attribute:max_redemptions,Integer
Returns Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/coupon_update.rb', line 23
+
+define_attribute:max_redemptions_per_account,Integer
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The internal name for the coupon.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The internal name for the coupon.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/coupon_update.rb', line 27
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #redeem_by_date ⇒ String
+
+
+
+
+
+
+
+
+
Returns The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/coupon_update.rb', line 31
+
+define_attribute:redeem_by_date,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/CustomField.html b/Recurly/Requests/CustomField.html
new file mode 100644
index 000000000..ee2f67e8b
--- /dev/null
+++ b/Recurly/Requests/CustomField.html
@@ -0,0 +1,361 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::CustomField
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
Block of account details for the gifter. This references an existing account_code.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/gift_card_create.rb', line 19
+
+define_attribute:gifter_account,:AccountPurchase
+
+
+
+
+
+
+
+
+
+
+ #product_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The product code or SKU of the gift card product.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The product code or SKU of the gift card product.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/gift_card_create.rb', line 23
+
+define_attribute:product_code,String
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/gift_card_create.rb', line 27
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/GiftCardDeliveryCreate.html b/Recurly/Requests/GiftCardDeliveryCreate.html
new file mode 100644
index 000000000..10b2d7944
--- /dev/null
+++ b/Recurly/Requests/GiftCardDeliveryCreate.html
@@ -0,0 +1,865 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::GiftCardDeliveryCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 11
+
+define_attribute:deliver_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #email_address ⇒ String
+
+
+
+
+
+
+
+
+
Returns The email address of the recipient. Required if `method` is `email`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The email address of the recipient. Required if `method` is `email`.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 15
+
+define_attribute:email_address,String
+
+
+
+
+
+
+
+
+
+
+ #first_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The first name of the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The first name of the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 19
+
+define_attribute:first_name,String
+
+
+
+
+
+
+
+
+
+
+ #gifter_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The name of the gifter for the purpose of a message displayed to the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The name of the gifter for the purpose of a message displayed to the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 23
+
+define_attribute:gifter_name,String
+
+
+
+
+
+
+
+
+
+
+ #last_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The last name of the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The last name of the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 27
+
+define_attribute:last_name,String
+
+
+
+
+
+
+
+
+
+
+ #method ⇒ String
+
+
+
+
+
+
+
+
+
Returns Whether the delivery method is email or postal service.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Whether the delivery method is email or postal service.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 31
+
+define_attribute:method,String
+
+
+
+
+
+
+
+
+
+
+ #personal_message ⇒ String
+
+
+
+
+
+
+
+
+
Returns The personal message from the gifter to the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The personal message from the gifter to the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 35
+
+define_attribute:personal_message,String
Returns The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/invoice_collect.rb', line 11
+
+define_attribute:billing_info_id,String
Returns A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/invoice_collect.rb', line 15
+
+define_attribute:three_d_secure_action_result_token_id,String
+
+
+
+
+
+
+
+
+
+
+ #transaction_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/invoice_collect.rb', line 19
+
+define_attribute:transaction_type,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/InvoiceCreate.html b/Recurly/Requests/InvoiceCreate.html
new file mode 100644
index 000000000..7cfe0e512
--- /dev/null
+++ b/Recurly/Requests/InvoiceCreate.html
@@ -0,0 +1,865 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::InvoiceCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own.
Returns This will default to the Customer Notes text specified on the Invoice Settings for charge invoices. Specify custom notes to add or override Customer Notes on charge invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This will default to the Customer Notes text specified on the Invoice Settings for charge invoices. Specify custom notes to add or override Customer Notes on charge invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/invoice_create.rb', line 11
+
+define_attribute:charge_customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #collection_method ⇒ String
+
+
+
+
+
+
+
+
+
Returns An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/invoice_create.rb', line 15
+
+define_attribute:collection_method,String
+
+
+
+
+
+
+
+
+
+
+ #credit_customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns This will default to the Customer Notes text specified on the Invoice Settings for credit invoices. Specify customer notes to add or override Customer Notes on credit invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This will default to the Customer Notes text specified on the Invoice Settings for credit invoices. Specify customer notes to add or override Customer Notes on credit invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/invoice_create.rb', line 19
+
+define_attribute:credit_customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #currency ⇒ String
+
+
+
+
+
+
+
+
+
Returns 3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/invoice_create.rb', line 23
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #net_terms ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/invoice_create.rb', line 27
+
+define_attribute:net_terms,Integer
+
+
+
+
+
+
+
+
+
+
+ #po_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/invoice_create.rb', line 31
+
+define_attribute:po_number,String
+
+
+
+
+
+
+
+
+
+
+ #terms_and_conditions ⇒ String
+
+
+
+
+
+
+
+
+
Returns This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/invoice_create.rb', line 35
+
+define_attribute:terms_and_conditions,String
Returns VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/invoice_create.rb', line 39
+
+define_attribute:vat_reverse_charge_notes,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/InvoiceRefund.html b/Recurly/Requests/InvoiceRefund.html
new file mode 100644
index 000000000..f1bce62a4
--- /dev/null
+++ b/Recurly/Requests/InvoiceRefund.html
@@ -0,0 +1,697 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::InvoiceRefund
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Indicates how the invoice should be refunded when both a credit and transaction are present on the invoice: - `transaction_first` – Refunds the transaction first, then any amount is issued as credit back to the account.
Returns The amount to be refunded. The amount will be split between the line items. If no amount is specified, it will default to refunding the total refundable amount on the invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The amount to be refunded. The amount will be split between the line items. If no amount is specified, it will default to refunding the total refundable amount on the invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/invoice_refund.rb', line 11
+
+define_attribute:amount,Float
+
+
+
+
+
+
+
+
+
+
+ #credit_customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used as the Customer Notes on the credit invoice. This field can only be include when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used as the Customer Notes on the credit invoice. This field can only be include when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/invoice_refund.rb', line 15
+
+define_attribute:credit_customer_notes,String
Returns Indicates that the refund was settled outside of Recurly, and a manual transaction should be created to track it in Recurly. Required when: - refunding a manually collected charge invoice, and `refund_method` is not `all_credit` - refunding a credit invoice that refunded manually collecting invoices - refunding a credit invoice for a partial amount This field can only be included when the Credit Invoices feature is enabled.
Indicates that the refund was settled outside of Recurly, and a manual transaction should be created to track it in Recurly. Required when: - refunding a manually collected charge invoice, and `refund_method` is not `all_credit` - refunding a credit invoice that refunded manually collecting invoices - refunding a credit invoice for a partial amount This field can only be included when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/invoice_refund.rb', line 19
+
+define_attribute:external_refund,:ExternalRefund
The line items to be refunded. This is required when `type=line_items`.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/invoice_refund.rb', line 23
+
+define_attribute:line_items,Array,{:item_type=>:LineItemRefund}
+
+
+
+
+
+
+
+
+
+
+ #refund_method ⇒ String
+
+
+
+
+
+
+
+
+
Returns Indicates how the invoice should be refunded when both a credit and transaction are present on the invoice: - `transaction_first` – Refunds the transaction first, then any amount is issued as credit back to the account. Default value when Credit Invoices feature is enabled. - `credit_first` – Issues credit back to the account first, then refunds any remaining amount back to the transaction. Default value when Credit Invoices feature is not enabled. - `all_credit` – Issues credit to the account for the entire amount of the refund. Only available when the Credit Invoices feature is enabled. - `all_transaction` – Refunds the entire amount back to transactions, using transactions from previous invoices if necessary. Only available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Indicates how the invoice should be refunded when both a credit and transaction are present on the invoice: - `transaction_first` – Refunds the transaction first, then any amount is issued as credit back to the account. Default value when Credit Invoices feature is enabled. - `credit_first` – Issues credit back to the account first, then refunds any remaining amount back to the transaction. Default value when Credit Invoices feature is not enabled. - `all_credit` – Issues credit to the account for the entire amount of the refund. Only available when the Credit Invoices feature is enabled. - `all_transaction` – Refunds the entire amount back to transactions, using transactions from previous invoices if necessary. Only available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/invoice_refund.rb', line 27
+
+define_attribute:refund_method,String
+
+
+
+
+
+
+
+
+
+
+ #type ⇒ String
+
+
+
+
+
+
+
+
+
Returns The type of refund. Amount and line items cannot both be specified in the request.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The type of refund. Amount and line items cannot both be specified in the request.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/invoice_refund.rb', line 31
+
+define_attribute:type,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/InvoiceUpdate.html b/Recurly/Requests/InvoiceUpdate.html
new file mode 100644
index 000000000..7119e4b6e
--- /dev/null
+++ b/Recurly/Requests/InvoiceUpdate.html
@@ -0,0 +1,688 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::InvoiceUpdate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/invoice_update.rb', line 11
+
+define_attribute:address,:InvoiceAddress
+
+
+
+
+
+
+
+
+
+
+ #customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns Customer notes are an optional note field.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Customer notes are an optional note field.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/invoice_update.rb', line 15
+
+define_attribute:customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #net_terms ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. Changing Net terms changes due_on, and the invoice could move between past due and pending.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Integer representing the number of days after an invoice's creation that the invoice will become past due. Changing Net terms changes due_on, and the invoice could move between past due and pending.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/invoice_update.rb', line 19
+
+define_attribute:net_terms,Integer
+
+
+
+
+
+
+
+
+
+
+ #po_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns This identifies the PO number associated with the invoice. Not editable for credit invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This identifies the PO number associated with the invoice. Not editable for credit invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/invoice_update.rb', line 23
+
+define_attribute:po_number,String
+
+
+
+
+
+
+
+
+
+
+ #terms_and_conditions ⇒ String
+
+
+
+
+
+
+
+
+
Returns Terms and conditions are an optional note field. Not editable for credit invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Terms and conditions are an optional note field. Not editable for credit invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/invoice_update.rb', line 27
+
+define_attribute:terms_and_conditions,String
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/item_create.rb', line 31
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional, description.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional, description.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/item_create.rb', line 35
+
+define_attribute:description,String
+
+
+
+
+
+
+
+
+
+
+ #external_sku ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional, stock keeping unit to link the item to other inventory systems.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional, stock keeping unit to link the item to other inventory systems.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/item_create.rb', line 39
+
+define_attribute:external_sku,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/item_create.rb', line 43
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/item_create.rb', line 47
+
+define_attribute:revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/item_create.rb', line 51
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns `true` exempts tax on the item, `false` applies tax on the item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
`true` exempts tax on the item, `false` applies tax on the item.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/item_create.rb', line 55
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/ItemUpdate.html b/Recurly/Requests/ItemUpdate.html
new file mode 100644
index 000000000..5858fddac
--- /dev/null
+++ b/Recurly/Requests/ItemUpdate.html
@@ -0,0 +1,1201 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::ItemUpdate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/item_update.rb', line 31
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional, description.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional, description.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/item_update.rb', line 35
+
+define_attribute:description,String
+
+
+
+
+
+
+
+
+
+
+ #external_sku ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional, stock keeping unit to link the item to other inventory systems.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional, stock keeping unit to link the item to other inventory systems.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/item_update.rb', line 39
+
+define_attribute:external_sku,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/item_update.rb', line 43
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/item_update.rb', line 47
+
+define_attribute:revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/item_update.rb', line 51
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns `true` exempts tax on the item, `false` applies tax on the item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
`true` exempts tax on the item, `false` applies tax on the item.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/item_update.rb', line 55
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/LineItemCreate.html b/Recurly/Requests/LineItemCreate.html
new file mode 100644
index 000000000..19d4db98f
--- /dev/null
+++ b/Recurly/Requests/LineItemCreate.html
@@ -0,0 +1,1873 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::LineItemCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 19
+
+define_attribute:avalara_transaction_type,Integer
+
+
+
+
+
+
+
+
+
+
+ #credit_reason_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 23
+
+define_attribute:credit_reason_code,String
+
+
+
+
+
+
+
+
+
+
+ #currency ⇒ String
+
+
+
+
+
+
+
+
+
Returns 3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 27
+
+define_attribute:currency,String
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 31
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 35
+
+define_attribute:description,String
+
+
+
+
+
+
+
+
+
+
+ #end_date ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If this date is provided, it indicates the end of a time range.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If this date is provided, it indicates the end of a time range.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 39
+
+define_attribute:end_date,DateTime
+
+
+
+
+
+
+
+
+
+
+ #item_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique code to identify an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique code to identify an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 43
+
+define_attribute:item_code,String
+
+
+
+
+
+
+
+
+
+
+ #item_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 47
+
+define_attribute:item_id,String
+
+
+
+
+
+
+
+
+
+
+ #origin ⇒ String
+
+
+
+
+
+
+
+
+
Returns Origin `external_gift_card` is allowed if the Gift Cards feature is enabled on your site and `type` is `credit`. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements. Origin `prepayment` is only allowed if `type` is `charge` and `tax_exempt` is left blank or set to true. This origin creates a charge and opposite credit on the account to be used for future invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Origin `external_gift_card` is allowed if the Gift Cards feature is enabled on your site and `type` is `credit`. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements. Origin `prepayment` is only allowed if `type` is `charge` and `tax_exempt` is left blank or set to true. This origin creates a charge and opposite credit on the account to be used for future invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 51
+
+define_attribute:origin,String
+
+
+
+
+
+
+
+
+
+
+ #product_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional field to track a product code or SKU for the line item. This can be used to later reporting on product purchases. For Vertex tax calculations, this field will be used as the Vertex `product` field. If `item_code`/`item_id` is part of the request then `product_code` must be absent.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional field to track a product code or SKU for the line item. This can be used to later reporting on product purchases. For Vertex tax calculations, this field will be used as the Vertex `product` field. If `item_code`/`item_id` is part of the request then `product_code` must be absent.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 55
+
+define_attribute:product_code,String
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 59
+
+define_attribute:quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 63
+
+define_attribute:revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #start_date ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date. Defaults to the current date-time.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date. Defaults to the current date-time.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 67
+
+define_attribute:start_date,DateTime
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 71
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
`true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 75
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 79
+
+define_attribute:tax_inclusive,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Line item type. If `item_code`/`item_id` is present then `type` should not be present. If `item_code`/`item_id` is not present then `type` is required.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Line item type. If `item_code`/`item_id` is present then `type` should not be present. If `item_code`/`item_id` is not present then `type` is required.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 83
+
+define_attribute:type,String
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`. If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`. If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/requests/line_item_create.rb', line 87
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/LineItemRefund.html b/Recurly/Requests/LineItemRefund.html
new file mode 100644
index 000000000..6a44bb30b
--- /dev/null
+++ b/Recurly/Requests/LineItemRefund.html
@@ -0,0 +1,529 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::LineItemRefund
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/line_item_refund.rb', line 11
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #prorate ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Set to `true` if the line item should be prorated; set to `false` if not. This can only be used on line items that have a start and end date.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Set to `true` if the line item should be prorated; set to `false` if not. This can only be used on line items that have a start and end date.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/line_item_refund.rb', line 15
+
+define_attribute:prorate,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Line item quantity to be refunded.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Line item quantity to be refunded.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/line_item_refund.rb', line 19
+
+define_attribute:quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #quantity_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/line_item_refund.rb', line 23
+
+define_attribute:quantity_decimal,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/MeasuredUnitCreate.html b/Recurly/Requests/MeasuredUnitCreate.html
new file mode 100644
index 000000000..886069e60
--- /dev/null
+++ b/Recurly/Requests/MeasuredUnitCreate.html
@@ -0,0 +1,445 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::MeasuredUnitCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 19
+
+define_attribute:allow_any_item_on_subscriptions,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #auto_renew ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 23
+
+define_attribute:auto_renew,:Boolean
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 43
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional description, not displayed.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional description, not displayed.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 47
+
+define_attribute:description,String
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 51
+
+define_attribute:dunning_campaign_id,String
# File 'lib/recurly/requests/plan_create.rb', line 55
+
+define_attribute:hosted_pages,:PlanHostedPages
+
+
+
+
+
+
+
+
+
+
+ #interval_length ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Length of the plan's billing interval in `interval_unit`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Length of the plan's billing interval in `interval_unit`.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 59
+
+define_attribute:interval_length,Integer
+
+
+
+
+
+
+
+
+
+
+ #interval_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unit for the plan's billing interval.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unit for the plan's billing interval.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 63
+
+define_attribute:interval_unit,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 67
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #pricing_model ⇒ String
+
+
+
+
+
+
+
+
+
Returns A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 71
+
+define_attribute:pricing_model,String
# File 'lib/recurly/requests/plan_create.rb', line 87
+
+define_attribute:setup_fee_revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 91
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns `true` exempts tax on the plan, `false` applies tax on the plan.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
`true` exempts tax on the plan, `false` applies tax on the plan.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 95
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #total_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Automatically terminate plans after a defined number of billing cycles.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Automatically terminate plans after a defined number of billing cycles.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 99
+
+define_attribute:total_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #trial_length ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Length of plan's trial period in `trial_units`. `0` means `no trial`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Length of plan's trial period in `trial_units`. `0` means `no trial`.
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 103
+
+define_attribute:trial_length,Integer
Returns Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 107
+
+define_attribute:trial_requires_billing_info,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #trial_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns Units for the plan's trial period.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Units for the plan's trial period.
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/requests/plan_create.rb', line 111
+
+define_attribute:trial_unit,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/PlanHostedPages.html b/Recurly/Requests/PlanHostedPages.html
new file mode 100644
index 000000000..f0f4fa329
--- /dev/null
+++ b/Recurly/Requests/PlanHostedPages.html
@@ -0,0 +1,529 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::PlanHostedPages
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/plan_pricing.rb', line 11
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #setup_fee ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/plan_pricing.rb', line 15
+
+define_attribute:setup_fee,Float
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/plan_pricing.rb', line 19
+
+define_attribute:tax_inclusive,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns This field should not be sent when the pricing model is 'ramp'.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
This field should not be sent when the pricing model is 'ramp'.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/plan_pricing.rb', line 23
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/PlanRampInterval.html b/Recurly/Requests/PlanRampInterval.html
new file mode 100644
index 000000000..d9eda84a9
--- /dev/null
+++ b/Recurly/Requests/PlanRampInterval.html
@@ -0,0 +1,361 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::PlanRampInterval
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 15
+
+define_attribute:allow_any_item_on_subscriptions,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #auto_renew ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 19
+
+define_attribute:auto_renew,:Boolean
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 39
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional description, not displayed.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional description, not displayed.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 43
+
+define_attribute:description,String
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 47
+
+define_attribute:dunning_campaign_id,String
# File 'lib/recurly/requests/plan_update.rb', line 75
+
+define_attribute:setup_fee_revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 79
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns `true` exempts tax on the plan, `false` applies tax on the plan.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
`true` exempts tax on the plan, `false` applies tax on the plan.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 83
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #total_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Automatically terminate plans after a defined number of billing cycles.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Automatically terminate plans after a defined number of billing cycles.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 87
+
+define_attribute:total_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #trial_length ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Length of plan's trial period in `trial_units`. `0` means `no trial`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Length of plan's trial period in `trial_units`. `0` means `no trial`.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 91
+
+define_attribute:trial_length,Integer
Returns Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 95
+
+define_attribute:trial_requires_billing_info,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #trial_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns Units for the plan's trial period.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Units for the plan's trial period.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/requests/plan_update.rb', line 99
+
+define_attribute:trial_unit,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/Pricing.html b/Recurly/Requests/Pricing.html
new file mode 100644
index 000000000..534b4e5e5
--- /dev/null
+++ b/Recurly/Requests/Pricing.html
@@ -0,0 +1,445 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::Pricing
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 11
+
+define_attribute:account,:AccountPurchase
+
+
+
+
+
+
+
+
+
+
+ #billing_info_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 15
+
+define_attribute:billing_info_id,String
+
+
+
+
+
+
+
+
+
+
+ #collection_method ⇒ String
+
+
+
+
+
+
+
+
+
Returns Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 19
+
+define_attribute:collection_method,String
+
+
+
+
+
+
+
+
+
+
+ #coupon_codes ⇒ Array[String]
+
+
+
+
+
+
+
+
+
Returns A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Array[String])
+
+
+
+ —
+
+
A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 23
+
+define_attribute:coupon_codes,Array,{:item_type=>String}
+
+
+
+
+
+
+
+
+
+
+ #credit_customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns Notes to be put on the credit invoice resulting from credits in the purchase, if any.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Notes to be put on the credit invoice resulting from credits in the purchase, if any.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 27
+
+define_attribute:credit_customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #currency ⇒ String
+
+
+
+
+
+
+
+
+
Returns 3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 31
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns Customer notes.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Customer notes
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 35
+
+define_attribute:customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #gateway_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The default payment gateway identifier to be used for the purchase transaction. This will also be applied as the default for any subscriptions included in the purchase request.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The default payment gateway identifier to be used for the purchase transaction. This will also be applied as the default for any subscriptions included in the purchase request.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 39
+
+define_attribute:gateway_code,String
A list of one time charges or credits to be created with the purchase.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 47
+
+define_attribute:line_items,Array,{:item_type=>:LineItemCreate}
+
+
+
+
+
+
+
+
+
+
+ #net_terms ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 51
+
+define_attribute:net_terms,Integer
+
+
+
+
+
+
+
+
+
+
+ #po_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 55
+
+define_attribute:po_number,String
A list of subscriptions to be created with the purchase.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 63
+
+define_attribute:subscriptions,Array,{:item_type=>:SubscriptionPurchase}
+
+
+
+
+
+
+
+
+
+
+ #terms_and_conditions ⇒ String
+
+
+
+
+
+
+
+
+
Returns Terms and conditions to be put on the purchase invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Terms and conditions to be put on the purchase invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 67
+
+define_attribute:terms_and_conditions,String
+
+
+
+
+
+
+
+
+
+
+ #transaction_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/purchase_create.rb', line 71
+
+define_attribute:transaction_type,String
# File 'lib/recurly/requests/shipping_method_create.rb', line 11
+
+define_attribute:accounting_code,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The internal name used identify the shipping method.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The internal name used identify the shipping method.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/shipping_method_create.rb', line 15
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The name of the shipping method displayed to customers.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The name of the shipping method displayed to customers.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/shipping_method_create.rb', line 19
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/shipping_method_create.rb', line 23
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/ShippingMethodUpdate.html b/Recurly/Requests/ShippingMethodUpdate.html
new file mode 100644
index 000000000..eb1cea440
--- /dev/null
+++ b/Recurly/Requests/ShippingMethodUpdate.html
@@ -0,0 +1,529 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::ShippingMethodUpdate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/shipping_method_update.rb', line 11
+
+define_attribute:accounting_code,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The internal name used identify the shipping method.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The internal name used identify the shipping method.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/shipping_method_update.rb', line 15
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The name of the shipping method displayed to customers.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The name of the shipping method displayed to customers.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/shipping_method_update.rb', line 19
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/shipping_method_update.rb', line 23
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/ShippingPurchase.html b/Recurly/Requests/ShippingPurchase.html
new file mode 100644
index 000000000..971ace8dd
--- /dev/null
+++ b/Recurly/Requests/ShippingPurchase.html
@@ -0,0 +1,436 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::ShippingPurchase
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/shipping_purchase.rb', line 11
+
+define_attribute:address,:ShippingAddressCreate
+
+
+
+
+
+
+
+
+
+
+ #address_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Assign a shipping address from the account's existing shipping addresses. If this and `address` are both present, `address` will take precedence.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Assign a shipping address from the account's existing shipping addresses. If this and `address` are both present, `address` will take precedence.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/shipping_purchase.rb', line 15
+
+define_attribute:address_id,String
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request.
Returns Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 11
+
+define_attribute:add_on_source,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 15
+
+define_attribute:code,String
Returns If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. This feature is currently in development and requires approval and enablement, please contact support.
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. This feature is currently in development and requires approval and enablement, please contact support.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 19
+
+define_attribute:percentage_tiers,Array,{:item_type=>:SubscriptionAddOnPercentageTier}
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Quantity.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Quantity
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 23
+
+define_attribute:quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 27
+
+define_attribute:revenue_schedule_type,String
Returns If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier. See our [Guide](recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier. See our [Guide](recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 31
+
+define_attribute:tiers,Array,{:item_type=>:SubscriptionAddOnTier}
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 35
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Allows up to 9 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Allows up to 9 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 39
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+ #usage_percentage ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/subscription_add_on_create.rb', line 43
+
+define_attribute:usage_percentage,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionAddOnPercentageTier.html b/Recurly/Requests/SubscriptionAddOnPercentageTier.html
new file mode 100644
index 000000000..862e224c7
--- /dev/null
+++ b/Recurly/Requests/SubscriptionAddOnPercentageTier.html
@@ -0,0 +1,361 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionAddOnPercentageTier
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/subscription_add_on_tier.rb', line 11
+
+define_attribute:ending_quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/subscription_add_on_tier.rb', line 15
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_add_on_tier.rb', line 19
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+ #usage_percentage ⇒ String
+
+
+
+
+
+
+
+
+
Returns (deprecated) – Use the percentage_tiers object instead.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
(deprecated) – Use the percentage_tiers object instead.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_add_on_tier.rb', line 23
+
+define_attribute:usage_percentage,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionAddOnUpdate.html b/Recurly/Requests/SubscriptionAddOnUpdate.html
new file mode 100644
index 000000000..2d23ec0b9
--- /dev/null
+++ b/Recurly/Requests/SubscriptionAddOnUpdate.html
@@ -0,0 +1,1033 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionAddOnUpdate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
If a code is provided without an id, the subscription add-on attributes will be set to the current value for those attributes on the plan add-on unless provided in the request.
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request.
Returns Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 11
+
+define_attribute:add_on_source,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns If a code is provided without an id, the subscription add-on attributes will be set to the current value for those attributes on the plan add-on unless provided in the request. If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If a code is provided without an id, the subscription add-on attributes will be set to the current value for those attributes on the plan add-on unless provided in the request. If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 15
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns When an id is provided, the existing subscription add-on attributes will persist unless overridden in the request.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
When an id is provided, the existing subscription add-on attributes will persist unless overridden in the request.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 19
+
+define_attribute:id,String
Returns If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 23
+
+define_attribute:percentage_tiers,Array,{:item_type=>:SubscriptionAddOnPercentageTier}
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Quantity.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Quantity
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 27
+
+define_attribute:quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 31
+
+define_attribute:revenue_schedule_type,String
Returns If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier.
If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 35
+
+define_attribute:tiers,Array,{:item_type=>:SubscriptionAddOnTier}
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 39
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Allows up to 9 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Allows up to 9 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 43
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+ #usage_percentage ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if add_on_type is usage and usage_type is percentage.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if add_on_type is usage and usage_type is percentage.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/subscription_add_on_update.rb', line 47
+
+define_attribute:usage_percentage,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionCancel.html b/Recurly/Requests/SubscriptionCancel.html
new file mode 100644
index 000000000..6650f0380
--- /dev/null
+++ b/Recurly/Requests/SubscriptionCancel.html
@@ -0,0 +1,277 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionCancel
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/subscription_cancel.rb', line 11
+
+define_attribute:timeframe,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionChangeBillingInfoCreate.html b/Recurly/Requests/SubscriptionChangeBillingInfoCreate.html
new file mode 100644
index 000000000..5f41432bf
--- /dev/null
+++ b/Recurly/Requests/SubscriptionChangeBillingInfoCreate.html
@@ -0,0 +1,277 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionChangeBillingInfoCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `“abc123”`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.' If a subscription add-on's `code` is supplied without the `id`, `“def456”`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request. - If an `id` is passed, any attributes not passed in will pull from the existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the current values of the plan add-on - Attributes passed in as part of the request will override either of the above scenarios.
If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `“abc123”`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.' If a subscription add-on's `code` is supplied without the `id`, `“def456”`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request. - If an `id` is passed, any attributes not passed in will pull from the existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the current values of the plan add-on - Attributes passed in as part of the request will override either of the above scenarios
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 11
+
+define_attribute:add_ons,Array,{:item_type=>:SubscriptionAddOnUpdate}
# File 'lib/recurly/requests/subscription_change_create.rb', line 15
+
+define_attribute:billing_info,:SubscriptionChangeBillingInfoCreate
+
+
+
+
+
+
+
+
+
+
+ #collection_method ⇒ String
+
+
+
+
+
+
+
+
+
Returns Collection method.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Collection method
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 19
+
+define_attribute:collection_method,String
+
+
+
+
+
+
+
+
+
+
+ #coupon_codes ⇒ Array[String]
+
+
+
+
+
+
+
+
+
Returns A list of coupon_codes to be redeemed on the subscription during the change. Only allowed if timeframe is now and you change something about the subscription that creates an invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Array[String])
+
+
+
+ —
+
+
A list of coupon_codes to be redeemed on the subscription during the change. Only allowed if timeframe is now and you change something about the subscription that creates an invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 23
+
+define_attribute:coupon_codes,Array,{:item_type=>String}
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 27
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #net_terms ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 31
+
+define_attribute:net_terms,Integer
+
+
+
+
+
+
+
+
+
+
+ #plan_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 35
+
+define_attribute:plan_code,String
+
+
+
+
+
+
+
+
+
+
+ #plan_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 39
+
+define_attribute:plan_id,String
+
+
+
+
+
+
+
+
+
+
+ #po_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 43
+
+define_attribute:po_number,String
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Optionally override the default quantity of 1.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Optionally override the default quantity of 1.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 47
+
+define_attribute:quantity,Integer
Returns Shipping addresses are tied to a customer's account. Each account can have up to 20 different shipping addresses, and if you have enabled multiple subscriptions per account, you can associate different shipping addresses to each subscription.
Shipping addresses are tied to a customer's account. Each account can have up to 20 different shipping addresses, and if you have enabled multiple subscriptions per account, you can associate different shipping addresses to each subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 59
+
+define_attribute:shipping,:SubscriptionChangeShippingCreate
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 63
+
+define_attribute:tax_inclusive,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #timeframe ⇒ String
+
+
+
+
+
+
+
+
+
Returns The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now, when the subscription is next billed, or when the subscription term ends. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to `term_end` or `bill_date` so the change takes effect at a scheduled billing date. The `renewal` timeframe option is accepted as an alias for `term_end`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now, when the subscription is next billed, or when the subscription term ends. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to `term_end` or `bill_date` so the change takes effect at a scheduled billing date. The `renewal` timeframe option is accepted as an alias for `term_end`.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 67
+
+define_attribute:timeframe,String
+
+
+
+
+
+
+
+
+
+
+ #transaction_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 71
+
+define_attribute:transaction_type,String
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Optionally, sets custom pricing for the subscription, overriding the plan's default unit amount. The subscription's current currency will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Optionally, sets custom pricing for the subscription, overriding the plan's default unit amount. The subscription's current currency will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/subscription_change_create.rb', line 75
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionChangeShippingCreate.html b/Recurly/Requests/SubscriptionChangeShippingCreate.html
new file mode 100644
index 000000000..716ae3634
--- /dev/null
+++ b/Recurly/Requests/SubscriptionChangeShippingCreate.html
@@ -0,0 +1,604 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionChangeShippingCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/subscription_change_shipping_create.rb', line 11
+
+define_attribute:address,:ShippingAddressCreate
+
+
+
+
+
+
+
+
+
+
+ #address_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Assign a shipping address from the account's existing shipping addresses. If this and address are both present, address will take precedence.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Assign a shipping address from the account's existing shipping addresses. If this and address are both present, address will take precedence.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/subscription_change_shipping_create.rb', line 15
+
+define_attribute:address_id,String
+
+
+
+
+
+
+
+
+
+
+ #amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_change_shipping_create.rb', line 19
+
+define_attribute:amount,Float
+
+
+
+
+
+
+
+
+
+
+ #method_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The code of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The code of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_change_shipping_create.rb', line 23
+
+define_attribute:method_code,String
+
+
+
+
+
+
+
+
+
+
+ #method_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The id of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The id of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/subscription_change_shipping_create.rb', line 27
+
+define_attribute:method_id,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionCreate.html b/Recurly/Requests/SubscriptionCreate.html
new file mode 100644
index 000000000..85f7ae0b3
--- /dev/null
+++ b/Recurly/Requests/SubscriptionCreate.html
@@ -0,0 +1,2536 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
# File 'lib/recurly/requests/subscription_create.rb', line 15
+
+define_attribute:add_ons,Array,{:item_type=>:SubscriptionAddOnCreate}
+
+
+
+
+
+
+
+
+
+
+ #auto_renew ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Whether the subscription renews at the end of its term.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Whether the subscription renews at the end of its term.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 19
+
+define_attribute:auto_renew,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #billing_info_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 23
+
+define_attribute:billing_info_id,String
+
+
+
+
+
+
+
+
+
+
+ #collection_method ⇒ String
+
+
+
+
+
+
+
+
+
Returns Collection method.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Collection method
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 27
+
+define_attribute:collection_method,String
+
+
+
+
+
+
+
+
+
+
+ #coupon_codes ⇒ Array[String]
+
+
+
+
+
+
+
+
+
Returns A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Array[String])
+
+
+
+ —
+
+
A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 31
+
+define_attribute:coupon_codes,Array,{:item_type=>String}
+
+
+
+
+
+
+
+
+
+
+ #credit_customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 35
+
+define_attribute:credit_customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #currency ⇒ String
+
+
+
+
+
+
+
+
+
Returns 3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 39
+
+define_attribute:currency,String
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 43
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 47
+
+define_attribute:customer_notes,String
Returns A gift card redemption code to be redeemed on the purchase invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A gift card redemption code to be redeemed on the purchase invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 51
+
+define_attribute:gift_card_redemption_code,String
+
+
+
+
+
+
+
+
+
+
+ #net_terms ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 55
+
+define_attribute:net_terms,Integer
+
+
+
+
+
+
+
+
+
+
+ #next_bill_date ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 59
+
+define_attribute:next_bill_date,DateTime
+
+
+
+
+
+
+
+
+
+
+ #plan_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 63
+
+define_attribute:plan_code,String
+
+
+
+
+
+
+
+
+
+
+ #plan_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 67
+
+define_attribute:plan_id,String
+
+
+
+
+
+
+
+
+
+
+ #po_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 71
+
+define_attribute:po_number,String
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Optionally override the default quantity of 1.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Optionally override the default quantity of 1.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 75
+
+define_attribute:quantity,Integer
The new set of ramp intervals for the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 79
+
+define_attribute:ramp_intervals,Array,{:item_type=>:SubscriptionRampInterval}
+
+
+
+
+
+
+
+
+
+
+ #renewal_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 83
+
+define_attribute:renewal_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 87
+
+define_attribute:revenue_schedule_type,String
Create a shipping address on the account and assign it to the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 91
+
+define_attribute:shipping,:SubscriptionShippingCreate
+
+
+
+
+
+
+
+
+
+
+ #starts_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 95
+
+define_attribute:starts_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 99
+
+define_attribute:tax_inclusive,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #terms_and_conditions ⇒ String
+
+
+
+
+
+
+
+
+
Returns This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 103
+
+define_attribute:terms_and_conditions,String
+
+
+
+
+
+
+
+
+
+
+ #total_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 107
+
+define_attribute:total_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #transaction_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 111
+
+define_attribute:transaction_type,String
+
+
+
+
+
+
+
+
+
+
+ #trial_ends_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
+
+
+
+
+
+
+
+
+
+
+
+
+115
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 115
+
+define_attribute:trial_ends_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+
+
+
+
+
+
+
+
+
+
+
+
+119
+
+
+
# File 'lib/recurly/requests/subscription_create.rb', line 119
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionPause.html b/Recurly/Requests/SubscriptionPause.html
new file mode 100644
index 000000000..a67e65dd0
--- /dev/null
+++ b/Recurly/Requests/SubscriptionPause.html
@@ -0,0 +1,277 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionPause
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 19
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #next_bill_date ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 23
+
+define_attribute:next_bill_date,DateTime
+
+
+
+
+
+
+
+
+
+
+ #plan_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Plan code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Plan code
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 27
+
+define_attribute:plan_code,String
+
+
+
+
+
+
+
+
+
+
+ #plan_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Plan ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Plan ID
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 31
+
+define_attribute:plan_id,String
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Optionally override the default quantity of 1.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Optionally override the default quantity of 1.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 35
+
+define_attribute:quantity,Integer
The new set of ramp intervals for the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 39
+
+define_attribute:ramp_intervals,Array,{:item_type=>:SubscriptionRampInterval}
+
+
+
+
+
+
+
+
+
+
+ #renewal_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 43
+
+define_attribute:renewal_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 47
+
+define_attribute:revenue_schedule_type,String
Create a shipping address on the account and assign it to the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 51
+
+define_attribute:shipping,:SubscriptionShippingPurchase
+
+
+
+
+
+
+
+
+
+
+ #starts_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 55
+
+define_attribute:starts_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 59
+
+define_attribute:tax_inclusive,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #total_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 63
+
+define_attribute:total_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #trial_ends_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 67
+
+define_attribute:trial_ends_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/requests/subscription_purchase.rb', line 71
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionRampInterval.html b/Recurly/Requests/SubscriptionRampInterval.html
new file mode 100644
index 000000000..971551c13
--- /dev/null
+++ b/Recurly/Requests/SubscriptionRampInterval.html
@@ -0,0 +1,361 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionRampInterval
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/requests/subscription_shipping_create.rb', line 11
+
+define_attribute:address,:ShippingAddressCreate
+
+
+
+
+
+
+
+
+
+
+ #address_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Assign a shipping address from the account's existing shipping addresses. If `address_id` and `address` are both present, `address` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Assign a shipping address from the account's existing shipping addresses. If `address_id` and `address` are both present, `address` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/subscription_shipping_create.rb', line 15
+
+define_attribute:address_id,String
+
+
+
+
+
+
+
+
+
+
+ #amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_shipping_create.rb', line 19
+
+define_attribute:amount,Float
+
+
+
+
+
+
+
+
+
+
+ #method_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The code of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The code of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_shipping_create.rb', line 23
+
+define_attribute:method_code,String
+
+
+
+
+
+
+
+
+
+
+ #method_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The id of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The id of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/subscription_shipping_create.rb', line 27
+
+define_attribute:method_id,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/SubscriptionShippingPurchase.html b/Recurly/Requests/SubscriptionShippingPurchase.html
new file mode 100644
index 000000000..c04585f07
--- /dev/null
+++ b/Recurly/Requests/SubscriptionShippingPurchase.html
@@ -0,0 +1,445 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::SubscriptionShippingPurchase
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Whether the subscription renews at the end of its term.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Whether the subscription renews at the end of its term.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 11
+
+define_attribute:auto_renew,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #billing_info_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 15
+
+define_attribute:billing_info_id,String
+
+
+
+
+
+
+
+
+
+
+ #collection_method ⇒ String
+
+
+
+
+
+
+
+
+
Returns Change collection method.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Change collection method
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 19
+
+define_attribute:collection_method,String
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 23
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 27
+
+define_attribute:customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #gateway_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns If present, this subscription's transactions will use the payment gateway with this code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If present, this subscription's transactions will use the payment gateway with this code.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 31
+
+define_attribute:gateway_code,String
+
+
+
+
+
+
+
+
+
+
+ #net_terms ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 35
+
+define_attribute:net_terms,Integer
+
+
+
+
+
+
+
+
+
+
+ #next_bill_date ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 39
+
+define_attribute:next_bill_date,DateTime
+
+
+
+
+
+
+
+
+
+
+ #po_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 43
+
+define_attribute:po_number,String
Returns The remaining billing cycles in the current term.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
The remaining billing cycles in the current term.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 47
+
+define_attribute:remaining_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #renewal_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 51
+
+define_attribute:renewal_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/requests/subscription_update.rb', line 55
+
+define_attribute:revenue_schedule_type,String
# File 'lib/recurly/requests/tier_pricing.rb', line 11
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/tier_pricing.rb', line 15
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/tier_pricing.rb', line 19
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Requests/UsageCreate.html b/Recurly/Requests/UsageCreate.html
new file mode 100644
index 000000000..95fc10bef
--- /dev/null
+++ b/Recurly/Requests/UsageCreate.html
@@ -0,0 +1,529 @@
+
+
+
+
+
+
+ Class: Recurly::Requests::UsageCreate
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
Returns The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is “500”).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is “500”).
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/requests/usage_create.rb', line 11
+
+define_attribute:amount,Float
+
+
+
+
+
+
+
+
+
+
+ #merchant_tag ⇒ String
+
+
+
+
+
+
+
+
+
Returns Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/requests/usage_create.rb', line 15
+
+define_attribute:merchant_tag,String
+
+
+
+
+
+
+
+
+
+
+ #recording_timestamp ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the usage was recorded in your system.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the usage was recorded in your system.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/requests/usage_create.rb', line 19
+
+define_attribute:recording_timestamp,DateTime
+
+
+
+
+
+
+
+
+
+
+ #usage_timestamp ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/requests/usage_create.rb', line 23
+
+define_attribute:usage_timestamp,DateTime
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resource.html b/Recurly/Resource.html
new file mode 100644
index 000000000..a3d9a5d35
--- /dev/null
+++ b/Recurly/Resource.html
@@ -0,0 +1,642 @@
+
+
+
+
+
+
+ Class: Recurly::Resource
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This class represents an object as it exists on the Recurly servers. It is generated from a response. If you wish to update or change a resource, you need to send a request to the server and get a new Resource.
# File 'lib/recurly/resource.rb', line 13
+
+defrequires_client?
+ false
+end
+
+
+
+
+
+
+
+
+ #to_json ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Raises:
+
+
+
+
+
+ (NoMethodError)
+
+
+
+
+
+
+
+
+
+
+
+
+
+30
+31
+32
+
+
+
# File 'lib/recurly/resource.rb', line 30
+
+defto_json
+ raiseNoMethodError,"to_json is not implemented for Resources. Please use Resource#attributes"
+end
+
+
+
+
+
+
+
+
+ #to_s ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+26
+27
+28
+
+
+
# File 'lib/recurly/resource.rb', line 26
+
+defto_s
+ self.inspect
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources.html b/Recurly/Resources.html
new file mode 100644
index 000000000..1d82d129d
--- /dev/null
+++ b/Recurly/Resources.html
@@ -0,0 +1,117 @@
+
+
+
+
+
+
+ Module: Recurly::Resources
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
# File 'lib/recurly/resources/account.rb', line 11
+
+define_attribute:address,:Address
+
+
+
+
+
+
+
+
+
+
+ #bill_to ⇒ String
+
+
+
+
+
+
+
+
+
Returns An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/account.rb', line 15
+
+define_attribute:bill_to,String
# File 'lib/recurly/resources/account.rb', line 19
+
+define_attribute:billing_info,:BillingInfo
+
+
+
+
+
+
+
+
+
+
+ #cc_emails ⇒ String
+
+
+
+
+
+
+
+
+
Returns Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/account.rb', line 23
+
+define_attribute:cc_emails,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The unique identifier of the account. This cannot be changed once the account is created.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The unique identifier of the account. This cannot be changed once the account is created.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/account.rb', line 27
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #company ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/account.rb', line 31
+
+define_attribute:company,String
+
+
+
+
+
+
+
+
+
+
+ #created_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the account was created.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the account was created.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/account.rb', line 35
+
+define_attribute:created_at,DateTime
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/account.rb', line 39
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #deleted_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If present, when the account was last marked inactive.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If present, when the account was last marked inactive.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/account.rb', line 43
+
+define_attribute:deleted_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/account.rb', line 47
+
+define_attribute:dunning_campaign_id,String
+
+
+
+
+
+
+
+
+
+
+ #email ⇒ String
+
+
+
+
+
+
+
+
+
Returns The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/account.rb', line 51
+
+define_attribute:email,String
+
+
+
+
+
+
+
+
+
+
+ #exemption_certificate ⇒ String
+
+
+
+
+
+
+
+
+
Returns The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/account.rb', line 55
+
+define_attribute:exemption_certificate,String
Returns Indicates if the account has a paused subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Indicates if the account has a paused subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/resources/account.rb', line 87
+
+define_attribute:has_paused_subscription,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #hosted_login_token ⇒ String
+
+
+
+
+
+
+
+
+
Returns The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: `
+
+
# File 'lib/recurly/resources/account.rb', line 95
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_template_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/resources/account.rb', line 99
+
+define_attribute:invoice_template_id,String
+
+
+
+
+
+
+
+
+
+
+ #last_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/resources/account.rb', line 103
+
+define_attribute:last_name,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/resources/account.rb', line 107
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #parent_account_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The UUID of the parent account associated with this account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The UUID of the parent account associated with this account.
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/resources/account.rb', line 111
+
+define_attribute:parent_account_id,String
+
+
+
+
+
+
+
+
+
+
+ #preferred_locale ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used to determine the language and locale of emails sent on behalf of the merchant to the customer.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used to determine the language and locale of emails sent on behalf of the merchant to the customer.
+
+
+
+
+
+
+
+
+
+
+
+
+115
+
+
+
# File 'lib/recurly/resources/account.rb', line 115
+
+define_attribute:preferred_locale,String
# File 'lib/recurly/resources/account_mini.rb', line 11
+
+define_attribute:bill_to,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The unique identifier of the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The unique identifier of the account.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 15
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #company ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 19
+
+define_attribute:company,String
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 23
+
+define_attribute:dunning_campaign_id,String
+
+
+
+
+
+
+
+
+
+
+ #email ⇒ String
+
+
+
+
+
+
+
+
+
Returns The email address used for communicating with this customer.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The email address used for communicating with this customer.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 27
+
+define_attribute:email,String
+
+
+
+
+
+
+
+
+
+
+ #first_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 31
+
+define_attribute:first_name,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 35
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #last_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 39
+
+define_attribute:last_name,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 43
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #parent_account_id ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/account_mini.rb', line 47
+
+define_attribute:parent_account_id,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/AccountNote.html b/Recurly/Resources/AccountNote.html
new file mode 100644
index 000000000..e22fc750b
--- /dev/null
+++ b/Recurly/Resources/AccountNote.html
@@ -0,0 +1,641 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::AccountNote
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 59
+
+define_attribute:item,:ItemMini
+
+
+
+
+
+
+
+
+
+
+ #measured_unit_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns System-generated unique identifier for an measured unit associated with the add-on.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
System-generated unique identifier for an measured unit associated with the add-on.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 63
+
+define_attribute:measured_unit_id,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns Describes your add-on and will appear in subscribers' invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Describes your add-on and will appear in subscribers' invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 67
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 71
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #optional ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 75
+
+define_attribute:optional,:Boolean
This feature is currently in development and requires approval and enablement, please contact support.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 79
+
+define_attribute:percentage_tiers,Array,{:item_type=>:PercentageTiersByCurrency}
+
+
+
+
+
+
+
+
+
+
+ #plan_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Plan ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Plan ID
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 83
+
+define_attribute:plan_id,String
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 87
+
+define_attribute:revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #state ⇒ String
+
+
+
+
+
+
+
+
+
Returns Add-ons can be either active or inactive.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Add-ons can be either active or inactive.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 91
+
+define_attribute:state,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 95
+
+define_attribute:tax_code,String
# File 'lib/recurly/resources/add_on.rb', line 103
+
+define_attribute:tiers,Array,{:item_type=>:Tier}
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Last updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Last updated at
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 107
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #usage_calculation_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 111
+
+define_attribute:usage_calculation_type,String
+
+
+
+
+
+
+
+
+
+
+ #usage_percentage ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.
+
+
+
+
+
+
+
+
+
+
+
+
+115
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 115
+
+define_attribute:usage_percentage,Float
+
+
+
+
+
+
+
+
+
+
+ #usage_timeframe ⇒ String
+
+
+
+
+
+
+
+
+
Returns The time at which usage totals are reset for billing purposes.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The time at which usage totals are reset for billing purposes.
+
+
+
+
+
+
+
+
+
+
+
+
+119
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 119
+
+define_attribute:usage_timeframe,String
+
+
+
+
+
+
+
+
+
+
+ #usage_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Type of usage, returns usage type if `add_on_type` is `usage`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Type of usage, returns usage type if `add_on_type` is `usage`.
+
+
+
+
+
+
+
+
+
+
+
+
+123
+
+
+
# File 'lib/recurly/resources/add_on.rb', line 123
+
+define_attribute:usage_type,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/AddOnMini.html b/Recurly/Resources/AddOnMini.html
new file mode 100644
index 000000000..4cfd46b3f
--- /dev/null
+++ b/Recurly/Resources/AddOnMini.html
@@ -0,0 +1,1106 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::AddOnMini
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/resources/add_on_pricing.rb', line 11
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/add_on_pricing.rb', line 15
+
+define_attribute:tax_inclusive,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/add_on_pricing.rb', line 19
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/add_on_pricing.rb', line 23
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/Address.html b/Recurly/Resources/Address.html
new file mode 100644
index 000000000..d5b38599a
--- /dev/null
+++ b/Recurly/Resources/Address.html
@@ -0,0 +1,770 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::Address
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
# File 'lib/recurly/resources/billing_info.rb', line 15
+
+define_attribute:address,:Address
+
+
+
+
+
+
+
+
+
+
+ #backup_payment_method ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/billing_info.rb', line 19
+
+define_attribute:backup_payment_method,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #company ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/billing_info.rb', line 23
+
+define_attribute:company,String
+
+
+
+
+
+
+
+
+
+
+ #created_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the billing information was created.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the billing information was created.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/billing_info.rb', line 27
+
+define_attribute:created_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #first_name ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/billing_info.rb', line 31
+
+define_attribute:first_name,String
# File 'lib/recurly/resources/billing_info.rb', line 51
+
+define_attribute:payment_method,:PaymentMethod
+
+
+
+
+
+
+
+
+
+
+ #primary_payment_method ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/billing_info.rb', line 55
+
+define_attribute:primary_payment_method,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the billing information was last changed.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the billing information was last changed.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/resources/billing_info.rb', line 59
+
+define_attribute:updated_at,DateTime
This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
If `duration` is “temporal” than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
If `duration` is “temporal” than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
Returns The coupon is valid for one-time, non-plan charges if true.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
The coupon is valid for one-time, non-plan charges if true.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 19
+
+define_attribute:applies_to_non_plan_charges,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The code the customer enters to redeem the coupon.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The code the customer enters to redeem the coupon.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 23
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #coupon_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Whether the coupon is “single_code” or “bulk”. Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Whether the coupon is “single_code” or “bulk”. Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 27
+
+define_attribute:coupon_type,String
+
+
+
+
+
+
+
+
+
+
+ #created_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Created at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Created at
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 31
+
+define_attribute:created_at,DateTime
Details of the discount a coupon applies. Will contain a `type` property and one of the following properties: `percent`, `fixed`, `trial`.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 35
+
+define_attribute:discount,:CouponDiscount
+
+
+
+
+
+
+
+
+
+
+ #duration ⇒ String
+
+
+
+
+
+
+
+
+
Returns - “single_use” coupons applies to the first invoice only. - “temporal” coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
“single_use” coupons applies to the first invoice only. - “temporal” coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.
+
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 39
+
+define_attribute:duration,String
+
+
+
+
+
+
+
+
+
+
+ #expired_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns The date and time the coupon was expired early or reached its `max_redemptions`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
The date and time the coupon was expired early or reached its `max_redemptions`.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 43
+
+define_attribute:expired_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #free_trial_amount ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Sets the duration of time the `free_trial_unit` is for.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Sets the duration of time the `free_trial_unit` is for.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 47
+
+define_attribute:free_trial_amount,Integer
+
+
+
+
+
+
+
+
+
+
+ #free_trial_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 51
+
+define_attribute:free_trial_unit,String
+
+
+
+
+
+
+
+
+
+
+ #hosted_page_description ⇒ String
+
+
+
+
+
+
+
+
+
Returns This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 55
+
+define_attribute:hosted_page_description,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Coupon ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Coupon ID
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 59
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Description of the coupon on the invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Description of the coupon on the invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 63
+
+define_attribute:invoice_description,String
Returns Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 75
+
+define_attribute:max_redemptions_per_account,Integer
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The internal name for the coupon.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The internal name for the coupon.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 79
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 83
+
+define_attribute:object,String
A list of plans for which this coupon applies. This will be `null` if `applies_to_all_plans=true`.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 87
+
+define_attribute:plans,Array,{:item_type=>:PlanMini}
+
+
+
+
+
+
+
+
+
+
+ #redeem_by ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 91
+
+define_attribute:redeem_by,DateTime
+
+
+
+
+
+
+
+
+
+
+ #redemption_resource ⇒ String
+
+
+
+
+
+
+
+
+
Returns Whether the discount is for all eligible charges on the account, or only a specific subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Whether the discount is for all eligible charges on the account, or only a specific subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 95
+
+define_attribute:redemption_resource,String
+
+
+
+
+
+
+
+
+
+
+ #state ⇒ String
+
+
+
+
+
+
+
+
+
Returns Indicates if the coupon is redeemable, and if it is not, why.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Indicates if the coupon is redeemable, and if it is not, why.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 99
+
+define_attribute:state,String
+
+
+
+
+
+
+
+
+
+
+ #temporal_amount ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns If `duration` is “temporal” than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
If `duration` is “temporal” than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 103
+
+define_attribute:temporal_amount,Integer
+
+
+
+
+
+
+
+
+
+
+ #temporal_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns If `duration` is “temporal” than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If `duration` is “temporal” than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 107
+
+define_attribute:temporal_unit,String
+
+
+
+
+
+
+
+
+
+
+ #unique_code_template ⇒ String
+
+
+
+
+
+
+
+
+
Returns On a bulk coupon, the template from which unique coupon codes are generated.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
On a bulk coupon, the template from which unique coupon codes are generated.
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 111
+
+define_attribute:unique_code_template,String
+
+
+
+
+
+
+
+
+
+
+ #unique_coupon_code ⇒ Hash
+
+
+
+
+
+
+
+
+
Returns Will be populated when the Coupon being returned is a `UniqueCouponCode`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Hash)
+
+
+
+ —
+
+
Will be populated when the Coupon being returned is a `UniqueCouponCode`.
+
+
+
+
+
+
+
+
+
+
+
+
+115
+
+
+
# File 'lib/recurly/resources/coupon.rb', line 115
+
+define_attribute:unique_coupon_code,Hash
Returns The code the customer enters to redeem the coupon.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The code the customer enters to redeem the coupon.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/resources/coupon_mini.rb', line 11
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #coupon_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Whether the coupon is “single_code” or “bulk”. Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Whether the coupon is “single_code” or “bulk”. Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/coupon_mini.rb', line 15
+
+define_attribute:coupon_type,String
Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.
# File 'lib/recurly/resources/custom_field_definition.rb', line 11
+
+define_attribute:created_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #deleted_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 15
+
+define_attribute:deleted_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #display_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used to label the field when viewing and editing the field in Recurly's admin UI.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used to label the field when viewing and editing the field in Recurly's admin UI.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 19
+
+define_attribute:display_name,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Custom field definition ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Custom field definition ID
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 23
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 27
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 31
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #related_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Related Recurly object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Related Recurly object type
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 35
+
+define_attribute:related_type,String
+
+
+
+
+
+
+
+
+
+
+ #tooltip ⇒ String
+
+
+
+
+
+
+
+
+
Returns Displayed as a tooltip when editing the field in the Recurly admin UI.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Displayed as a tooltip when editing the field in the Recurly admin UI.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 39
+
+define_attribute:tooltip,String
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Last updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Last updated at
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 43
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #user_access ⇒ String
+
+
+
+
+
+
+
+
+
Returns The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/custom_field_definition.rb', line 47
+
+define_attribute:user_access,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/CustomerPermission.html b/Recurly/Resources/CustomerPermission.html
new file mode 100644
index 000000000..97235be30
--- /dev/null
+++ b/Recurly/Resources/CustomerPermission.html
@@ -0,0 +1,602 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::CustomerPermission
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Whether or not to send an extra email immediately to customers whose initial payment attempt fails with either a hard decline or invalid billing info.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Whether or not to send an extra email immediately to customers whose initial payment attempt fails with either a hard decline or invalid billing info.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/dunning_cycle.rb', line 35
+
+define_attribute:send_immediately_on_hard_decline,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #total_dunning_days ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns The number of days between the first dunning email being sent and the end of the dunning cycle.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
The number of days between the first dunning email being sent and the end of the dunning cycle.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/dunning_cycle.rb', line 39
+
+define_attribute:total_dunning_days,Integer
+
+
+
+
+
+
+
+
+
+
+ #total_recycling_days ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns The number of days between a transaction failure and the end of the dunning cycle.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
The number of days between a transaction failure and the end of the dunning cycle.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/dunning_cycle.rb', line 43
+
+define_attribute:total_recycling_days,Integer
+
+
+
+
+
+
+
+
+
+
+ #type ⇒ String
+
+
+
+
+
+
+
+
+
Returns The type of invoice this cycle applies to.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The type of invoice this cycle applies to.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/dunning_cycle.rb', line 47
+
+define_attribute:type,String
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the current settings were updated in Recurly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the current settings were updated in Recurly.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/dunning_cycle.rb', line 51
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #version ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Current campaign version.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Current campaign version.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/dunning_cycle.rb', line 55
+
+define_attribute:version,Integer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/DunningInterval.html b/Recurly/Resources/DunningInterval.html
new file mode 100644
index 000000000..f5dca9cbb
--- /dev/null
+++ b/Recurly/Resources/DunningInterval.html
@@ -0,0 +1,350 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::DunningInterval
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
# File 'lib/recurly/resources/external_product_reference_mini.rb', line 15
+
+define_attribute:external_connection_type,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/external_product_reference_mini.rb', line 19
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns object.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
object
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/external_product_reference_mini.rb', line 23
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #reference_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/external_product_reference_mini.rb', line 27
+
+define_attribute:reference_code,String
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the external product was updated in Recurly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the external product was updated in Recurly.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/external_product_reference_mini.rb', line 31
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/ExternalSubscription.html b/Recurly/Resources/ExternalSubscription.html
new file mode 100644
index 000000000..46d9e078a
--- /dev/null
+++ b/Recurly/Resources/ExternalSubscription.html
@@ -0,0 +1,1358 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::ExternalSubscription
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
Returns The remaining credit on the recipient account associated with this gift card. Only has a value once the gift card has been redeemed. Can be used to create gift card balance displays for your customers.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The remaining credit on the recipient account associated with this gift card. Only has a value once the gift card has been redeemed. Can be used to create gift card balance displays for your customers.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 11
+
+define_attribute:balance,Float
+
+
+
+
+
+
+
+
+
+
+ #canceled_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the gift card was canceled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the gift card was canceled.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 15
+
+define_attribute:canceled_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #created_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Created at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Created at
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 19
+
+define_attribute:created_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #currency ⇒ String
+
+
+
+
+
+
+
+
+
Returns 3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 23
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #delivered_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the gift card was sent to the recipient by Recurly via email, if method was email and the “Gift Card Delivery” email template was enabled. This will be empty for post delivery or email delivery where the email template was disabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the gift card was sent to the recipient by Recurly via email, if method was email and the “Gift Card Delivery” email template was enabled. This will be empty for post delivery or email delivery where the email template was disabled.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 27
+
+define_attribute:delivered_at,DateTime
# File 'lib/recurly/resources/gift_card.rb', line 31
+
+define_attribute:delivery,:GiftCardDelivery
+
+
+
+
+
+
+
+
+
+
+ #gifter_account_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The ID of the account that purchased the gift card.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The ID of the account that purchased the gift card.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 35
+
+define_attribute:gifter_account_id,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Gift card ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Gift card ID
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 39
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 43
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #product_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The product code or SKU of the gift card product.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The product code or SKU of the gift card product.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 47
+
+define_attribute:product_code,String
+
+
+
+
+
+
+
+
+
+
+ #purchase_invoice_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The ID of the invoice for the gift card purchase made by the gifter.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The ID of the invoice for the gift card purchase made by the gifter.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 51
+
+define_attribute:purchase_invoice_id,String
+
+
+
+
+
+
+
+
+
+
+ #recipient_account_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The ID of the account that redeemed the gift card redemption code. Does not have a value until gift card is redeemed.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The ID of the account that redeemed the gift card redemption code. Does not have a value until gift card is redeemed.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 55
+
+define_attribute:recipient_account_id,String
+
+
+
+
+
+
+
+
+
+
+ #redeemed_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the gift card was redeemed by the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the gift card was redeemed by the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 59
+
+define_attribute:redeemed_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #redemption_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The unique redemption code for the gift card, generated by Recurly. Will be 16 characters, alphanumeric, displayed uppercase, but accepted in any case at redemption. Used by the recipient account to create a credit in the amount of the `unit_amount` on their account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The unique redemption code for the gift card, generated by Recurly. Will be 16 characters, alphanumeric, displayed uppercase, but accepted in any case at redemption. Used by the recipient account to create a credit in the amount of the `unit_amount` on their account.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 63
+
+define_attribute:redemption_code,String
+
+
+
+
+
+
+
+
+
+
+ #redemption_invoice_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The ID of the invoice for the gift card redemption made by the recipient. Does not have a value until gift card is redeemed.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The ID of the invoice for the gift card redemption made by the recipient. Does not have a value until gift card is redeemed.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 67
+
+define_attribute:redemption_invoice_id,String
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 71
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Last updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Last updated at
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/gift_card.rb', line 75
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/GiftCardDelivery.html b/Recurly/Resources/GiftCardDelivery.html
new file mode 100644
index 000000000..47e004061
--- /dev/null
+++ b/Recurly/Resources/GiftCardDelivery.html
@@ -0,0 +1,854 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::GiftCardDelivery
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/resources/gift_card_delivery.rb', line 11
+
+define_attribute:deliver_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #email_address ⇒ String
+
+
+
+
+
+
+
+
+
Returns The email address of the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The email address of the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/gift_card_delivery.rb', line 15
+
+define_attribute:email_address,String
+
+
+
+
+
+
+
+
+
+
+ #first_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The first name of the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The first name of the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/gift_card_delivery.rb', line 19
+
+define_attribute:first_name,String
+
+
+
+
+
+
+
+
+
+
+ #gifter_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The name of the gifter for the purpose of a message displayed to the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The name of the gifter for the purpose of a message displayed to the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/gift_card_delivery.rb', line 23
+
+define_attribute:gifter_name,String
+
+
+
+
+
+
+
+
+
+
+ #last_name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The last name of the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The last name of the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/gift_card_delivery.rb', line 27
+
+define_attribute:last_name,String
+
+
+
+
+
+
+
+
+
+
+ #method ⇒ String
+
+
+
+
+
+
+
+
+
Returns Whether the delivery method is email or postal service.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Whether the delivery method is email or postal service.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/gift_card_delivery.rb', line 31
+
+define_attribute:method,String
+
+
+
+
+
+
+
+
+
+
+ #personal_message ⇒ String
+
+
+
+
+
+
+
+
+
Returns The personal message from the gifter to the recipient.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The personal message from the gifter to the recipient.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/gift_card_delivery.rb', line 35
+
+define_attribute:personal_message,String
If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001).
Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.
VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own.
# File 'lib/recurly/resources/invoice.rb', line 15
+
+define_attribute:address,:InvoiceAddress
+
+
+
+
+
+
+
+
+
+
+ #balance ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The outstanding balance remaining on this invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The outstanding balance remaining on this invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 19
+
+define_attribute:balance,Float
+
+
+
+
+
+
+
+
+
+
+ #billing_info_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 23
+
+define_attribute:billing_info_id,String
+
+
+
+
+
+
+
+
+
+
+ #closed_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Date invoice was marked paid or failed.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Date invoice was marked paid or failed.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 27
+
+define_attribute:closed_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #collection_method ⇒ String
+
+
+
+
+
+
+
+
+
Returns An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 31
+
+define_attribute:collection_method,String
+
+
+
+
+
+
+
+
+
+
+ #created_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Created at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Created at
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 35
+
+define_attribute:created_at,DateTime
# File 'lib/recurly/resources/invoice.rb', line 39
+
+define_attribute:credit_payments,Array,{:item_type=>:CreditPayment}
+
+
+
+
+
+
+
+
+
+
+ #currency ⇒ String
+
+
+
+
+
+
+
+
+
Returns 3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 43
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 47
+
+define_attribute:customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #discount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Total discounts applied to this invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Total discounts applied to this invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 51
+
+define_attribute:discount,Float
+
+
+
+
+
+
+
+
+
+
+ #due_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Date invoice is due. This is the date the net terms are reached.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Date invoice is due. This is the date the net terms are reached.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 55
+
+define_attribute:due_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 59
+
+define_attribute:dunning_campaign_id,String
+
+
+
+
+
+
+
+
+
+
+ #dunning_events_sent ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Number of times the event was sent.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Number of times the event was sent.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 63
+
+define_attribute:dunning_events_sent,Integer
+
+
+
+
+
+
+
+
+
+
+ #final_dunning_event ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Last communication attempt.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Last communication attempt.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 67
+
+define_attribute:final_dunning_event,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #has_more_line_items ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 71
+
+define_attribute:has_more_line_items,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Invoice ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Invoice ID
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 75
+
+define_attribute:id,String
# File 'lib/recurly/resources/invoice.rb', line 79
+
+define_attribute:line_items,Array,{:item_type=>:LineItem}
+
+
+
+
+
+
+
+
+
+
+ #net_terms ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 83
+
+define_attribute:net_terms,Integer
+
+
+
+
+
+
+
+
+
+
+ #number ⇒ String
+
+
+
+
+
+
+
+
+
Returns If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 87
+
+define_attribute:number,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 91
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #origin ⇒ String
+
+
+
+
+
+
+
+
+
Returns The event that created the invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The event that created the invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 95
+
+define_attribute:origin,String
+
+
+
+
+
+
+
+
+
+
+ #paid ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The total amount of successful payments transaction on this invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The total amount of successful payments transaction on this invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 99
+
+define_attribute:paid,Float
+
+
+
+
+
+
+
+
+
+
+ #po_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
For manual invoicing, this identifies the PO number associated with the subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 103
+
+define_attribute:po_number,String
# File 'lib/recurly/resources/invoice.rb', line 135
+
+define_attribute:tax_info,:TaxInfo
+
+
+
+
+
+
+
+
+
+
+ #terms_and_conditions ⇒ String
+
+
+
+
+
+
+
+
+
Returns This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
+
+
+
+
+
+
+
+
+
+
+
+
+139
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 139
+
+define_attribute:terms_and_conditions,String
+
+
+
+
+
+
+
+
+
+
+ #total ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The final total on this invoice. The summation of invoice charges, discounts, credits, and tax.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The final total on this invoice. The summation of invoice charges, discounts, credits, and tax.
+
+
+
+
+
+
+
+
+
+
+
+
+143
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 143
+
+define_attribute:total,Float
# File 'lib/recurly/resources/invoice.rb', line 147
+
+define_attribute:transactions,Array,{:item_type=>:Transaction}
+
+
+
+
+
+
+
+
+
+
+ #type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Invoices are either charge, credit, or legacy invoices.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Invoices are either charge, credit, or legacy invoices.
+
+
+
+
+
+
+
+
+
+
+
+
+151
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 151
+
+define_attribute:type,String
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Last updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Last updated at
+
+
+
+
+
+
+
+
+
+
+
+
+155
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 155
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #used_tax_service ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.
+
+
+
+
+
+
+
+
+
+
+
+
+159
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 159
+
+define_attribute:used_tax_service,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #uuid ⇒ String
+
+
+
+
+
+
+
+
+
Returns Invoice UUID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Invoice UUID
+
+
+
+
+
+
+
+
+
+
+
+
+163
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 163
+
+define_attribute:uuid,String
+
+
+
+
+
+
+
+
+
+
+ #vat_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
+
+
+
+
+
+
+
+
+
+
+
+
+167
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 167
+
+define_attribute:vat_number,String
Returns VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
+
+
+
+
+
+
+
+
+
+
+
+
+171
+
+
+
# File 'lib/recurly/resources/invoice.rb', line 171
+
+define_attribute:vat_reverse_charge_notes,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/InvoiceAddress.html b/Recurly/Resources/InvoiceAddress.html
new file mode 100644
index 000000000..9e96bfe8b
--- /dev/null
+++ b/Recurly/Resources/InvoiceAddress.html
@@ -0,0 +1,1106 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::InvoiceAddress
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/item.rb', line 35
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #deleted_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Deleted at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Deleted at
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/item.rb', line 39
+
+define_attribute:deleted_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional, description.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional, description.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/item.rb', line 43
+
+define_attribute:description,String
+
+
+
+
+
+
+
+
+
+
+ #external_sku ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional, stock keeping unit to link the item to other inventory systems.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional, stock keeping unit to link the item to other inventory systems.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/item.rb', line 47
+
+define_attribute:external_sku,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Item ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Item ID
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/item.rb', line 51
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/item.rb', line 55
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/resources/item.rb', line 59
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/item.rb', line 63
+
+define_attribute:revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #state ⇒ String
+
+
+
+
+
+
+
+
+
Returns The current state of the item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The current state of the item.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/resources/item.rb', line 67
+
+define_attribute:state,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/resources/item.rb', line 71
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns `true` exempts tax on the item, `false` applies tax on the item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
`true` exempts tax on the item, `false` applies tax on the item.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/item.rb', line 75
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Last updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Last updated at
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/resources/item.rb', line 79
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/ItemMini.html b/Recurly/Resources/ItemMini.html
new file mode 100644
index 000000000..e93844103
--- /dev/null
+++ b/Recurly/Resources/ItemMini.html
@@ -0,0 +1,686 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::ItemMini
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 11
+
+define_attribute:account,:AccountMini
+
+
+
+
+
+
+
+
+
+
+ #accounting_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Internal accounting code to help you reconcile your revenue to the correct ledger. Line items created as part of a subscription invoice will use the plan or add-on's accounting code, otherwise the value will only be present if you define an accounting code when creating the line item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Internal accounting code to help you reconcile your revenue to the correct ledger. Line items created as part of a subscription invoice will use the plan or add-on's accounting code, otherwise the value will only be present if you define an accounting code when creating the line item.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 15
+
+define_attribute:accounting_code,String
+
+
+
+
+
+
+
+
+
+
+ #add_on_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns If the line item is a charge or credit for an add-on, this is its code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If the line item is a charge or credit for an add-on, this is its code.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 19
+
+define_attribute:add_on_code,String
+
+
+
+
+
+
+
+
+
+
+ #add_on_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns If the line item is a charge or credit for an add-on this is its ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If the line item is a charge or credit for an add-on this is its ID.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 23
+
+define_attribute:add_on_id,String
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 59
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Description that appears on the invoice. For subscription related items this will be filled in automatically.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Description that appears on the invoice. For subscription related items this will be filled in automatically.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 63
+
+define_attribute:description,String
+
+
+
+
+
+
+
+
+
+
+ #discount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The discount applied to the line item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The discount applied to the line item.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 67
+
+define_attribute:discount,Float
+
+
+
+
+
+
+
+
+
+
+ #end_date ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If this date is provided, it indicates the end of a time range.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If this date is provided, it indicates the end of a time range.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 71
+
+define_attribute:end_date,DateTime
+
+
+
+
+
+
+
+
+
+
+ #external_sku ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 75
+
+define_attribute:external_sku,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Line item ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Line item ID
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 79
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Once the line item has been invoiced this will be the invoice's ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Once the line item has been invoiced this will be the invoice's ID.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 83
+
+define_attribute:invoice_id,String
+
+
+
+
+
+
+
+
+
+
+ #invoice_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns Once the line item has been invoiced this will be the invoice's number. If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Once the line item has been invoiced this will be the invoice's number. If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 87
+
+define_attribute:invoice_number,String
+
+
+
+
+
+
+
+
+
+
+ #item_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique code to identify an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique code to identify an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 91
+
+define_attribute:item_code,String
+
+
+
+
+
+
+
+
+
+
+ #item_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 95
+
+define_attribute:item_id,String
+
+
+
+
+
+
+
+
+
+
+ #legacy_category ⇒ String
+
+
+
+
+
+
+
+
+
Returns Category to describe the role of a line item on a legacy invoice: - “charges” refers to charges being billed for on this invoice. - “credits” refers to refund or proration credits. This portion of the invoice can be considered a credit memo. - “applied_credits” refers to previous credits applied to this invoice. See their original_line_item_id to determine where the credit first originated. - “carryforwards” can be ignored. They exist to consume any remaining credit balance. A new credit with the same amount will be created and placed back on the account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Category to describe the role of a line item on a legacy invoice: - “charges” refers to charges being billed for on this invoice. - “credits” refers to refund or proration credits. This portion of the invoice can be considered a credit memo. - “applied_credits” refers to previous credits applied to this invoice. See their original_line_item_id to determine where the credit first originated. - “carryforwards” can be ignored. They exist to consume any remaining credit balance. A new credit with the same amount will be created and placed back on the account.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 99
+
+define_attribute:legacy_category,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 103
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #origin ⇒ String
+
+
+
+
+
+
+
+
+
Returns A credit created from an original charge will have the value of the charge's origin.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A credit created from an original charge will have the value of the charge's origin.
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 107
+
+define_attribute:origin,String
Returns The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 111
+
+define_attribute:original_line_item_invoice_id,String
+
+
+
+
+
+
+
+
+
+
+ #plan_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns If the line item is a charge or credit for a plan or add-on, this is the plan's code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If the line item is a charge or credit for a plan or add-on, this is the plan's code.
+
+
+
+
+
+
+
+
+
+
+
+
+115
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 115
+
+define_attribute:plan_code,String
+
+
+
+
+
+
+
+
+
+
+ #plan_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns If the line item is a charge or credit for a plan or add-on, this is the plan's ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If the line item is a charge or credit for a plan or add-on, this is the plan's ID.
+
+
+
+
+
+
+
+
+
+
+
+
+119
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 119
+
+define_attribute:plan_id,String
+
+
+
+
+
+
+
+
+
+
+ #previous_line_item_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
+
+
+
+
+
+
+
+
+
+
+
+
+123
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 123
+
+define_attribute:previous_line_item_id,String
+
+
+
+
+
+
+
+
+
+
+ #product_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line items it will be the item's `external_sku`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line items it will be the item's `external_sku`.
+
+
+
+
+
+
+
+
+
+
+
+
+127
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 127
+
+define_attribute:product_code,String
+
+
+
+
+
+
+
+
+
+
+ #proration_rate ⇒ Float
+
+
+
+
+
+
+
+
+
Returns When a line item has been prorated, this is the rate of the proration. Proration rates were made available for line items created after March 30, 2017. For line items created prior to that date, the proration rate will be `null`, even if the line item was prorated.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
When a line item has been prorated, this is the rate of the proration. Proration rates were made available for line items created after March 30, 2017. For line items created prior to that date, the proration rate will be `null`, even if the line item was prorated.
+
+
+
+
+
+
+
+
+
+
+
+
+131
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 131
+
+define_attribute:proration_rate,Float
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
+
+
+
+
+
+
+
+
+
+
+
+
+135
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 135
+
+define_attribute:quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #quantity_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
+
+
+
+
+
+
+
+
+
+
+
+
+139
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 139
+
+define_attribute:quantity_decimal,String
+
+
+
+
+
+
+
+
+
+
+ #refund ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Refund?.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Refund?
+
+
+
+
+
+
+
+
+
+
+
+
+143
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 143
+
+define_attribute:refund,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #refunded_quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
+
+
+
+
+
+
+
+
+
+
+
+
+147
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 147
+
+define_attribute:refunded_quantity,Integer
Returns A floating-point alternative to Refunded Quantity. For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). The Decimal Quantity feature must be enabled to utilize this field.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A floating-point alternative to Refunded Quantity. For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). The Decimal Quantity feature must be enabled to utilize this field.
+
+
+
+
+
+
+
+
+
+
+
+
+151
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 151
+
+define_attribute:refunded_quantity_decimal,String
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+155
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 155
+
+define_attribute:revenue_schedule_type,String
# File 'lib/recurly/resources/line_item.rb', line 159
+
+define_attribute:shipping_address,:ShippingAddress
+
+
+
+
+
+
+
+
+
+
+ #start_date ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date.
+
+
+
+
+
+
+
+
+
+
+
+
+163
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 163
+
+define_attribute:start_date,DateTime
+
+
+
+
+
+
+
+
+
+
+ #state ⇒ String
+
+
+
+
+
+
+
+
+
Returns Pending line items are charges or credits on an account that have not been applied to an invoice yet. Invoiced line items will always have an `invoice_id` value.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Pending line items are charges or credits on an account that have not been applied to an invoice yet. Invoiced line items will always have an `invoice_id` value.
+
+
+
+
+
+
+
+
+
+
+
+
+167
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 167
+
+define_attribute:state,String
+
+
+
+
+
+
+
+
+
+
+ #subscription_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns If the line item is a charge or credit for a subscription, this is its ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If the line item is a charge or credit for a subscription, this is its ID.
+
+
+
+
+
+
+
+
+
+
+
+
+171
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 171
+
+define_attribute:subscription_id,String
+
+
+
+
+
+
+
+
+
+
+ #subtotal ⇒ Float
+
+
+
+
+
+
+
+
+
Returns `quantity * unit_amount`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
`quantity * unit_amount`
+
+
+
+
+
+
+
+
+
+
+
+
+175
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 175
+
+define_attribute:subtotal,Float
+
+
+
+
+
+
+
+
+
+
+ #tax ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The tax amount for the line item.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The tax amount for the line item.
+
+
+
+
+
+
+
+
+
+
+
+
+179
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 179
+
+define_attribute:tax,Float
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+183
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 183
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
`true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
+
+
+
+
+
+
+
+
+
+
+
+
+187
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 187
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.
+
+
+
+
+
+
+
+
+
+
+
+
+191
+
+
+
# File 'lib/recurly/resources/line_item.rb', line 191
+
+define_attribute:tax_inclusive,:Boolean
Returns The bank account type. Only present for ACH payment methods.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The bank account type. Only present for ACH payment methods.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 11
+
+define_attribute:account_type,String
+
+
+
+
+
+
+
+
+
+
+ #billing_agreement_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 15
+
+define_attribute:billing_agreement_id,String
+
+
+
+
+
+
+
+
+
+
+ #card_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Visa, MasterCard, American Express, Discover, JCB, etc.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Visa, MasterCard, American Express, Discover, JCB, etc.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 19
+
+define_attribute:card_type,String
+
+
+
+
+
+
+
+
+
+
+ #cc_bin_country ⇒ String
+
+
+
+
+
+
+
+
+
Returns The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 23
+
+define_attribute:cc_bin_country,String
+
+
+
+
+
+
+
+
+
+
+ #exp_month ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Expiration month.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Expiration month.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 27
+
+define_attribute:exp_month,Integer
+
+
+
+
+
+
+
+
+
+
+ #exp_year ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Expiration year.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Expiration year.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 31
+
+define_attribute:exp_year,Integer
+
+
+
+
+
+
+
+
+
+
+ #first_six ⇒ String
+
+
+
+
+
+
+
+
+
Returns Credit card number's first six digits.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Credit card number's first six digits.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 35
+
+define_attribute:first_six,String
+
+
+
+
+
+
+
+
+
+
+ #gateway_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns An identifier for a specific payment gateway.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
An identifier for a specific payment gateway.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 39
+
+define_attribute:gateway_code,String
+
+
+
+
+
+
+
+
+
+
+ #gateway_token ⇒ String
+
+
+
+
+
+
+
+
+
Returns A token used in place of a credit card in order to perform transactions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A token used in place of a credit card in order to perform transactions.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 43
+
+define_attribute:gateway_token,String
+
+
+
+
+
+
+
+
+
+
+ #last_four ⇒ String
+
+
+
+
+
+
+
+
+
Returns Credit card number's last four digits. Will refer to bank account if payment method is ACH.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Credit card number's last four digits. Will refer to bank account if payment method is ACH.
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 47
+
+define_attribute:last_four,String
+
+
+
+
+
+
+
+
+
+
+ #last_two ⇒ String
+
+
+
+
+
+
+
+
+
Returns The IBAN bank account's last two digits.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The IBAN bank account's last two digits.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 51
+
+define_attribute:last_two,String
+
+
+
+
+
+
+
+
+
+
+ #name_on_account ⇒ String
+
+
+
+
+
+
+
+
+
Returns The name associated with the bank account.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The name associated with the bank account.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 55
+
+define_attribute:name_on_account,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 59
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #routing_number ⇒ String
+
+
+
+
+
+
+
+
+
Returns The bank account's routing number. Only present for ACH payment methods.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The bank account's routing number. Only present for ACH payment methods.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 63
+
+define_attribute:routing_number,String
+
+
+
+
+
+
+
+
+
+
+ #routing_number_bank ⇒ String
+
+
+
+
+
+
+
+
+
Returns The bank name of this routing number.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The bank name of this routing number.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 67
+
+define_attribute:routing_number_bank,String
+
+
+
+
+
+
+
+
+
+
+ #username ⇒ String
+
+
+
+
+
+
+
+
+
Returns Username of the associated payment method. Currently only associated with Venmo.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Username of the associated payment method. Currently only associated with Venmo.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/resources/payment_method.rb', line 71
+
+define_attribute:username,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/PercentageTier.html b/Recurly/Resources/PercentageTier.html
new file mode 100644
index 000000000..a2f3ed78a
--- /dev/null
+++ b/Recurly/Resources/PercentageTier.html
@@ -0,0 +1,350 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::PercentageTier
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/plan.rb', line 15
+
+define_attribute:allow_any_item_on_subscriptions,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #auto_renew ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/plan.rb', line 19
+
+define_attribute:auto_renew,:Boolean
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/plan.rb', line 43
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #deleted_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Deleted at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Deleted at
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/plan.rb', line 47
+
+define_attribute:deleted_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #description ⇒ String
+
+
+
+
+
+
+
+
+
Returns Optional description, not displayed.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Optional description, not displayed.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/plan.rb', line 51
+
+define_attribute:description,String
+
+
+
+
+
+
+
+
+
+
+ #dunning_campaign_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/plan.rb', line 55
+
+define_attribute:dunning_campaign_id,String
# File 'lib/recurly/resources/plan.rb', line 59
+
+define_attribute:hosted_pages,:PlanHostedPages
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Plan ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Plan ID
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/plan.rb', line 63
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #interval_length ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Length of the plan's billing interval in `interval_unit`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Length of the plan's billing interval in `interval_unit`.
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/resources/plan.rb', line 67
+
+define_attribute:interval_length,Integer
+
+
+
+
+
+
+
+
+
+
+ #interval_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns Unit for the plan's billing interval.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Unit for the plan's billing interval.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/resources/plan.rb', line 71
+
+define_attribute:interval_unit,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/plan.rb', line 75
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/resources/plan.rb', line 79
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #pricing_model ⇒ String
+
+
+
+
+
+
+
+
+
Returns A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/resources/plan.rb', line 83
+
+define_attribute:pricing_model,String
# File 'lib/recurly/resources/plan.rb', line 99
+
+define_attribute:setup_fee_revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #state ⇒ String
+
+
+
+
+
+
+
+
+
Returns The current state of the plan.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The current state of the plan.
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/resources/plan.rb', line 103
+
+define_attribute:state,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/resources/plan.rb', line 107
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #tax_exempt ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns `true` exempts tax on the plan, `false` applies tax on the plan.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
`true` exempts tax on the plan, `false` applies tax on the plan.
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/resources/plan.rb', line 111
+
+define_attribute:tax_exempt,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #total_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Automatically terminate subscriptions after a defined number of billing cycles. Number of billing cycles before the plan automatically stops renewing, defaults to `null` for continuous, automatic renewal.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Automatically terminate subscriptions after a defined number of billing cycles. Number of billing cycles before the plan automatically stops renewing, defaults to `null` for continuous, automatic renewal.
+
+
+
+
+
+
+
+
+
+
+
+
+115
+
+
+
# File 'lib/recurly/resources/plan.rb', line 115
+
+define_attribute:total_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #trial_length ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Length of plan's trial period in `trial_units`. `0` means `no trial`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Length of plan's trial period in `trial_units`. `0` means `no trial`.
+
+
+
+
+
+
+
+
+
+
+
+
+119
+
+
+
# File 'lib/recurly/resources/plan.rb', line 119
+
+define_attribute:trial_length,Integer
Returns Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+
+
+
+
+
+
+
+
+
+
+
+
+123
+
+
+
# File 'lib/recurly/resources/plan.rb', line 123
+
+define_attribute:trial_requires_billing_info,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #trial_unit ⇒ String
+
+
+
+
+
+
+
+
+
Returns Units for the plan's trial period.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Units for the plan's trial period.
+
+
+
+
+
+
+
+
+
+
+
+
+127
+
+
+
# File 'lib/recurly/resources/plan.rb', line 127
+
+define_attribute:trial_unit,String
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Last updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Last updated at
+
+
+
+
+
+
+
+
+
+
+
+
+131
+
+
+
# File 'lib/recurly/resources/plan.rb', line 131
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/PlanHostedPages.html b/Recurly/Resources/PlanHostedPages.html
new file mode 100644
index 000000000..d94bd7d35
--- /dev/null
+++ b/Recurly/Resources/PlanHostedPages.html
@@ -0,0 +1,518 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::PlanHostedPages
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/resources/plan_pricing.rb', line 11
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #setup_fee ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/plan_pricing.rb', line 15
+
+define_attribute:setup_fee,Float
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
This field is deprecated. Please do not use it.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/plan_pricing.rb', line 19
+
+define_attribute:tax_inclusive,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns This field should not be sent when the pricing model is 'ramp'.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
This field should not be sent when the pricing model is 'ramp'.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/plan_pricing.rb', line 23
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/PlanRampInterval.html b/Recurly/Resources/PlanRampInterval.html
new file mode 100644
index 000000000..81e9cb1fb
--- /dev/null
+++ b/Recurly/Resources/PlanRampInterval.html
@@ -0,0 +1,350 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::PlanRampInterval
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns - full: Full Address (Street, City, State, Postal Code and Country) - streetzip: Street and Postal Code only - zip: Postal Code only - none: No Address.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
full: Full Address (Street, City, State, Postal Code and Country) - streetzip: Street and Postal Code only - zip: Postal Code only - none: No Address
+
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/settings.rb', line 15
+
+define_attribute:billing_address_requirement,String
+
+
+
+
+
+
+
+
+
+
+ #default_currency ⇒ String
+
+
+
+
+
+
+
+
+
Returns The default 3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The default 3-letter ISO 4217 currency code.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/settings.rb', line 19
+
+define_attribute:default_currency,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/ShippingAddress.html b/Recurly/Resources/ShippingAddress.html
new file mode 100644
index 000000000..2a25c1cd6
--- /dev/null
+++ b/Recurly/Resources/ShippingAddress.html
@@ -0,0 +1,1604 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::ShippingAddress
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 11
+
+define_attribute:accounting_code,String
+
+
+
+
+
+
+
+
+
+
+ #code ⇒ String
+
+
+
+
+
+
+
+
+
Returns The internal name used identify the shipping method.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The internal name used identify the shipping method.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 15
+
+define_attribute:code,String
+
+
+
+
+
+
+
+
+
+
+ #created_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Created at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Created at
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 19
+
+define_attribute:created_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #deleted_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Deleted at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Deleted at
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 23
+
+define_attribute:deleted_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Shipping Method ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Shipping Method ID
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 27
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #name ⇒ String
+
+
+
+
+
+
+
+
+
Returns The name of the shipping method displayed to customers.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The name of the shipping method displayed to customers.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 31
+
+define_attribute:name,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 35
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #tax_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 39
+
+define_attribute:tax_code,String
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Last updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Last updated at
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/shipping_method.rb', line 43
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/ShippingMethodMini.html b/Recurly/Resources/ShippingMethodMini.html
new file mode 100644
index 000000000..b67044c27
--- /dev/null
+++ b/Recurly/Resources/ShippingMethodMini.html
@@ -0,0 +1,518 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::ShippingMethodMini
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 35
+
+define_attribute:bank_account_authorized_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #billing_info_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Billing Info ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Billing Info ID.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 39
+
+define_attribute:billing_info_id,String
+
+
+
+
+
+
+
+
+
+
+ #canceled_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Canceled at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Canceled at
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 43
+
+define_attribute:canceled_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #collection_method ⇒ String
+
+
+
+
+
+
+
+
+
Returns Collection method.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Collection method
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 47
+
+define_attribute:collection_method,String
+
+
+
+
+
+
+
+
+
+
+ #converted_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the subscription was converted from a gift card.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the subscription was converted from a gift card.
+
+
+
+
+
+
+
+
+
+
+
+
+51
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 51
+
+define_attribute:converted_at,DateTime
# File 'lib/recurly/resources/subscription.rb', line 71
+
+define_attribute:current_period_started_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #current_term_ends_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the term ends. This is calculated by a plan's interval and `total_billing_cycles` in a term. Subscription changes with a `timeframe=renewal` will be applied on this date.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the term ends. This is calculated by a plan's interval and `total_billing_cycles` in a term. Subscription changes with a `timeframe=renewal` will be applied on this date.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 75
+
+define_attribute:current_term_ends_at,DateTime
Returns The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing periods.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing periods.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 79
+
+define_attribute:current_term_started_at,DateTime
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+83
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 83
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #customer_notes ⇒ String
+
+
+
+
+
+
+
+
+
Returns Customer notes.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Customer notes
+
+
+
+
+
+
+
+
+
+
+
+
+87
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 87
+
+define_attribute:customer_notes,String
+
+
+
+
+
+
+
+
+
+
+ #expiration_reason ⇒ String
+
+
+
+
+
+
+
+
+
Returns Expiration reason.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Expiration reason
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 91
+
+define_attribute:expiration_reason,String
+
+
+
+
+
+
+
+
+
+
+ #expires_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Expires at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Expires at
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 95
+
+define_attribute:expires_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #gateway_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns If present, this subscription's transactions will use the payment gateway with this code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If present, this subscription's transactions will use the payment gateway with this code.
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 99
+
+define_attribute:gateway_code,String
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Subscription ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Subscription ID
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 103
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #net_terms ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 107
+
+define_attribute:net_terms,Integer
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+111
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 111
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #paused_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Null unless subscription is paused or will pause at the end of the current billing period.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Null unless subscription is paused or will pause at the end of the current billing period.
+
+
+
+
+
+
+
+
+
+
+
+
+115
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 115
+
+define_attribute:paused_at,DateTime
Returns The remaining billing cycles in the current term.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
The remaining billing cycles in the current term.
+
+
+
+
+
+
+
+
+
+
+
+
+139
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 139
+
+define_attribute:remaining_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #remaining_pause_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Null unless subscription is paused or will pause at the end of the current billing period.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Null unless subscription is paused or will pause at the end of the current billing period.
+
+
+
+
+
+
+
+
+
+
+
+
+143
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 143
+
+define_attribute:remaining_pause_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #renewal_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+
+
+
+
+
+
+
+
+
+
+
+
+147
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 147
+
+define_attribute:renewal_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+151
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 151
+
+define_attribute:revenue_schedule_type,String
# File 'lib/recurly/resources/subscription.rb', line 155
+
+define_attribute:shipping,:SubscriptionShipping
+
+
+
+
+
+
+
+
+
+
+ #started_with_gift ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Whether the subscription was started with a gift certificate.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Whether the subscription was started with a gift certificate.
+
+
+
+
+
+
+
+
+
+
+
+
+159
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 159
+
+define_attribute:started_with_gift,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #state ⇒ String
+
+
+
+
+
+
+
+
+
Returns State.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
State
+
+
+
+
+
+
+
+
+
+
+
+
+163
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 163
+
+define_attribute:state,String
+
+
+
+
+
+
+
+
+
+
+ #subtotal ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Estimated total, before tax.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Estimated total, before tax.
+
+
+
+
+
+
+
+
+
+
+
+
+167
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 167
+
+define_attribute:subtotal,Float
+
+
+
+
+
+
+
+
+
+
+ #tax ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Estimated tax.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Estimated tax
+
+
+
+
+
+
+
+
+
+
+
+
+171
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 171
+
+define_attribute:tax,Float
+
+
+
+
+
+
+
+
+
+
+ #tax_inclusive ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.
+
+
+
+
+
+
+
+
+
+
+
+
+175
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 175
+
+define_attribute:tax_inclusive,:Boolean
# File 'lib/recurly/resources/subscription.rb', line 179
+
+define_attribute:tax_info,:TaxInfo
+
+
+
+
+
+
+
+
+
+
+ #terms_and_conditions ⇒ String
+
+
+
+
+
+
+
+
+
Returns Terms and conditions.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Terms and conditions
+
+
+
+
+
+
+
+
+
+
+
+
+183
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 183
+
+define_attribute:terms_and_conditions,String
+
+
+
+
+
+
+
+
+
+
+ #total ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Estimated total.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Estimated total
+
+
+
+
+
+
+
+
+
+
+
+
+187
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 187
+
+define_attribute:total,Float
+
+
+
+
+
+
+
+
+
+
+ #total_billing_cycles ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+
+
+
+
+
+
+
+
+
+
+
+
+191
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 191
+
+define_attribute:total_billing_cycles,Integer
+
+
+
+
+
+
+
+
+
+
+ #trial_ends_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Trial period ends at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Trial period ends at
+
+
+
+
+
+
+
+
+
+
+
+
+195
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 195
+
+define_attribute:trial_ends_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #trial_started_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Trial period started at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Trial period started at
+
+
+
+
+
+
+
+
+
+
+
+
+199
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 199
+
+define_attribute:trial_started_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Subscription unit price.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Subscription unit price
+
+
+
+
+
+
+
+
+
+
+
+
+203
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 203
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Last updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Last updated at
+
+
+
+
+
+
+
+
+
+
+
+
+207
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 207
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #uuid ⇒ String
+
+
+
+
+
+
+
+
+
Returns The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+
+
+
+
+
+
+
+
+
+
+
+
+211
+
+
+
# File 'lib/recurly/resources/subscription.rb', line 211
+
+define_attribute:uuid,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/SubscriptionAddOn.html b/Recurly/Resources/SubscriptionAddOn.html
new file mode 100644
index 000000000..375fda9c0
--- /dev/null
+++ b/Recurly/Resources/SubscriptionAddOn.html
@@ -0,0 +1,1694 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::SubscriptionAddOn
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request.
# File 'lib/recurly/resources/subscription_add_on.rb', line 11
+
+define_attribute:add_on,:AddOnMini
+
+
+
+
+
+
+
+
+
+
+ #add_on_source ⇒ String
+
+
+
+
+
+
+
+
+
Returns Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 15
+
+define_attribute:add_on_source,String
+
+
+
+
+
+
+
+
+
+
+ #created_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Created at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Created at
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 19
+
+define_attribute:created_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #expired_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Expired at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Expired at
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 23
+
+define_attribute:expired_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Subscription Add-on ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Subscription Add-on ID
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 27
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 31
+
+define_attribute:object,String
Returns If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 35
+
+define_attribute:percentage_tiers,Array,{:item_type=>:SubscriptionAddOnPercentageTier}
+
+
+
+
+
+
+
+
+
+
+ #quantity ⇒ Integer
+
+
+
+
+
+
+
+
+
Returns Add-on quantity.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Add-on quantity
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 39
+
+define_attribute:quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #revenue_schedule_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Revenue schedule type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Revenue schedule type
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 43
+
+define_attribute:revenue_schedule_type,String
+
+
+
+
+
+
+
+
+
+
+ #subscription_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns Subscription ID.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Subscription ID
+
+
+
+
+
+
+
+
+
+
+
+
+47
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 47
+
+define_attribute:subscription_id,String
Returns If tiers are provided in the request, all existing tiers on the Subscription Add-on will be removed and replaced by the tiers in the request. If add_on.tier_type is tiered or volume and add_on.usage_type is percentage use percentage_tiers instead. There must be one tier without an `ending_quantity` value which represents the final tier.
If tiers are provided in the request, all existing tiers on the Subscription Add-on will be removed and replaced by the tiers in the request. If add_on.tier_type is tiered or volume and add_on.usage_type is percentage use percentage_tiers instead. There must be one tier without an `ending_quantity` value which represents the final tier.
+
+
+
+
+
+
+
+
+
+
+
+
+55
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 55
+
+define_attribute:tiers,Array,{:item_type=>:SubscriptionAddOnTier}
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Supports up to 2 decimal places.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Supports up to 2 decimal places.
+
+
+
+
+
+
+
+
+
+
+
+
+59
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 59
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Supports up to 9 decimal places.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Supports up to 9 decimal places.
+
+
+
+
+
+
+
+
+
+
+
+
+63
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 63
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Updated at
+
+
+
+
+
+
+
+
+
+
+
+
+67
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 67
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #usage_calculation_type ⇒ String
+
+
+
+
+
+
+
+
+
Returns The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
+
+
+
+
+
+
+
+
+
+
+
+
+71
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 71
+
+define_attribute:usage_calculation_type,String
+
+
+
+
+
+
+
+
+
+
+ #usage_percentage ⇒ Float
+
+
+
+
+
+
+
+
+
Returns The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if add_on_type is usage and usage_type is percentage.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if add_on_type is usage and usage_type is percentage.
+
+
+
+
+
+
+
+
+
+
+
+
+75
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 75
+
+define_attribute:usage_percentage,Float
+
+
+
+
+
+
+
+
+
+
+ #usage_timeframe ⇒ String
+
+
+
+
+
+
+
+
+
Returns The time at which usage totals are reset for billing purposes.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The time at which usage totals are reset for billing purposes.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+
+
+
# File 'lib/recurly/resources/subscription_add_on.rb', line 79
+
+define_attribute:usage_timeframe,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/SubscriptionAddOnPercentageTier.html b/Recurly/Resources/SubscriptionAddOnPercentageTier.html
new file mode 100644
index 000000000..fddfeba13
--- /dev/null
+++ b/Recurly/Resources/SubscriptionAddOnPercentageTier.html
@@ -0,0 +1,350 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::SubscriptionAddOnPercentageTier
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Integer)
+
+
+
+ —
+
+
Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/resources/subscription_add_on_tier.rb', line 11
+
+define_attribute:ending_quantity,Integer
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/subscription_add_on_tier.rb', line 15
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/subscription_add_on_tier.rb', line 19
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+ #usage_percentage ⇒ String
+
+
+
+
+
+
+
+
+
Returns (deprecated) – Use the percentage_tiers object instead.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
(deprecated) – Use the percentage_tiers object instead.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/subscription_add_on_tier.rb', line 23
+
+define_attribute:usage_percentage,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/SubscriptionChange.html b/Recurly/Resources/SubscriptionChange.html
new file mode 100644
index 000000000..d6d563516
--- /dev/null
+++ b/Recurly/Resources/SubscriptionChange.html
@@ -0,0 +1,1778 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::SubscriptionChange
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/subscription_change.rb', line 31
+
+define_attribute:custom_fields,Array,{:item_type=>:CustomField}
+
+
+
+
+
+
+
+
+
+
+ #deleted_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Deleted at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Deleted at
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/subscription_change.rb', line 35
+
+define_attribute:deleted_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The ID of the Subscription Change.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The ID of the Subscription Change.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/subscription_change.rb', line 39
+
+define_attribute:id,String
# File 'lib/recurly/resources/tax_info.rb', line 11
+
+define_attribute:rate,Float
+
+
+
+
+
+
+
+
+
+
+ #region ⇒ String
+
+
+
+
+
+
+
+
+
Returns Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/tax_info.rb', line 15
+
+define_attribute:region,String
Returns Provides additional tax details for Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItem.
Provides additional tax details for Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItem.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/tax_info.rb', line 19
+
+define_attribute:tax_details,Array,{:item_type=>:TaxDetail}
+
+
+
+
+
+
+
+
+
+
+ #type ⇒ String
+
+
+
+
+
+
+
+
+
Returns Provides the tax type as “vat” for EU VAT, “usst” for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Provides the tax type as “vat” for EU VAT, “usst” for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/tax_info.rb', line 23
+
+define_attribute:type,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/Tier.html b/Recurly/Resources/Tier.html
new file mode 100644
index 000000000..8a5c9bead
--- /dev/null
+++ b/Recurly/Resources/Tier.html
@@ -0,0 +1,434 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::Tier
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/resources/tier_pricing.rb', line 11
+
+define_attribute:currency,String
+
+
+
+
+
+
+
+
+
+
+ #unit_amount ⇒ Float
+
+
+
+
+
+
+
+
+
Returns Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/tier_pricing.rb', line 15
+
+define_attribute:unit_amount,Float
+
+
+
+
+
+
+
+
+
+
+ #unit_amount_decimal ⇒ String
+
+
+
+
+
+
+
+
+
Returns Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/tier_pricing.rb', line 19
+
+define_attribute:unit_amount_decimal,String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Resources/Transaction.html b/Recurly/Resources/Transaction.html
new file mode 100644
index 000000000..fafbff427
--- /dev/null
+++ b/Recurly/Resources/Transaction.html
@@ -0,0 +1,3349 @@
+
+
+
+
+
+
+ Class: Recurly::Resources::Transaction
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IP address provided when the billing information was collected: - When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address.
# File 'lib/recurly/resources/transaction.rb', line 87
+
+define_attribute:invoice,:InvoiceMini
+
+
+
+
+
+
+
+
+
+
+ #ip_address_country ⇒ String
+
+
+
+
+
+
+
+
+
Returns Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known by Recurly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known by Recurly.
+
+
+
+
+
+
+
+
+
+
+
+
+91
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 91
+
+define_attribute:ip_address_country,String
+
+
+
+
+
+
+
+
+
+
+ #ip_address_v4 ⇒ String
+
+
+
+
+
+
+
+
+
Returns IP address provided when the billing information was collected: - When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address. - When the merchant enters billing information using the API, the merchant may provide an IP address. - When the merchant enters billing information using the UI, no IP address is recorded.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
IP address provided when the billing information was collected: - When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address. - When the merchant enters billing information using the API, the merchant may provide an IP address. - When the merchant enters billing information using the UI, no IP address is recorded.
+
+
+
+
+
+
+
+
+
+
+
+
+95
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 95
+
+define_attribute:ip_address_v4,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+99
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 99
+
+define_attribute:object,String
+
+
+
+
+
+
+
+
+
+
+ #origin ⇒ String
+
+
+
+
+
+
+
+
+
Returns Describes how the transaction was triggered.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Describes how the transaction was triggered.
+
+
+
+
+
+
+
+
+
+
+
+
+103
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 103
+
+define_attribute:origin,String
+
+
+
+
+
+
+
+
+
+
+ #original_transaction_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.
+
+
+
+
+
+
+
+
+
+
+
+
+107
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 107
+
+define_attribute:original_transaction_id,String
# File 'lib/recurly/resources/transaction.rb', line 115
+
+define_attribute:payment_method,:PaymentMethod
+
+
+
+
+
+
+
+
+
+
+ #refunded ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Indicates if part or all of this transaction was refunded.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Indicates if part or all of this transaction was refunded.
+
+
+
+
+
+
+
+
+
+
+
+
+119
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 119
+
+define_attribute:refunded,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #status ⇒ String
+
+
+
+
+
+
+
+
+
Returns The current transaction status. Note that the status may change, e.g. a `pending` transaction may become `declined` or `success` may later become `void`.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The current transaction status. Note that the status may change, e.g. a `pending` transaction may become `declined` or `success` may later become `void`.
+
+
+
+
+
+
+
+
+
+
+
+
+123
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 123
+
+define_attribute:status,String
+
+
+
+
+
+
+
+
+
+
+ #status_code ⇒ String
+
+
+
+
+
+
+
+
+
Returns Status code.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Status code
+
+
+
+
+
+
+
+
+
+
+
+
+127
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 127
+
+define_attribute:status_code,String
+
+
+
+
+
+
+
+
+
+
+ #status_message ⇒ String
+
+
+
+
+
+
+
+
+
Returns For declined (`success=false`) transactions, the message displayed to the merchant.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
For declined (`success=false`) transactions, the message displayed to the merchant.
+
+
+
+
+
+
+
+
+
+
+
+
+131
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 131
+
+define_attribute:status_message,String
+
+
+
+
+
+
+
+
+
+
+ #subscription_ids ⇒ Array[String]
+
+
+
+
+
+
+
+
+
Returns If the transaction is charging or refunding for one or more subscriptions, these are their IDs.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Array[String])
+
+
+
+ —
+
+
If the transaction is charging or refunding for one or more subscriptions, these are their IDs.
+
+
+
+
+
+
+
+
+
+
+
+
+135
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 135
+
+define_attribute:subscription_ids,Array,{:item_type=>String}
+
+
+
+
+
+
+
+
+
+
+ #success ⇒ Boolean
+
+
+
+
+
+
+
+
+
Returns Did this transaction complete successfully?.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
Did this transaction complete successfully?
+
+
+
+
+
+
+
+
+
+
+
+
+139
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 139
+
+define_attribute:success,:Boolean
+
+
+
+
+
+
+
+
+
+
+ #type ⇒ String
+
+
+
+
+
+
+
+
+
Returns - `authorization` – verifies billing information and places a hold on money in the customer's account. - `capture` – captures funds held by an authorization and completes a purchase. - `purchase` – combines the authorization and capture in one transaction. - `refund` – returns all or a portion of the money collected in a previous transaction to the customer. - `verify` – a $0 or $1 transaction used to verify billing information which is immediately voided.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
`authorization` – verifies billing information and places a hold on money in the customer's account. - `capture` – captures funds held by an authorization and completes a purchase. - `purchase` – combines the authorization and capture in one transaction. - `refund` – returns all or a portion of the money collected in a previous transaction to the customer. - `verify` – a $0 or $1 transaction used to verify billing information which is immediately voided.
+
+
+
+
+
+
+
+
+
+
+
+
+
+143
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 143
+
+define_attribute:type,String
+
+
+
+
+
+
+
+
+
+
+ #updated_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Updated at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Updated at
+
+
+
+
+
+
+
+
+
+
+
+
+147
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 147
+
+define_attribute:updated_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #uuid ⇒ String
+
+
+
+
+
+
+
+
+
Returns The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+
+
+
+
+
+
+
+
+
+
+
+
+151
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 151
+
+define_attribute:uuid,String
+
+
+
+
+
+
+
+
+
+
+ #voided_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns Voided at.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
Voided at
+
+
+
+
+
+
+
+
+
+
+
+
+155
+
+
+
# File 'lib/recurly/resources/transaction.rb', line 155
+
+define_attribute:voided_at,DateTime
Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
Returns The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is “500”).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Float)
+
+
+
+ —
+
+
The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is “500”).
+
+
+
+
+
+
+
+
+
+
+
+
+11
+
+
+
# File 'lib/recurly/resources/usage.rb', line 11
+
+define_attribute:amount,Float
+
+
+
+
+
+
+
+
+
+
+ #billed_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the usage record was billed on an invoice.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the usage record was billed on an invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+15
+
+
+
# File 'lib/recurly/resources/usage.rb', line 15
+
+define_attribute:billed_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #created_at ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the usage record was created in Recurly.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the usage record was created in Recurly.
+
+
+
+
+
+
+
+
+
+
+
+
+19
+
+
+
# File 'lib/recurly/resources/usage.rb', line 19
+
+define_attribute:created_at,DateTime
+
+
+
+
+
+
+
+
+
+
+ #id ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+
+
+
+
+
+
+
+
+
+
+23
+
+
+
# File 'lib/recurly/resources/usage.rb', line 23
+
+define_attribute:id,String
+
+
+
+
+
+
+
+
+
+
+ #measured_unit_id ⇒ String
+
+
+
+
+
+
+
+
+
Returns The ID of the measured unit associated with the add-on the usage record is for.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
The ID of the measured unit associated with the add-on the usage record is for.
+
+
+
+
+
+
+
+
+
+
+
+
+27
+
+
+
# File 'lib/recurly/resources/usage.rb', line 27
+
+define_attribute:measured_unit_id,String
+
+
+
+
+
+
+
+
+
+
+ #merchant_tag ⇒ String
+
+
+
+
+
+
+
+
+
Returns Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+31
+
+
+
# File 'lib/recurly/resources/usage.rb', line 31
+
+define_attribute:merchant_tag,String
+
+
+
+
+
+
+
+
+
+
+ #object ⇒ String
+
+
+
+
+
+
+
+
+
Returns Object type.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (String)
+
+
+
+ —
+
+
Object type
+
+
+
+
+
+
+
+
+
+
+
+
+35
+
+
+
# File 'lib/recurly/resources/usage.rb', line 35
+
+define_attribute:object,String
Returns The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []. This feature is currently in development and requires approval and enablement, please contact support.
The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []. This feature is currently in development and requires approval and enablement, please contact support.
+
+
+
+
+
+
+
+
+
+
+
+
+39
+
+
+
# File 'lib/recurly/resources/usage.rb', line 39
+
+define_attribute:percentage_tiers,Array,{:item_type=>:SubscriptionAddOnPercentageTier}
+
+
+
+
+
+
+
+
+
+
+ #recording_timestamp ⇒ DateTime
+
+
+
+
+
+
+
+
+
Returns When the usage was recorded in your system.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (DateTime)
+
+
+
+ —
+
+
When the usage was recorded in your system.
+
+
+
+
+
+
+
+
+
+
+
+
+43
+
+
+
# File 'lib/recurly/resources/usage.rb', line 43
+
+define_attribute:recording_timestamp,DateTime
# File 'lib/recurly/schema.rb', line 41
+
+defself.get_recurly_class(type)
+ raiseArgumentError,"#{type.inspect} must be a symbol but is a #{type.class}"unlesstype.is_a?(Symbol)
+
+ iftype==:Address
+ Recurly::Resources::Address
+ elsifRecurly::Requests.const_defined?(type,false)
+ Recurly::Requests.const_get(type,false)
+ elsifRecurly::Resources.const_defined?(type,false)
+ Recurly::Resources.const_get(type,false)
+ else
+ raiseArgumentError,"Recurly type '#{type}' is unknown"
+ end
+end
# File 'lib/recurly/schema.rb', line 86
+
+definitialize(type=nil)
+ @type=type
+end
+
+
+
+
+
+
+
+
+
Instance Attribute Details
+
+
+
+
+
+
+ #type ⇒ Class, Symbol(readonly)
+
+
+
+
+
+
+
+
+
The type of the attribute. Might be a class like `DateTime` or could be a Recurly object. In this case a symbol should be used. Example: :Account. To get the Recurly type use #recurly_class
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Class, Symbol)
+
+
+
+
+
+
+
+
+
+
+
+
+
+60
+61
+62
+
+
+
# File 'lib/recurly/schema.rb', line 60
+
+deftype
+ @type
+end
Note: This module is for internal use. The RequestCaster turns mixed data into a pure Hash so it can be serialized into JSON and used as the body of a request. This module is to be extended by the Request class.
This method casts the data object (of mixed types) into a Hash ready for JSON serialization. The schema will default to the self's schema. You should pass in the schema where possible. This is because objects are serialized differently depending on the context in which they are being written.
# If you have some mixed data, like passing in an Address, it should cast that
+# address into a Hash based on the Schema defined in AccountUpdatable
+address=Recurly::Resources::Address.new(city:'New Orleans')
+Recurly::Requests::AccountUpdatable.cast(account_code:'benjamin',address:address)
+#=> {:account_code=>"benjamin", :address=>{:city=>"New Orleans"}}
# File 'lib/recurly/schema/resource_caster.rb', line 19
+
+defcast(attributes={})
+ resource=new()
+ attributes.eachdo|attr_name,val|
+ schema_attr=self.schema.get_attribute(attr_name)
+
+ ifschema_attr
+ val=ifval.nil?
+ val
+ elsifschema_attr.is_valid?(val)
+ schema_attr.cast(val)
+ else
+ ifRecurly::STRICT_MODE
+ msg="#{self.class}##{attr_name} does not have the right type. Value: #{val.inspect} was expected to be a #{schema_attr}"
+ raiseArgumentError,msg
+ end
+ end
+
+ writer="#{attr_name}="
+ resource.send(writer,val)
+ elsifRecurly::STRICT_MODE
+ raiseArgumentError,"#{resource.class.name} encountered json attribute #{attr_name.inspect}: #{val.inspect} but it's unknown to it's schema"
+ end
+ end
+ resource
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Schema/SchemaFactory.html b/Recurly/Schema/SchemaFactory.html
new file mode 100644
index 000000000..f68274763
--- /dev/null
+++ b/Recurly/Schema/SchemaFactory.html
@@ -0,0 +1,216 @@
+
+
+
+
+
+
+ Module: Recurly::Schema::SchemaFactory
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A mixin that allows a class to be treated like a recurly object. This gives the class the power to describe it's schema. It adds the define_attribute method and a schema reader.
This module is responsible for validating that the raw data passed in to attributes matches the schema belonging to this class. It should be mixed in to the Request class.
Recurly::Requests::PlanCreate.new(code:3.14).validate!
+#=> ArgumentError: Attribute 'code' on the resource Recurly::Requests::PlanCreate is type Float but should be a String.
+
+
+
Recurly::Requests::PlanCreate.new(kode:'plan123').validate!
+#=> ArgumentError: Attribute 'kode' does not exist on request Recurly::Requests::PlanCreate. Did you mean 'code'?
# File 'lib/recurly/schema/schema_validator.rb', line 20
+
+defvalidate!
+ attributes.eachdo|attr_name,val|
+ schema_attr=schema.get_attribute(attr_name)
+ ifschema_attr.nil?
+ err_msg="Attribute '#{attr_name}' does not exist on request #{self.class.name}."
+ ifdid_you_mean=get_did_you_mean(schema,attr_name)
+ err_msg<<" Did you mean '#{did_you_mean}'?"
+ end
+ raiseArgumentError,err_msg
+ else
+ validate_attribute!(attr_name,schema_attr,val)
+ end
+ end
+end
# File 'lib/recurly/schema/schema_validator.rb', line 36
+
+defvalidate_attribute!(name,schema_attr,val)
+ unlessval.nil?||schema_attr.is_valid?(val)
+ # If it's safely castable, the json deserializer or server
+# will take care of it for us
+unlesssafely_castable?(val.class,schema_attr.type)
+ expected=caseschema_attr
+ whenSchema::ArrayAttribute
+ "Array of #{schema_attr.type}s"
+ else
+ schema_attr.type
+ end
+
+ raiseArgumentError,"Attribute '#{name}' on the resource #{self.class.name} is type #{val.class} but should be a #{expected}"
+ end
+ end
+
+ # This is the convention for a recurly object
+ifschema_attr.is_a?(Schema::ResourceAttribute)&&val.is_a?(Hash)
+ # Using send because the initializer may be private
+instance=schema_attr.recurly_class.send(:new,val)
+ instance.validate!
+ end
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Recurly/Webhooks.html b/Recurly/Webhooks.html
new file mode 100644
index 000000000..892f5622b
--- /dev/null
+++ b/Recurly/Webhooks.html
@@ -0,0 +1,319 @@
+
+
+
+
+
+
+ Module: Recurly::Webhooks
+
+ — Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/recurly/webhooks.rb', line 20
+
+defself.verify_signature(header,secret,body,tolerance:DEFAULT_TOLERANCE)
+ s_timestamp,*signatures=header.split(",")
+ timestamp=Integer(s_timestamp)
+ now=(Time.now.to_f*1000).to_i
+
+ if(now-timestamp).abs>tolerance
+ raiseRecurly::Errors::SignatureVerificationError.new(
+ "Notification (#{Time.at(timestamp/1000.0)}) is more than #{tolerance/1000.0}s out of date"
+ )
+ end
+
+ expected=OpenSSL::HMAC.hexdigest("sha256",secret,"#{timestamp}.#{body}")
+
+ unlesssignatures.any?{|s|secure_compare(expected,s)}
+ raiseRecurly::Errors::SignatureVerificationError.new(
+ "No matching signatures found for payload"
+ )
+ end
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/_index.html b/_index.html
new file mode 100644
index 000000000..d4c2da564
--- /dev/null
+++ b/_index.html
@@ -0,0 +1,1861 @@
+
+
+
+
+
+
+ Documentation by YARD 0.9.34
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This repository houses the official ruby client for Recurly's V3 API.
+
+
Installing
+
+
In your Gemfile, add recurly as a dependency.
+
+
gem'recurly','~> 4.34'
+
+
+
+
Note: We try to follow semantic versioning and will only apply breaking changes to major versions.
+
+
+
Creating a client
+
+
A client represents a connection to the Recurly servers. Every call to the server exists as a method on this class. To initialize, you only need the private API key which can be obtained on the API Credentials Page.
If you 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:'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:'abcd7890')
+
+
+
Logging
+
+
The client constructor optionally accepts a logger provided by the programmer. The logger you pass should be an instance of ruby stdlib's Logger or follow the same interface. By default, the client creates a logger to STDOUT with level WARN.
+
+
require'logger'
+
+# Create a logger to STDOUT
+logger=Logger.new(STDOUT)
+logger.level=Logger::INFO
+
+# You could also use an existing logger
+# If you are using Rails you may want to use your application's logger
+logger=Rails.logger
+
+client=Recurly::Client.new(api_key:API_KEY,logger:logger)
+
+
+
+
SECURITY WARNING: The log level should never be set to DEBUG in production. This could potentially result in sensitive data in your logging system.
+
+
+
Operations
+
+
The Recurly::Client contains every operation you can perform on the site as a list of methods. Each method is documented explaining the types and descriptions for each input and return type. You can view all available operations by looking at the Instance Methods Summary list on the Recurly::Client documentation page. Clicking a method will give you detailed information about its inputs and returns. Take the create_account operation as an example: Recurly::Client#create_account.
+
+
Pagination
+
+
Pagination is done by the class Recurly::Pager. All list_* methods on the client return an instance of this class. The pager has an each method which accepts a block for each object in the entire list. Each page is fetched automatically for you presenting the elements as a single enumerable.
Both Pager#each and Pager#each_page return Enumerators if a block is not given. This allows you to use other Enumerator methods such as map or each_with_index.
+
+
plans=client.list_plans()
+plans.each_page.each_with_indexdo|data,page_num|
+ puts"Page Number #{page_num}"
+ data.eachdo|plan|
+ puts"Plan: #{plan.id}"
+ end
+end
+
+
+
Pagination endpoints take a number of options to sort and filter the results. They can be passed in as a hash provided by the :params keyword argument. The names, types, and descriptions of these arguments are listed in the rubydocs for each method:
+
+
options={
+ params:{
+ limit:200,# number of items per page
+state::active,# only active plans
+sort::updated_at,
+ order::asc,
+ begin_time:DateTime.new(2017,1,1),# January 1st 2017,
+end_time:DateTime.now
+ }
+}
+
+plans=client.list_plans(**options)
+plans.eachdo|plan|
+ puts"Plan: #{plan.id}"
+end
+
+
+
A note on limit:
+
+
limit defaults to 20 items per page and can be set from 1 to 200. Choosing a lower limit means more network requests but smaller payloads. We recommend keeping the default for most cases but increasing the limit if you are planning on iterating through many pages of items (e.g. all transactions in your site).
+
+
Efficiently Fetch the First or Last Resource
+
+
The Pager class implements a first method which allows you to fetch just the first or last resource from the server. On top of being a convenient abstraction, this is implemented efficiently by only asking the server for the 1 item you want.
The Pager class implements a count method which allows you to count the resources the pager would return. It does so by calling the endpoint with HEAD and parsing and returning the Recurly-Total-Records header. This method respects any filtering parameters you apply to the pager, but the sorting parameters will have no effect.
+
+
accounts=client.list_accounts(
+ subscriber:true,
+ begin_time:DateTime.new(2017,1,1)
+)
+
+# Calling count here will return an integer indicating
+# the number of subscribers since 2017
+count=accounts.count
+# => 573
+
+
+
Creating Resources
+
+
Currently, resources are created by passing in a body keyword argument in the form of a Hash. This Hash must follow the schema of the documented request type. For example, the create_plan operation takes a request of type Recurly::Requests::PlanCreate. Failing to conform to this schema will result in an argument error.
All errors thrown by this library are based off of the Recurly::Errors::APIError. There
+
+
This library throws one main type of exception, Recurly::Errors::APIError. There exists an additional hierarchy of errors to facilitate the process of rescuing various classes of errors. More detail can be found in the Api Errors Module.
+
+
You can catch specific or generic versions of these exceptions. Example:
Recurly::Errors::APIError instances provide access to the response via the #get_response method.
+
+
HTTP Metadata
+
+
Sometimes you might want to get some additional information about the underlying HTTP request and response. Instead of returning this information directly and forcing the programmer to unwrap it, we inject this metadata into the top level resource that was returned. You can access the Recurly::HTTP::Response by calling #get_response on any Recurly::Resource.
+
+
Warning: Do not log or render whole requests or responses as they may contain PII or sensitive data.
And it can be captured on exceptions through the Recurly::APIError object:
+
+
begin
+ account=client.get_account(account_id:"code-benjamin")
+rescueRecurly::Errors::NotFoundError=>e
+ response=e.get_response()
+ puts"Give this request id to Recurly Support: #{response.request_id}"
+end
+
+
+
Webhooks
+
+
Recurly can send webhooks to any publicly accessible server. When an event in Recurly triggers a webhook (e.g., an account is opened), Recurly will attempt to send this notification to the endpoint(s) you specify. You can specify up to 10 endpoints through the application. All notifications will be sent to all configured endpoints for your site.
+
+
See our product docs to learn more about webhooks and see our dev docs to learn about what payloads are available.
+
+
Although our API is now JSON, our webhook payloads are still formatted as XML for the time being. This library is not yet responsible for handling webhooks. If you do need webhooks, we recommend using a simple XML to Hash parser.
+
+
If you are using Rails, we'd recommend Hash.from_xml.
If you are not using Rails, we recommend you use nokogiri; however, heed security warnings about parse options. Although the XML should only be coming from Recurly, you should parse it as untrusted to be safe. Read more about the security implications of parsing untrusted XML in this OWASP cheatsheet.
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/file_list.html b/file_list.html
new file mode 100644
index 000000000..6f16ef17d
--- /dev/null
+++ b/file_list.html
@@ -0,0 +1,56 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File List
+
+
+
+
This repository houses the official ruby client for Recurly's V3 API.
+
+
Installing
+
+
In your Gemfile, add recurly as a dependency.
+
+
gem'recurly','~> 4.34'
+
+
+
+
Note: We try to follow semantic versioning and will only apply breaking changes to major versions.
+
+
+
Creating a client
+
+
A client represents a connection to the Recurly servers. Every call to the server exists as a method on this class. To initialize, you only need the private API key which can be obtained on the API Credentials Page.
If you 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:'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:'abcd7890')
+
+
+
Logging
+
+
The client constructor optionally accepts a logger provided by the programmer. The logger you pass should be an instance of ruby stdlib's Logger or follow the same interface. By default, the client creates a logger to STDOUT with level WARN.
+
+
require'logger'
+
+# Create a logger to STDOUT
+logger=Logger.new(STDOUT)
+logger.level=Logger::INFO
+
+# You could also use an existing logger
+# If you are using Rails you may want to use your application's logger
+logger=Rails.logger
+
+client=Recurly::Client.new(api_key:API_KEY,logger:logger)
+
+
+
+
SECURITY WARNING: The log level should never be set to DEBUG in production. This could potentially result in sensitive data in your logging system.
+
+
+
Operations
+
+
The Recurly::Client contains every operation you can perform on the site as a list of methods. Each method is documented explaining the types and descriptions for each input and return type. You can view all available operations by looking at the Instance Methods Summary list on the Recurly::Client documentation page. Clicking a method will give you detailed information about its inputs and returns. Take the create_account operation as an example: Recurly::Client#create_account.
+
+
Pagination
+
+
Pagination is done by the class Recurly::Pager. All list_* methods on the client return an instance of this class. The pager has an each method which accepts a block for each object in the entire list. Each page is fetched automatically for you presenting the elements as a single enumerable.
Both Pager#each and Pager#each_page return Enumerators if a block is not given. This allows you to use other Enumerator methods such as map or each_with_index.
+
+
plans=client.list_plans()
+plans.each_page.each_with_indexdo|data,page_num|
+ puts"Page Number #{page_num}"
+ data.eachdo|plan|
+ puts"Plan: #{plan.id}"
+ end
+end
+
+
+
Pagination endpoints take a number of options to sort and filter the results. They can be passed in as a hash provided by the :params keyword argument. The names, types, and descriptions of these arguments are listed in the rubydocs for each method:
+
+
options={
+ params:{
+ limit:200,# number of items per page
+state::active,# only active plans
+sort::updated_at,
+ order::asc,
+ begin_time:DateTime.new(2017,1,1),# January 1st 2017,
+end_time:DateTime.now
+ }
+}
+
+plans=client.list_plans(**options)
+plans.eachdo|plan|
+ puts"Plan: #{plan.id}"
+end
+
+
+
A note on limit:
+
+
limit defaults to 20 items per page and can be set from 1 to 200. Choosing a lower limit means more network requests but smaller payloads. We recommend keeping the default for most cases but increasing the limit if you are planning on iterating through many pages of items (e.g. all transactions in your site).
+
+
Efficiently Fetch the First or Last Resource
+
+
The Pager class implements a first method which allows you to fetch just the first or last resource from the server. On top of being a convenient abstraction, this is implemented efficiently by only asking the server for the 1 item you want.
The Pager class implements a count method which allows you to count the resources the pager would return. It does so by calling the endpoint with HEAD and parsing and returning the Recurly-Total-Records header. This method respects any filtering parameters you apply to the pager, but the sorting parameters will have no effect.
+
+
accounts=client.list_accounts(
+ subscriber:true,
+ begin_time:DateTime.new(2017,1,1)
+)
+
+# Calling count here will return an integer indicating
+# the number of subscribers since 2017
+count=accounts.count
+# => 573
+
+
+
Creating Resources
+
+
Currently, resources are created by passing in a body keyword argument in the form of a Hash. This Hash must follow the schema of the documented request type. For example, the create_plan operation takes a request of type Recurly::Requests::PlanCreate. Failing to conform to this schema will result in an argument error.
All errors thrown by this library are based off of the Recurly::Errors::APIError. There
+
+
This library throws one main type of exception, Recurly::Errors::APIError. There exists an additional hierarchy of errors to facilitate the process of rescuing various classes of errors. More detail can be found in the Api Errors Module.
+
+
You can catch specific or generic versions of these exceptions. Example:
Recurly::Errors::APIError instances provide access to the response via the #get_response method.
+
+
HTTP Metadata
+
+
Sometimes you might want to get some additional information about the underlying HTTP request and response. Instead of returning this information directly and forcing the programmer to unwrap it, we inject this metadata into the top level resource that was returned. You can access the Recurly::HTTP::Response by calling #get_response on any Recurly::Resource.
+
+
Warning: Do not log or render whole requests or responses as they may contain PII or sensitive data.
And it can be captured on exceptions through the Recurly::APIError object:
+
+
begin
+ account=client.get_account(account_id:"code-benjamin")
+rescueRecurly::Errors::NotFoundError=>e
+ response=e.get_response()
+ puts"Give this request id to Recurly Support: #{response.request_id}"
+end
+
+
+
Webhooks
+
+
Recurly can send webhooks to any publicly accessible server. When an event in Recurly triggers a webhook (e.g., an account is opened), Recurly will attempt to send this notification to the endpoint(s) you specify. You can specify up to 10 endpoints through the application. All notifications will be sent to all configured endpoints for your site.
+
+
See our product docs to learn more about webhooks and see our dev docs to learn about what payloads are available.
+
+
Although our API is now JSON, our webhook payloads are still formatted as XML for the time being. This library is not yet responsible for handling webhooks. If you do need webhooks, we recommend using a simple XML to Hash parser.
+
+
If you are using Rails, we'd recommend Hash.from_xml.
If you are not using Rails, we recommend you use nokogiri; however, heed security warnings about parse options. Although the XML should only be coming from Recurly, you should parse it as untrusted to be safe. Read more about the security implications of parsing untrusted XML in this OWASP cheatsheet.