All URIs are relative to https://{customerId}.billabear.cloud/api/v1
| Method | HTTP request | Description |
|---|---|---|
| add_seats_subscriptions | POST /subscription/{subscriptionId}/seats/add | Add Seats |
| apply_voucher_to_customer | POST /customer/{customerId}/voucher | Apply voucher |
| create_customer | POST /customer | Create |
| create_customer_usage_limit | POST /customer/{customerId}/uasge-limit | Create Usage Limit |
| customer_customer_id_uasge_limit_limit_id_delete | DELETE /customer/{customerId}/uasge-limit/{limitId} | Delete Usage Limit |
| disable_customer | POST /customer/{customerId}/disable | Disable Customer |
| enable_customer | POST /customer/{customerId}/enable | Enable Customer |
| get_active_for_customer | GET /customer/{customerId}/subscription/active | List Customer Active Subscriptions |
| get_all_customers | GET /customer | List |
| get_customer_by_id | GET /customer/{customerId} | Detail |
| get_customer_costs | GET /customer/{customerId}/costs | Usage Cost Estimate |
| get_customer_limits_by_id | GET /customer/{customerId}/limits | Fetch Customer Limits |
| get_customer_usage_limits_by_id | GET /customer/{customerId}/uasge-limit | Fetch Customer Usage Limits |
| get_for_customer | GET /customer/{customerId}/subscription | List Customer Subscriptions |
| get_invoices_for_customer | GET /customer/{customerId}/invoices | List Customer Invoices |
| get_payments_for_customer | GET /customer/{customerId}/payment | List Customer Payments |
| get_refunds_for_customer | GET /customer/{customerId}/refund | List Customer Refunds |
| list_payment_details | GET /customer/{customerId}/payment-methods | List Customer's Payment Details |
| remove_seats_subscriptions | POST /subscription/{subscriptionId}/seats/remove | Remove Seats |
| update_customer | PUT /customer/{customerId} | Update |
InlineResponse20013 add_seats_subscriptions(bodysubscription_id)
Add Seats
Adds seats to a per seat subscription
Since 1.1.4
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
body = Billabear::SeatsAddBody.new # SeatsAddBody |
subscription_id = 'subscription_id_example' # String | The id of the subscription to retrieve
begin
#Add Seats
result = api_instance.add_seats_subscriptions(bodysubscription_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->add_seats_subscriptions: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| body | SeatsAddBody | ||
| subscription_id | String | The id of the subscription to retrieve |
- Content-Type: application/json
- Accept: application/json
apply_voucher_to_customer(bodycustomer_id)
Apply voucher
Apply Voucher to Customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
body = Billabear::VoucherCode.new # VoucherCode |
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Apply voucher
api_instance.apply_voucher_to_customer(bodycustomer_id)
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->apply_voucher_to_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| body | VoucherCode | ||
| customer_id | String | The id of the customer to retrieve |
nil (empty response body)
- Content-Type: application/json
- Accept: application/json
Customer create_customer(body)
Create
Create a customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
body = Billabear::Customer.new # Customer |
begin
#Create
result = api_instance.create_customer(body)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->create_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| body | Customer |
- Content-Type: application/json
- Accept: application/json
UsageLimit create_customer_usage_limit(bodycustomer_id)
Create Usage Limit
Create Usage Limit for the custoemr
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
body = Billabear::CustomerIdUasgelimitBody.new # CustomerIdUasgelimitBody |
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Create Usage Limit
result = api_instance.create_customer_usage_limit(bodycustomer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->create_customer_usage_limit: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| body | CustomerIdUasgelimitBody | ||
| customer_id | String | The id of the customer to retrieve |
- Content-Type: application/json
- Accept: application/json
customer_customer_id_uasge_limit_limit_id_delete(customer_id, usage_limit_id)
Delete Usage Limit
Delete Usage Limit for the custoemr
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
usage_limit_id = 'usage_limit_id_example' # String | The id of the usage limit
begin
#Delete Usage Limit
api_instance.customer_customer_id_uasge_limit_limit_id_delete(customer_id, usage_limit_id)
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->customer_customer_id_uasge_limit_limit_id_delete: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve | |
| usage_limit_id | String | The id of the usage limit |
nil (empty response body)
- Content-Type: Not defined
- Accept: Not defined
disable_customer(customer_id)
Disable Customer
Disable customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Disable Customer
api_instance.disable_customer(customer_id)
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->disable_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
nil (empty response body)
- Content-Type: Not defined
- Accept: application/json
enable_customer(customer_id)
Enable Customer
Enable a customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Enable Customer
api_instance.enable_customer(customer_id)
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->enable_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
nil (empty response body)
- Content-Type: Not defined
- Accept: application/json
InlineResponse2008 get_active_for_customer(customer_id)
List Customer Active Subscriptions
List all Active customer subscriptions
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#List Customer Active Subscriptions
result = api_instance.get_active_for_customer(customer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_active_for_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
- Content-Type: Not defined
- Accept: application/json
InlineResponse200 get_all_customers(opts)
List
List all customers
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
opts = {
limit: 56, # Integer | How many items to return at one time (max 100)
last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
email: 'email_example', # String | The email to search for
country: 'country_example', # String | The country code to search for
reference: 'reference_example', # String | The reference to search for
external_reference: 'external_reference_example', # String | The external reference to search for
company_name: 'company_name_example' # String | The company name to search for
}
begin
#List
result = api_instance.get_all_customers(opts)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_all_customers: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | How many items to return at one time (max 100) | [optional] |
| last_key | String | The key to be used in pagination to say what the last key of the previous page was | [optional] |
| String | The email to search for | [optional] | |
| country | String | The country code to search for | [optional] |
| reference | String | The reference to search for | [optional] |
| external_reference | String | The external reference to search for | [optional] |
| company_name | String | The company name to search for | [optional] |
- Content-Type: Not defined
- Accept: application/json
Customer get_customer_by_id(customer_id)
Detail
Info for a specific customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Detail
result = api_instance.get_customer_by_id(customer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_customer_by_id: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
- Content-Type: Not defined
- Accept: application/json
InlineResponse2001 get_customer_costs(customer_id)
Usage Cost Estimate
The estimated costs from usage based billing for a customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Usage Cost Estimate
result = api_instance.get_customer_costs(customer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_customer_costs: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
- Content-Type: Not defined
- Accept: application/json
InlineResponse2002 get_customer_limits_by_id(customer_id)
Fetch Customer Limits
Limits for a specific customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Fetch Customer Limits
result = api_instance.get_customer_limits_by_id(customer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_customer_limits_by_id: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
- Content-Type: Not defined
- Accept: application/json
InlineResponse2005 get_customer_usage_limits_by_id(customer_id)
Fetch Customer Usage Limits
Usage Limits for a specific customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Fetch Customer Usage Limits
result = api_instance.get_customer_usage_limits_by_id(customer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_customer_usage_limits_by_id: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
- Content-Type: Not defined
- Accept: application/json
InlineResponse2008 get_for_customer(customer_id)
List Customer Subscriptions
List all customer subscriptions
Since 1.1
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#List Customer Subscriptions
result = api_instance.get_for_customer(customer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_for_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
- Content-Type: Not defined
- Accept: application/json
InlineResponse2006 get_invoices_for_customer(customer_id)
List Customer Invoices
List Customer Invoices
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#List Customer Invoices
result = api_instance.get_invoices_for_customer(customer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_invoices_for_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
- Content-Type: Not defined
- Accept: application/json
InlineResponse2004 get_payments_for_customer(customer_id, opts)
List Customer Payments
List Customer Payment
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
opts = {
limit: 56, # Integer | How many items to return at one time (max 100)
last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
name: 'name_example' # String | The name to search for
}
begin
#List Customer Payments
result = api_instance.get_payments_for_customer(customer_id, opts)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_payments_for_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve | |
| limit | Integer | How many items to return at one time (max 100) | [optional] |
| last_key | String | The key to be used in pagination to say what the last key of the previous page was | [optional] |
| name | String | The name to search for | [optional] |
- Content-Type: Not defined
- Accept: application/json
InlineResponse2003 get_refunds_for_customer(customer_id, opts)
List Customer Refunds
List Customer Refund
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
opts = {
limit: 56, # Integer | How many items to return at one time (max 100)
last_key: 'last_key_example', # String | The key to be used in pagination to say what the last key of the previous page was
name: 'name_example' # String | The name to search for
}
begin
#List Customer Refunds
result = api_instance.get_refunds_for_customer(customer_id, opts)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->get_refunds_for_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve | |
| limit | Integer | How many items to return at one time (max 100) | [optional] |
| last_key | String | The key to be used in pagination to say what the last key of the previous page was | [optional] |
| name | String | The name to search for | [optional] |
- Content-Type: Not defined
- Accept: application/json
InlineResponse2007 list_payment_details(customer_id)
List Customer's Payment Details
List all customers
Added in version 1.1
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#List Customer's Payment Details
result = api_instance.list_payment_details(customer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->list_payment_details: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| customer_id | String | The id of the customer to retrieve |
- Content-Type: Not defined
- Accept: application/json
InlineResponse20013 remove_seats_subscriptions(bodysubscription_id)
Remove Seats
Remove seats to a per seat subscription
Since 1.1.4
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
body = Billabear::SeatsRemoveBody.new # SeatsRemoveBody |
subscription_id = 'subscription_id_example' # String | The id of the subscription to retrieve
begin
#Remove Seats
result = api_instance.remove_seats_subscriptions(bodysubscription_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->remove_seats_subscriptions: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| body | SeatsRemoveBody | ||
| subscription_id | String | The id of the subscription to retrieve |
- Content-Type: application/json
- Accept: application/json
Customer update_customer(bodycustomer_id)
Update
Update a customer
# load the gem
require 'billabear'
# setup authorization
Billabear.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['X-API-Key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['X-API-Key'] = 'Bearer'
end
api_instance = Billabear::CustomersApi.new
body = Billabear::Customer.new # Customer |
customer_id = 'customer_id_example' # String | The id of the customer to retrieve
begin
#Update
result = api_instance.update_customer(bodycustomer_id)
p result
rescue Billabear::ApiError => e
puts "Exception when calling CustomersApi->update_customer: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| body | Customer | ||
| customer_id | String | The id of the customer to retrieve |
- Content-Type: application/json
- Accept: application/json