Search code, repositories, users, issues, pull requests...

CreditNotePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

add_credit_note_to_subscription

CreditNotePagedMetadata add_credit_note_to_subscription(subscription_id, credit_note)

Creates a credit-note which may be used by only the specified subscription.

{"nickname":"Add Credit","request":"addCreditNoteToSubscriptionRequest.html", "response":"addCreditNoteToSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

credit_note = Bfwd::CreditSubscriptionRequest.new # CreditSubscriptionRequest | The credit-note request


begin
  #Creates a credit-note which may be used by only the specified subscription.
  result = api_instance.add_credit_note_to_subscription(subscription_id, credit_note)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->add_credit_note_to_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
credit_note	CreditSubscriptionRequest	The credit-note request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

add_payment_method_to_subscription

PaymentMethodPagedMetadata add_payment_method_to_subscription(subscription_id, payment_method)

Enables the payment method to pay invoices of this subscription.

{"nickname":"Add payment-method to subscription","response":"addPaymentMethod.html","request":"addPaymentMethod.request.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

payment_method = Bfwd::AddPaymentMethodRequest.new # AddPaymentMethodRequest | 


begin
  #Enables the payment method to pay invoices of this subscription.
  result = api_instance.add_payment_method_to_subscription(subscription_id, payment_method)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->add_payment_method_to_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
payment_method	AddPaymentMethodRequest

Return type

TimeResponsePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

advance_subscription

TimeResponsePagedMetadata advance_subscription(subscription_id, request)

Advance the subscription through time.

{"nickname":"Advance","request":"advanceSubscriptionRequest.html","response":"advanceSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

request = Bfwd::TimeRequest.new # TimeRequest | The request


begin
  #Advance the subscription through time.
  result = api_instance.advance_subscription(subscription_id, request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->advance_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
request	TimeRequest	The request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

available_payment_methods_for_subscription

PaymentMethodPagedMetadata available_payment_methods_for_subscription(subscription_id, opts)

Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order.

{ "nickname" : "List on subscription","response" : "getAvailablePaymentMethods.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "id", # String | Specify a field used to order the result set.
  order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
}

begin
  #Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.available_payment_methods_for_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->available_payment_methods_for_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to id]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

batch_create_subscriptions

SubscriptionPagedMetadata batch_create_subscriptions(request)

Create multiple subscriptions.

{"nickname":"Create multiple subscriptions","response":"createMultipleSubscriptionViaHelper.html","request":"createMultipleSubscriptionViaHelper.request.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

request = Bfwd::CreateSubscriptionBatchRequest.new # CreateSubscriptionBatchRequest | 


begin
  #Create multiple subscriptions.
  result = api_instance.batch_create_subscriptions(request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->batch_create_subscriptions: #{e}"
end

Parameters

Name	Type	Description	Notes
request	CreateSubscriptionBatchRequest

Return type

SubscriptionCancellationPagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

cancel_subscription

SubscriptionCancellationPagedMetadata cancel_subscription(subscription_id, subscription_cancellation)

Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product.

{"nickname":"Cancel subscription","response":"deleteSubscription.html","request":"deleteSubscriptionRequest.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

subscription_cancellation = Bfwd::CancelSubscriptionRequest.new # CancelSubscriptionRequest | The cancellation request


begin
  #Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product.
  result = api_instance.cancel_subscription(subscription_id, subscription_cancellation)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->cancel_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
subscription_cancellation	CancelSubscriptionRequest	The cancellation request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

create_aggregating_subscription

SubscriptionPagedMetadata create_aggregating_subscription(request)

Create an aggregating subscription.

{"nickname":"Create aggregating subscription","response":"createAggregatingSubscription.html","request":"createAggregatingSubscription.request.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

request = Bfwd::CreateAggregatingSubscriptionRequest.new # CreateAggregatingSubscriptionRequest | 


begin
  #Create an aggregating subscription.
  result = api_instance.create_aggregating_subscription(request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->create_aggregating_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
request	CreateAggregatingSubscriptionRequest

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

create_subscription

SubscriptionPagedMetadata create_subscription(subscription)

Create a new subscription.

{"nickname":"Create a new subscription","request":"createSubscriptionRequest.html","response":"createSubscriptionResponse.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription = Bfwd::Subscription.new # Subscription | The subscription object to be updated.


begin
  #Create a new subscription.
  result = api_instance.create_subscription(subscription)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->create_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription	Subscription	The subscription object to be updated.

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: text/xml, application/xml, application/json; charset=utf-8

create_subscription_v2

SubscriptionPagedMetadata create_subscription_v2(request)

Create a subscription (V2).

{"nickname":"Create a subscription (V2)","response":"createSubscriptionViaHelper.html","request":"createSubscriptionViaHelper.request.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

request = Bfwd::CreateSubscriptionRequest.new # CreateSubscriptionRequest | 


begin
  #Create a subscription (V2).
  result = api_instance.create_subscription_v2(request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->create_subscription_v2: #{e}"
end

Parameters

Name	Type	Description	Notes
request	CreateSubscriptionRequest

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

create_timer

TimerAmendment create_timer(subscription_id, request)

Create a timer for a subscription event.

{"nickname":"Create Timer","response":"createSubscriptionTimer.html","request":"createSubscriptionTimer.request.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

request = Bfwd::BillingEntityBase.new # BillingEntityBase | 


begin
  #Create a timer for a subscription event.
  result = api_instance.create_timer(subscription_id, request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->create_timer: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
request	BillingEntityBase

Return type

TimerAmendment

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

delete_metadata_for_subscription

DynamicMetadata delete_metadata_for_subscription(subscription_id, opts)

Remove any associated metadata.

{"nickname":"Clear from subscription","request" :"deleteSubscriptionMetadataRequest.html","response":"deleteSubscriptionMetadataResponse.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Remove any associated metadata.
  result = api_instance.delete_metadata_for_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->delete_metadata_for_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

freeze_subscription

SubscriptionPagedMetadata freeze_subscription(subscription_id, request)

Freeze the subscription.

{"nickname":"Freeze","request":"freezeSubscriptionRequest.html","response":"freezeSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

request = Bfwd::PauseRequest.new # PauseRequest | The request


begin
  #Freeze the subscription.
  result = api_instance.freeze_subscription(subscription_id, request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->freeze_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
request	PauseRequest	The request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_all_subscriptions

SubscriptionPagedMetadata get_all_subscriptions(opts)

Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve all subscriptions","response":"getSubscriptionAll.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
  exclude_children: true, # BOOLEAN | Should child subscriptiosn be excluded.
  metadata: "metadata_example", # String | 
  exclude_service_ended: true, # BOOLEAN | 
  account_id: ["account_id_example"] # Array<String> | A list of accountIDs to filter subscriptions on
}

begin
  #Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_all_subscriptions(opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_all_subscriptions: #{e}"
end

Parameters

Name	Type	Description	Notes
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	BOOLEAN	Should child subscriptiosn be excluded.	[optional] [default to true]
metadata	String		[optional]
exclude_service_ended	BOOLEAN		[optional]
account_id	Array<String>	A list of accountIDs to filter subscriptions on	[optional]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_applicable_coupons_for_subscription

CouponPagedMetadata get_applicable_coupons_for_subscription(subscription_id, opts)

Retrieves a collection of the coupons which can be applied to this subscription.

{ "nickname" : "Retrieve applicable coupons","response" : "getApplicableCoupons.html" }

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
}

begin
  #Retrieves a collection of the coupons which can be applied to this subscription.
  result = api_instance.get_applicable_coupons_for_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_applicable_coupons_for_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

CreditNotePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_available_credit_subscription

CreditNotePagedMetadata get_available_credit_subscription(subscription_id, opts)

Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Get available credit","response":"getAvailableCreditSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "id", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
}

begin
  #Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_available_credit_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_available_credit_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to id]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_charges_on_subscription

SubscriptionChargePagedMetadata get_charges_on_subscription(subscription_id, opts)

Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Get charges","response":"getChargesSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  state: "state_example", # String | Ihe direction of any ordering, either ASC or DESC.
  type: "type_example", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
}

begin
  #Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_charges_on_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_charges_on_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
state	String	Ihe direction of any ordering, either ASC or DESC.	[optional]
type	String	Ihe direction of any ordering, either ASC or DESC.	[optional]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

SubscriptionChargePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_children_of_subscription

SubscriptionPagedMetadata get_children_of_subscription(subscription_id, opts)

Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order.

{"nickname":"Get Aggregated Entities","response":"getAggregatedEntities.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
}

begin
  #Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_children_of_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_children_of_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_coupons_on_subscription

CouponPagedMetadata get_coupons_on_subscription(subscription_id, opts)

Retrieves a collection of the coupons and the unique codes currently applied to the subscription.

{"nickname":"Retrieve coupons","response":"getCoupons.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
}

begin
  #Retrieves a collection of the coupons and the unique codes currently applied to the subscription.
  result = api_instance.get_coupons_on_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_coupons_on_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_invoices_for_subscription_by_state

InvoicePagedMetadata get_invoices_for_subscription_by_state(subscription_id, state, opts)

Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve invoices by state for subscription","response":"getInvoicesForSubscriptionByState.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | The unique id of the subscription.

state = "state_example" # String | The state of the invoices to retrieve.

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first taxation-link to return.
  records: 10, # Integer | The maximum number of taxation-links to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
}

begin
  #Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_invoices_for_subscription_by_state(subscription_id, state, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_invoices_for_subscription_by_state: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	The unique id of the subscription.
state	String	The state of the invoices to retrieve.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first taxation-link to return.	[optional] [default to 0]
records	Integer	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

InvoicePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_metadata_for_subscription

DynamicMetadata get_metadata_for_subscription(subscription_id, opts)

Retrieve any associated metadata.

{"nickname":"Retrieve on subscription","request":"getSubscriptionMetadataRequest.html","response":"getSubscriptionMetadataResponse.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Retrieve any associated metadata.
  result = api_instance.get_metadata_for_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_metadata_for_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_parent_subscription

SubscriptionPagedMetadata get_parent_subscription(subscription_id, opts)

Return the parent of the given subscription.

{"nickname":"Get parent","response":"getParentSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Return the parent of the given subscription.
  result = api_instance.get_parent_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_parent_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

PricingComponentValuePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_pricing_component_values_of_subscription

PricingComponentValuePagedMetadata get_pricing_component_values_of_subscription(subscription_id)

Gets the subscription's current pricing-component values.

{"nickname":"Get values","response":"getPricingComponentValues.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.


begin
  #Gets the subscription's current pricing-component values.
  result = api_instance.get_pricing_component_values_of_subscription(subscription_id)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_pricing_component_values_of_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscription_by_account_id

SubscriptionPagedMetadata get_subscription_by_account_id(account_id, opts)

Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by account","response":"getSubscriptionByAccount.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

account_id = "account_id_example" # String | 

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "id", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
  exclude_children: true # BOOLEAN | Should child subscriptiosn be excluded.
}

begin
  #Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_subscription_by_account_id(account_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscription_by_account_id: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to id]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	BOOLEAN	Should child subscriptiosn be excluded.	[optional] [default to true]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscription_by_id

SubscriptionPagedMetadata get_subscription_by_id(subscription_id, opts)

Retrieves a single subscription, specified by the ID parameter.

{"nickname":"Retrieve an existing subscription","response":"getSubscriptionByID.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
}

begin
  #Retrieves a single subscription, specified by the ID parameter.
  result = api_instance.get_subscription_by_id(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscription_by_id: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscription_by_product_id

SubscriptionPagedMetadata get_subscription_by_product_id(product_id, opts)

Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by product","response":"getSubscriptionByProduct.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

product_id = "product_id_example" # String | ID of the product

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "id", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
  exclude_children: true # BOOLEAN | Should child subscriptiosn be excluded.
}

begin
  #Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_subscription_by_product_id(product_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscription_by_product_id: #{e}"
end

Parameters

Name	Type	Description	Notes
product_id	String	ID of the product
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to id]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	BOOLEAN	Should child subscriptiosn be excluded.	[optional] [default to true]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscription_by_product_rate_plan_id

SubscriptionPagedMetadata get_subscription_by_product_rate_plan_id(product_rate_plan_id, opts)

Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by rate-plan","response":"getSubscriptionByProductRatePlan.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

product_rate_plan_id = "product_rate_plan_id_example" # String | 

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "id", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
  exclude_children: true # BOOLEAN | Should child subscriptiosn be excluded.
}

begin
  #Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_subscription_by_product_rate_plan_id(product_rate_plan_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscription_by_product_rate_plan_id: #{e}"
end

Parameters

Name	Type	Description	Notes
product_rate_plan_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to id]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	BOOLEAN	Should child subscriptiosn be excluded.	[optional] [default to true]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscription_by_state

SubscriptionPagedMetadata get_subscription_by_state(state, opts)

Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by state","response":"getSubscriptionByState.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

state = "state_example" # String | The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "id", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false, # BOOLEAN | Whether retired subscriptions should be returned.
  exclude_children: true # BOOLEAN | Should child subscriptiosn be excluded.
}

begin
  #Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_subscription_by_state(state, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscription_by_state: #{e}"
end

Parameters

Name	Type	Description	Notes
state	String	The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to id]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	BOOLEAN	Should child subscriptiosn be excluded.	[optional] [default to true]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscription_by_version_id

SubscriptionPagedMetadata get_subscription_by_version_id(version_id, opts)

Retrieves a single subscription, specified by the version-ID parameter.

{"nickname":"Retrieve by version","response":"getSubscriptionByVersionID.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

version_id = "version_id_example" # String | The version-ID of the subscription.

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Retrieves a single subscription, specified by the version-ID parameter.
  result = api_instance.get_subscription_by_version_id(version_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscription_by_version_id: #{e}"
end

Parameters

Name	Type	Description	Notes
version_id	String	The version-ID of the subscription.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscriptions_by_initial_period_start

SubscriptionPagedMetadata get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, opts)

Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by initial period-start","response":"getSubscriptionByInitialPeriodStart.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.

upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first taxation-link to return.
  records: 10, # Integer | The maximum number of taxation-links to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
}

begin
  #Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscriptions_by_initial_period_start: #{e}"
end

Parameters

Name	Type	Description	Notes
lower_threshold	String	The UTC DateTime specifying the start of the result period.
upper_threshold	String	The UTC DateTime specifying the end of the result period.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first taxation-link to return.	[optional] [default to 0]
records	Integer	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscriptions_by_period_end

SubscriptionPagedMetadata get_subscriptions_by_period_end(lower_threshold, upper_threshold, opts)

Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by period-end","response":"getSubscriptionByPeriodEnd.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.

upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first taxation-link to return.
  records: 10, # Integer | The maximum number of taxation-links to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
}

begin
  #Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_subscriptions_by_period_end(lower_threshold, upper_threshold, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscriptions_by_period_end: #{e}"
end

Parameters

Name	Type	Description	Notes
lower_threshold	String	The UTC DateTime specifying the start of the result period.
upper_threshold	String	The UTC DateTime specifying the end of the result period.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first taxation-link to return.	[optional] [default to 0]
records	Integer	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscriptions_by_period_start

SubscriptionPagedMetadata get_subscriptions_by_period_start(lower_threshold, upper_threshold, opts)

Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by period-start","response":"getSubscriptionByPeriodStart.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.

upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first taxation-link to return.
  records: 10, # Integer | The maximum number of taxation-links to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
}

begin
  #Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_subscriptions_by_period_start(lower_threshold, upper_threshold, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscriptions_by_period_start: #{e}"
end

Parameters

Name	Type	Description	Notes
lower_threshold	String	The UTC DateTime specifying the start of the result period.
upper_threshold	String	The UTC DateTime specifying the end of the result period.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first taxation-link to return.	[optional] [default to 0]
records	Integer	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_subscriptions_by_successful_periods

SubscriptionPagedMetadata get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, opts)

Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by successful period","response":"getSubscriptionBySuccessfulPeriods.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

lower_threshold = 56 # Integer | The lower threshold of the range

upper_threshold = 56 # Integer | The upper threshold of the range.

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first taxation-link to return.
  records: 10, # Integer | The maximum number of taxation-links to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
}

begin
  #Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_subscriptions_by_successful_periods: #{e}"
end

Parameters

Name	Type	Description	Notes
lower_threshold	Integer	The lower threshold of the range
upper_threshold	Integer	The upper threshold of the range.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first taxation-link to return.	[optional] [default to 0]
records	Integer	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_swagger_subscription

SwaggerTypeListSubs get_swagger_subscription(query_string, opts)

{ "nickname" : "","response" : ""}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

query_string = "query_string_example" # String | The query string used to search.

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The starting index of the search results.
  records: 10, # Integer | The number of search results to return.
  format: "JSON", # String | The response format, either JSON or XML.
  wildcard: false, # BOOLEAN | Toggle if we search for full words or whether a wildcard is used.
  entity: false # BOOLEAN | Is an entity returned with the search results.
}

begin
  #
  result = api_instance.get_swagger_subscription(query_string, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_swagger_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
query_string	String	The query string used to search.
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The starting index of the search results.	[optional] [default to 0]
records	Integer	The number of search results to return.	[optional] [default to 10]
format	String	The response format, either JSON or XML.	[optional] [default to JSON]
wildcard	BOOLEAN	Toggle if we search for full words or whether a wildcard is used.	[optional] [default to false]
entity	BOOLEAN	Is an entity returned with the search results.	[optional] [default to false]

Return type

SwaggerTypeListSubs

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_timers_for_subscription

TimerAmendment get_timers_for_subscription(subscription_id, opts)

Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Get Timers","response":"getTimersforSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
  offset: 0, # Integer | The offset from the first subscription to return.
  records: 10, # Integer | The maximum number of subscriptions to return.
  order_by: "created", # String | Specify a field used to order the result set.
  order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
  include_retired: false, # BOOLEAN | Whether retired timers should be returned.
  state: "state_example", # String | The state of the timer amendment
  event: "event_example" # String | The type of timer event
}

begin
  #Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order.
  result = api_instance.get_timers_for_subscription(subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->get_timers_for_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	Integer	The offset from the first subscription to return.	[optional] [default to 0]
records	Integer	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	String	Specify a field used to order the result set.	[optional] [default to created]
order	String	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	BOOLEAN	Whether retired timers should be returned.	[optional] [default to false]
state	String	The state of the timer amendment	[optional]
event	String	The type of timer event	[optional]

Return type

TimerAmendment

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

import_subscription

SubscriptionPagedMetadata import_subscription(request)

Import a subscription.

{"nickname":"Import","request":"importSubscriptionRequest.html","response":"importSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

request = Bfwd::BillingEntityBase.new # BillingEntityBase | The request


begin
  #Import a subscription.
  result = api_instance.import_subscription(request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->import_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
request	BillingEntityBase	The request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

invoice_charges_on_subscription

InvoicePagedMetadata invoice_charges_on_subscription(subscription_id, charge)

Invoice any outstanding charges for the subscription.

{"nickname":"Invoice Charges","request":"invoiceChargesRequest.html","response":"invoiceCharges.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

charge = Bfwd::InvoiceChargeRequest.new # InvoiceChargeRequest | The charge request


begin
  #Invoice any outstanding charges for the subscription.
  result = api_instance.invoice_charges_on_subscription(subscription_id, charge)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->invoice_charges_on_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
charge	InvoiceChargeRequest	The charge request

Return type

InvoicePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

migrate_subscription

SubscriptionPagedMetadata migrate_subscription(subscription_id, request)

Migrate the subscription to a new plan.

{"nickname":"Migrate","request":"migrateSubscriptionRequest.html", "response":"migrateSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

request = Bfwd::MigrationRequest.new # MigrationRequest | The migration request


begin
  #Migrate the subscription to a new plan.
  result = api_instance.migrate_subscription(subscription_id, request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->migrate_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
request	MigrationRequest	The migration request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

remove_coupon_from_subscription

CouponPagedMetadata remove_coupon_from_subscription(subscription_id, coupon_code, opts)

Removes the coupon from the subscription.

{"nickname":"Remove coupon","response":"removeCouponResponse.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

coupon_code = "coupon_code_example" # String | 

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Removes the coupon from the subscription.
  result = api_instance.remove_coupon_from_subscription(subscription_id, coupon_code, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->remove_coupon_from_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
coupon_code	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

CreditNotePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

remove_credit_from_subscription

CreditNotePagedMetadata remove_credit_from_subscription(subscription_id, value, opts)

Decrease the amount of credit available to the specified subscription.

{"nickname":"Remove Credit","response":"removeCreditForSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

value = "value_example" # String | <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed.</p><p>If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86  would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.</p>

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Decrease the amount of credit available to the specified subscription.
  result = api_instance.remove_credit_from_subscription(subscription_id, value, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->remove_credit_from_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
value	String	<p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed.</p><p>If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86 would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.</p>
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

remove_payment_method_from_subscription

PaymentMethodPagedMetadata remove_payment_method_from_subscription(subscription_id, payment_method_id, opts)

Removes the specified payment method for the given subscription.

{"nickname":"Remove payment-method","response":"removePaymentMethod.html","request":"removePaymentMethod.request.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

payment_method_id = "payment_method_id_example" # String | 

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Removes the specified payment method for the given subscription.
  result = api_instance.remove_payment_method_from_subscription(subscription_id, payment_method_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->remove_payment_method_from_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
payment_method_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

remove_pricing_component_value_change_from_subscription

PaymentMethodPagedMetadata remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, opts)

Discards from the subscription any scheduled changes in the value of the specified pricing-component.

{"nickname":"Discard value changes","response":"removePricingComponentValueChange.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

pricing_component = "pricing_component_example" # String | 

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Discards from the subscription any scheduled changes in the value of the specified pricing-component.
  result = api_instance.remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->remove_pricing_component_value_change_from_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
pricing_component	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json; charset=utf-8
Accept: application/json; charset=utf-8

resume_subscription

SubscriptionPagedMetadata resume_subscription(subscription_id, request)

Resume the frozen subscription.

{"nickname":"Resume","request":"resumeSubscriptionRequest.html","response":"resumeSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

request = Bfwd::ResumeRequest.new # ResumeRequest | The request


begin
  #Resume the frozen subscription.
  result = api_instance.resume_subscription(subscription_id, request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->resume_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
request	ResumeRequest	The request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

revive_subscription

SubscriptionPagedMetadata revive_subscription(subscription_id, request)

Revives a cancelled subscription and returns it to its previous state

{"nickname":"Revive subscription","request":"reviveSubscriptionRequest.html", "response":"reviveSubscription.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

request = Bfwd::ReviveSubscriptionRequest.new # ReviveSubscriptionRequest | The revive request


begin
  #Revives a cancelled subscription and returns it to its previous state
  result = api_instance.revive_subscription(subscription_id, request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->revive_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String
request	ReviveSubscriptionRequest	The revive request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

set_metadata_for_subscription

DynamicMetadata set_metadata_for_subscription(metadata, subscription_id, opts)

Remove any existing metadata keys and create the provided data.

{"nickname":"Set on subscription","request":"setSubscriptionMetadataRequest.html","response":"setSubscriptionMetadataResponse.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

metadata = Bfwd::DynamicMetadata.new # DynamicMetadata | 

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Remove any existing metadata keys and create the provided data.
  result = api_instance.set_metadata_for_subscription(metadata, subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->set_metadata_for_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
metadata	DynamicMetadata
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

PricingComponentValuePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

set_pricing_component_value_on_subscription

PricingComponentValuePagedMetadata set_pricing_component_value_on_subscription(subscription_id, pricing_component_value)

Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.

{"nickname":"Set values","request":"setPricingComponentValuesRequest.html","response":"setPricingComponentValues.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription.

pricing_component_value = Bfwd::PricingComponentValue.new # PricingComponentValue | The pricing-component-value request


begin
  #Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.
  result = api_instance.set_pricing_component_value_on_subscription(subscription_id, pricing_component_value)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription.
pricing_component_value	PricingComponentValue	The pricing-component-value request

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

set_pricing_component_value_on_subscription_batch_update

UpdatePricingComponentValueResponsePagedMetadata set_pricing_component_value_on_subscription_batch_update(subscription_id, request)

Upgrades/downgrades this subscription to some new value for the specified pricing-component. This endpoint can do synchronous (immediate) and asynchronous (delayed) updates. A synchronous update will generate a charge/credit for an UPGRADE or DOWNGRADE. An asynchronous update will generate an amendment scheduled for the end of the billing period. By default each update is considered synchronous, you can make them asynchronous setting 'applyChangeNow' to 'false'.

{"nickname":"Set values","request":"setBatchPricingComponentValueRequest.html","response":"setBatchPricingComponentValue.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | ID of the subscription

request = Bfwd::BatchUpdatePricingComponentValuesRequest.new # BatchUpdatePricingComponentValuesRequest | The batched update requests.


begin
  #Upgrades/downgrades this subscription to some new value for the specified pricing-component. This endpoint can do synchronous (immediate) and asynchronous (delayed) updates. A synchronous update will generate a charge/credit for an UPGRADE or DOWNGRADE. An asynchronous update will generate an amendment scheduled for the end of the billing period. By default each update is considered synchronous, you can make them asynchronous setting 'applyChangeNow' to 'false'.
  result = api_instance.set_pricing_component_value_on_subscription_batch_update(subscription_id, request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_batch_update: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription_id	String	ID of the subscription
request	BatchUpdatePricingComponentValuesRequest	The batched update requests.

Return type

UpdatePricingComponentValueResponsePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

set_pricing_component_value_on_subscription_v2

PricingComponentValueResponsePagedMetadata set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value)

Upgrades/downgrades this subscription to some new value for the specified pricing-component.

{"nickname":"Set value","request":"setPricingComponentValueRequest.html","response":"setPricingComponentValue.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription_id = "subscription_id_example" # String | 

pricing_component = "pricing_component_example" # String | Name or ID of the pricing-component.

value = Bfwd::PricingComponentValueRequest.new # PricingComponentValueRequest | The pricing-component-value request


begin
  #Upgrades/downgrades this subscription to some new value for the specified pricing-component.
  result = api_instance.set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_v2: #{e}"
end

Parameters

Name	Type	Description
subscription_id	String
pricing_component	String	Name or ID of the pricing-component.
value	PricingComponentValueRequest	The pricing-component-value request

Return type

PricingComponentValueResponsePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

update_subscription

SubscriptionPagedMetadata update_subscription(subscription)

Update a subscription.

{"nickname":"Update a subscription","request":"updateSubscriptionRequest.html","response":"updateSubscriptionResponse.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

subscription = Bfwd::Subscription.new # Subscription | The subscription object to be updated.


begin
  #Update a subscription.
  result = api_instance.update_subscription(subscription)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->update_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
subscription	Subscription	The subscription object to be updated.

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: text/xml, application/xml, application/json; charset=utf-8

update_subscription_v2

SubscriptionPagedMetadata update_subscription_v2(request)

Update a subscription (V2).

{"nickname":"Update subscription (V2)","response":"updateSubscriptionViaHelper.html","request":"updateSubscriptionViaHelper.request.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

request = Bfwd::UpdateSubscriptionRequest.new # UpdateSubscriptionRequest | 


begin
  #Update a subscription (V2).
  result = api_instance.update_subscription_v2(request)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->update_subscription_v2: #{e}"
end

Parameters

Name	Type	Description	Notes
request	UpdateSubscriptionRequest

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

upsert_metadata_for_subscription

DynamicMetadata upsert_metadata_for_subscription(metadata, subscription_id, opts)

Update any existing metadata key-values and insert any new key-values, no keys will be removed.

{"nickname":"Upsert on subscription","request":"upsertSubscriptionMetadataRequest.html","response":"upsertSubscriptionMetadataResponse.html"}

Example

# load the gem
require 'bf_ruby2'

api_instance = Bfwd::SubscriptionsApi.new

metadata = Bfwd::DynamicMetadata.new # DynamicMetadata | 

subscription_id = "subscription_id_example" # String | 

opts = { 
  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
}

begin
  #Update any existing metadata key-values and insert any new key-values, no keys will be removed.
  result = api_instance.upsert_metadata_for_subscription(metadata, subscription_id, opts)
  p result
rescue Bfwd::ApiError => e
  puts "Exception when calling SubscriptionsApi->upsert_metadata_for_subscription: #{e}"
end

Parameters

Name	Type	Description	Notes
metadata	DynamicMetadata
subscription_id	String
organizations	Array<String>	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type