mundi_api 0.9.1 → 0.13.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49586bcb95c921dc21333197df25c96df79cb044
-  data.tar.gz: 1c210f2462c52236433bfd5af30d3b3facf5a9a0
+  metadata.gz: 51d3c67f91e0fea4ded57a42ea9ce71005cb6f76
+  data.tar.gz: 194741f5d907e56e2739a6c7e47d0c54e5e50db2
 SHA512:
-  metadata.gz: 442dc7ee5ebab3953885a5fe370ab37061ba987a21b188c141b13711cd613416d701c64aaa267218783e3e0fcb5fdfb20e8bbfe0968ebb11aeee42d2b073ab39
-  data.tar.gz: e461df1438a61de93798af4f8961c9a5d8e82b286c78c0715fb7ca105979375de5aea8fbe22c9fecef14036f6cc43ceb90ac05452d9c0822955d08f37a0c4983
+  metadata.gz: 9a5065c2b35b1abf4d80741cbe06571788dc5bff9530c23ee1a0e996a2083ff8a814b46ad6801fa6e6a0c088d442c53bf2ab0f32b5e26ef56ca36b18c717d369
+  data.tar.gz: dd3d1fc6cf2703f70f2b6819d653845c4e0e1c887cc98674cae7e7ade6f565fe5c0e10b53aefd0f9467eac32e78cc8759b978fc0eba8c686262d000665bd64a4

data/README.md

@@ -8,9 +8,9 @@ This client library is a Ruby gem which can be compiled and used in your Ruby an
 
 1. Open the command line interface or the terminal and navigate to the folder containing the source code.
 2. Run ``` gem build mundi_api.gemspec ``` to build the gem.
-3. Once built, the gem can be installed on the current work environment using ``` gem install mundi_api-0.9.0.gem ```
+3. Once built, the gem can be installed on the current work environment using ``` gem install mundi_api-0.13.7.gem ```
 
-![Building Gem](https://apidocs.io/illustration/ruby?step=buildSDK&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiAPI-Ruby&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Building Gem](https://apidocs.io/illustration/ruby?step=buildSDK&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiAPI-Ruby&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 ## How to Use
 
@@ -20,41 +20,41 @@ The following section explains how to use the MundiApi Ruby Gem in a new Rails p
 
 Close any existing projects in RubyMine™ by selecting ``` File -> Close Project ```. Next, click on ``` Create New Project ``` to create a new project from scratch.
 
-![Create a new project in RubyMine](https://apidocs.io/illustration/ruby?step=createNewProject0&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Create a new project in RubyMine](https://apidocs.io/illustration/ruby?step=createNewProject0&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 Next, provide ``` TestApp ``` as the project name, choose ``` Rails Application ``` as the project type, and click ``` OK ```.
 
-![Create a new Rails Application in RubyMine - step 1](https://apidocs.io/illustration/ruby?step=createNewProject1&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Create a new Rails Application in RubyMine - step 1](https://apidocs.io/illustration/ruby?step=createNewProject1&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 In the next dialog make sure that correct *Ruby SDK* is being used (minimum 2.0.0) and click ``` OK ```.
 
-![Create a new Rails Application in RubyMine - step 2](https://apidocs.io/illustration/ruby?step=createNewProject2&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Create a new Rails Application in RubyMine - step 2](https://apidocs.io/illustration/ruby?step=createNewProject2&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 This will create a new Rails Application project with an existing set of files and folder.
 
 ### 2. Add reference of the gem
 
-In order to use the MundiApi gem in the new project we must add a gem reference. Locate the ```Gemfile``` in the *Project Explorer* window under the ``` TestApp ``` project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: ``` gem 'mundi_api', '~> 0.9.0' ```
+In order to use the MundiApi gem in the new project we must add a gem reference. Locate the ```Gemfile``` in the *Project Explorer* window under the ``` TestApp ``` project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: ``` gem 'mundi_api', '~> 0.13.7' ```
 
-![Add references of the Gemfile](https://apidocs.io/illustration/ruby?step=addReference&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Add references of the Gemfile](https://apidocs.io/illustration/ruby?step=addReference&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 ### 3. Adding a new Rails Controller
 
 Once the ``` TestApp ``` project is created, a folder named ``` controllers ``` will be visible in the *Project Explorer* under the following path: ``` TestApp > app > controllers ```. Right click on this folder and select ``` New -> Run Rails Generator... ```.
 
-![Run Rails Generator on Controllers Folder](https://apidocs.io/illustration/ruby?step=addCode0&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Run Rails Generator on Controllers Folder](https://apidocs.io/illustration/ruby?step=addCode0&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 Selecting the said option will popup a small window where the generator names are displayed. Here, select the ``` controller ``` template.
 
-![Create a new Controller](https://apidocs.io/illustration/ruby?step=addCode1&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Create a new Controller](https://apidocs.io/illustration/ruby?step=addCode1&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 Next, a popup window will ask you for a Controller name and included Actions. For controller name provide ``` Hello ``` and include an action named ``` Index ``` and click ``` OK ```.
 
-![Add a new Controller](https://apidocs.io/illustration/ruby?step=addCode2&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Add a new Controller](https://apidocs.io/illustration/ruby?step=addCode2&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 A new controller class anmed ``` HelloController ``` will be created in a file named ``` hello_controller.rb ``` containing a method named ``` Index ```. In this method, add code for initialization and a sample for its usage.
 
-![Initialize the library](https://apidocs.io/illustration/ruby?step=addCode3&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0)
+![Initialize the library](https://apidocs.io/illustration/ruby?step=addCode3&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7)
 
 ## How to Test
 
@@ -91,7 +91,7 @@ client = MundiApi::MundiApiClient.new(
 
 The added initlization code can be debugged by putting a breakpoint in the ``` Index ``` method and running the project in debug mode by selecting ``` Run -> Debug 'Development: TestApp' ```.
 
-![Debug the TestApp](https://apidocs.io/illustration/ruby?step=addCode4&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.9.0&initLine=client%2520%253D%2520MundiApiClient.new%2528%2527basic_auth_user_name%2527%252C%2520%2527basic_auth_password%2527%2529)
+![Debug the TestApp](https://apidocs.io/illustration/ruby?step=addCode4&workspaceFolder=MundiAPI-Ruby&workspaceName=MundiApi&projectName=mundi_api&gemName=mundi_api&gemVer=0.13.7&initLine=client%2520%253D%2520MundiApiClient.new%2528%2527basic_auth_user_name%2527%252C%2520%2527basic_auth_password%2527%2529)
 
 
 
@@ -99,462 +99,1524 @@ The added initlization code can be debugged by putting a breakpoint in the ``` I
 
 ## <a name="list_of_controllers"></a>List of Controllers
 
-* [ChargesController](#charges_controller)
-* [CustomersController](#customers_controller)
-* [InvoicesController](#invoices_controller)
-* [PlansController](#plans_controller)
 * [SubscriptionsController](#subscriptions_controller)
 * [OrdersController](#orders_controller)
+* [PlansController](#plans_controller)
+* [InvoicesController](#invoices_controller)
+* [CustomersController](#customers_controller)
+* [ChargesController](#charges_controller)
+* [RecipientsController](#recipients_controller)
 * [TokensController](#tokens_controller)
+* [SellersController](#sellers_controller)
 
-## <a name="charges_controller"></a>![Class: ](https://apidocs.io/img/class.png ".ChargesController") ChargesController
+## <a name="subscriptions_controller"></a>![Class: ](https://apidocs.io/img/class.png ".SubscriptionsController") SubscriptionsController
 
 ### Get singleton instance
 
-The singleton instance of the ``` ChargesController ``` class can be accessed from the API Client.
+The singleton instance of the ``` SubscriptionsController ``` class can be accessed from the API Client.
 
 ```ruby
-charges = client.charges
+subscriptions_controller = client.subscriptions
 ```
 
-### <a name="get_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.get_charge") get_charge
+### <a name="update_subscription_billing_date"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_billing_date") update_subscription_billing_date
 
-> Get a charge from its id
+> Updates the billing date from a subscription
 
 
 ```ruby
-def get_charge(charge_id); end
+def update_subscription_billing_date(subscription_id,
+                                         request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| charge_id |  ``` Required ```  | Charge id |
+| subscription_id |  ``` Required ```  | The subscription id |
+| request |  ``` Required ```  | Request for updating the subscription billing date |
 
 
 #### Example Usage
 
 ```ruby
-charge_id = 'charge_id'
+subscription_id = 'subscription_id'
+request = UpdateSubscriptionBillingDateRequest.new
 
-result = charges.get_charge(charge_id)
+result = subscriptions_controller.update_subscription_billing_date(subscription_id, request)
 
 ```
 
 
-### <a name="retry_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.retry_charge") retry_charge
+### <a name="update_subscription_card"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_card") update_subscription_card
 
-> Retries a charge
+> Updates the credit card from a subscription
 
 
 ```ruby
-def retry_charge(charge_id); end
+def update_subscription_card(subscription_id,
+                                 request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| charge_id |  ``` Required ```  | Charge id |
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Required ```  | Request for updating a card |
 
 
 #### Example Usage
 
 ```ruby
-charge_id = 'charge_id'
+subscription_id = 'subscription_id'
+request = UpdateSubscriptionCardRequest.new
 
-result = charges.retry_charge(charge_id)
+result = subscriptions_controller.update_subscription_card(subscription_id, request)
 
 ```
 
 
-### <a name="create_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.create_charge") create_charge
+### <a name="update_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_item") update_subscription_item
 
-> Creates a new charge
+> Updates a subscription item
 
 
 ```ruby
-def create_charge(request); end
+def update_subscription_item(subscription_id,
+                                 item_id,
+                                 body); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| request |  ``` Required ```  | Request for creating a charge |
+| subscription_id |  ``` Required ```  | Subscription Id |
+| item_id |  ``` Required ```  | Item id |
+| body |  ``` Required ```  | Request for updating a subscription item |
 
 
 #### Example Usage
 
 ```ruby
-request = CreateChargeRequest.new
+subscription_id = 'subscription_id'
+item_id = 'item_id'
+body = UpdateSubscriptionItemRequest.new
 
-result = charges.create_charge(request)
+result = subscriptions_controller.update_subscription_item(subscription_id, item_id, body)
 
 ```
 
 
-### <a name="update_charge_card"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_card") update_charge_card
+### <a name="create_usage"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_usage") create_usage
 
-> Updates the card from a charge
+> Creates a usage
 
 
 ```ruby
-def update_charge_card(charge_id,
-                           request); end
+def create_usage(subscription_id,
+                     item_id,
+                     body); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| charge_id |  ``` Required ```  | Charge id |
-| request |  ``` Required ```  | Request for updating a charge's card |
+| subscription_id |  ``` Required ```  | Subscription Id |
+| item_id |  ``` Required ```  | Item id |
+| body |  ``` Required ```  | Request for creating a usage |
 
 
 #### Example Usage
 
 ```ruby
-charge_id = 'charge_id'
-request = UpdateChargeCardRequest.new
+subscription_id = 'subscription_id'
+item_id = 'item_id'
+body = CreateUsageRequest.new
 
-result = charges.update_charge_card(charge_id, request)
+result = subscriptions_controller.create_usage(subscription_id, item_id, body)
 
 ```
 
 
-### <a name="update_charge_payment_method"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_payment_method") update_charge_payment_method
+### <a name="get_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_subscription") get_subscription
 
-> Updates a charge's payment method
+> Gets a subscription
 
 
 ```ruby
-def update_charge_payment_method(charge_id,
-                                     request); end
+def get_subscription(subscription_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| charge_id |  ``` Required ```  | Charge id |
-| request |  ``` Required ```  | Request for updating the payment method from a charge |
+| subscription_id |  ``` Required ```  | Subscription id |
 
 
 #### Example Usage
 
 ```ruby
-charge_id = 'charge_id'
-request = UpdateChargePaymentMethodRequest.new
+subscription_id = 'subscription_id'
 
-result = charges.update_charge_payment_method(charge_id, request)
+result = subscriptions_controller.get_subscription(subscription_id)
 
 ```
 
 
-### <a name="cancel_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.cancel_charge") cancel_charge
+### <a name="update_subscription_payment_method"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_payment_method") update_subscription_payment_method
 
-> Cancel a charge
+> Updates the payment method from a subscription
 
 
 ```ruby
-def cancel_charge(charge_id,
-                      request = nil); end
+def update_subscription_payment_method(subscription_id,
+                                           request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| charge_id |  ``` Required ```  | Charge id |
-| request |  ``` Optional ```  | Request for cancelling a charge |
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Required ```  | Request for updating the paymentmethod from a subscription |
 
 
 #### Example Usage
 
 ```ruby
-charge_id = 'charge_id'
-request = CreateCancelChargeRequest.new
+subscription_id = 'subscription_id'
+request = UpdateSubscriptionPaymentMethodRequest.new
 
-result = charges.cancel_charge(charge_id, request)
+result = subscriptions_controller.update_subscription_payment_method(subscription_id, request)
 
 ```
 
 
-### <a name="capture_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.capture_charge") capture_charge
+### <a name="create_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_subscription") create_subscription
 
-> Captures a charge
+> Creates a new subscription
 
 
 ```ruby
-def capture_charge(charge_id,
-                       request = nil); end
+def create_subscription(body); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| charge_id |  ``` Required ```  | Charge id |
-| request |  ``` Optional ```  | Request for capturing a charge |
+| body |  ``` Required ```  | Request for creating a subscription |
 
 
 #### Example Usage
 
 ```ruby
-charge_id = 'charge_id'
-request = CreateCaptureChargeRequest.new
+body = CreateSubscriptionRequest.new
 
-result = charges.capture_charge(charge_id, request)
+result = subscriptions_controller.create_subscription(body)
 
 ```
 
 
-### <a name="update_charge_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_metadata") update_charge_metadata
+### <a name="create_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_subscription_item") create_subscription_item
 
-> Updates the metadata from a charge
+> Creates a new Subscription item
 
 
 ```ruby
-def update_charge_metadata(charge_id,
-                               request); end
+def create_subscription_item(subscription_id,
+                                 request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| charge_id |  ``` Required ```  | The charge id |
-| request |  ``` Required ```  | Request for updating the charge metadata |
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Required ```  | Request for creating a subscription item |
 
 
 #### Example Usage
 
 ```ruby
-charge_id = 'charge_id'
-request = UpdateMetadataRequest.new
+subscription_id = 'subscription_id'
+request = CreateSubscriptionItemRequest.new
 
-result = charges.update_charge_metadata(charge_id, request)
+result = subscriptions_controller.create_subscription_item(subscription_id, request)
 
 ```
 
 
-### <a name="get_charges"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.get_charges") get_charges
+### <a name="create_discount"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_discount") create_discount
 
-> Lists all charges
+> Creates a discount
 
 
 ```ruby
-def get_charges(page = nil,
-                    size = nil,
-                    code = nil,
-                    status = nil,
-                    payment_method = nil,
-                    customer_id = nil,
-                    order_id = nil,
-                    created_since = nil,
-                    created_until = nil); end
+def create_discount(subscription_id,
+                        request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| page |  ``` Optional ```  | Page number |
-| size |  ``` Optional ```  | Page size |
-| code |  ``` Optional ```  | Filter for charge's code |
-| status |  ``` Optional ```  | Filter for charge's status |
-| payment_method |  ``` Optional ```  | Filter for charge's payment method |
-| customer_id |  ``` Optional ```  | Filter for charge's customer id |
-| order_id |  ``` Optional ```  | Filter for charge's order id |
-| created_since |  ``` Optional ```  | Filter for the beginning of the range for charge's creation |
-| created_until |  ``` Optional ```  | Filter for the end of the range for charge's creation |
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Required ```  | Request for creating a discount |
 
 
 #### Example Usage
 
 ```ruby
-page = 224
-size = 224
-code = 'code'
-status = 'status'
-payment_method = 'payment_method'
-customer_id = 'customer_id'
-order_id = 'order_id'
-created_since = DateTime.now
-created_until = DateTime.now
+subscription_id = 'subscription_id'
+request = CreateDiscountRequest.new
 
-result = charges.get_charges(page, size, code, status, payment_method, customer_id, order_id, created_since, created_until)
+result = subscriptions_controller.create_discount(subscription_id, request)
 
 ```
 
 
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="customers_controller"></a>![Class: ](https://apidocs.io/img/class.png ".CustomersController") CustomersController
-
-### Get singleton instance
-
-The singleton instance of the ``` CustomersController ``` class can be accessed from the API Client.
-
-```ruby
-customers = client.customers
-```
-
-### <a name="create_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_customer") create_customer
+### <a name="get_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_subscription_item") get_subscription_item
 
-> Creates a new customer
+> Get Subscription Item
 
 
 ```ruby
-def create_customer(request); end
+def get_subscription_item(subscription_id,
+                              item_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| request |  ``` Required ```  | Request for creating a customer |
+| subscription_id |  ``` Required ```  | Subscription Id |
+| item_id |  ``` Required ```  | Item id |
 
 
 #### Example Usage
 
 ```ruby
-request = CreateCustomerRequest.new
+subscription_id = 'subscription_id'
+item_id = 'item_id'
 
-result = customers.create_customer(request)
+result = subscriptions_controller.get_subscription_item(subscription_id, item_id)
 
 ```
 
 
-### <a name="get_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_customer") get_customer
+### <a name="get_subscription_items"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_subscription_items") get_subscription_items
 
-> Get a customer
+> Get Subscription Itens
 
 
 ```ruby
-def get_customer(customer_id); end
+def get_subscription_items(subscription_id,
+                               status,
+                               description); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| customer_id |  ``` Required ```  | Customer Id |
+| subscription_id |  ``` Required ```  | Subscription Id |
+| status |  ``` Required ```  | Status |
+| description |  ``` Required ```  | Description |
 
 
 #### Example Usage
 
 ```ruby
-customer_id = 'customer_id'
+subscription_id = 'subscription_id'
+status = 'status'
+description = 'description'
 
-result = customers.get_customer(customer_id)
+result = subscriptions_controller.get_subscription_items(subscription_id, status, description)
 
 ```
 
 
-### <a name="update_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_card") update_card
+### <a name="update_subscription_affiliation_id"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_affiliation_id") update_subscription_affiliation_id
 
-> Updates a card
+> TODO: Add a method description
 
 
 ```ruby
-def update_card(customer_id,
-                    card_id,
-                    request); end
+def update_subscription_affiliation_id(subscription_id,
+                                           request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| customer_id |  ``` Required ```  | Customer Id |
-| card_id |  ``` Required ```  | Card id |
-| request |  ``` Required ```  | Request for updating a card |
+| subscription_id |  ``` Required ```  | TODO: Add a parameter description |
+| request |  ``` Required ```  | Request for updating a subscription affiliation id |
 
 
 #### Example Usage
 
 ```ruby
-customer_id = 'customer_id'
-card_id = 'card_id'
-request = UpdateCardRequest.new
+subscription_id = 'subscription_id'
+request = UpdateSubscriptionAffiliationIdRequest.new
 
-result = customers.update_card(customer_id, card_id, request)
+result = subscriptions_controller.update_subscription_affiliation_id(subscription_id, request)
 
 ```
 
 
-### <a name="update_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_address") update_address
+### <a name="create_an_usage"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_an_usage") create_an_usage
 
-> Updates an address
+> Create Usage
 
 
 ```ruby
-def update_address(customer_id,
-                       address_id,
-                       request); end
+def create_an_usage(subscription_id,
+                        item_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| customer_id |  ``` Required ```  | Customer Id |
-| address_id |  ``` Required ```  | Address Id |
-| request |  ``` Required ```  | Request for updating an address |
+| subscription_id |  ``` Required ```  | Subscription id |
+| item_id |  ``` Required ```  | Item id |
 
 
 #### Example Usage
 
 ```ruby
-customer_id = 'customer_id'
-address_id = 'address_id'
-request = UpdateAddressRequest.new
+subscription_id = 'subscription_id'
+item_id = 'item_id'
 
-result = customers.update_address(customer_id, address_id, request)
+result = subscriptions_controller.create_an_usage(subscription_id, item_id)
 
 ```
 
 
-### <a name="get_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_address") get_address
+### <a name="get_subscriptions"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_subscriptions") get_subscriptions
 
-> Get a customer's address
+> Gets all subscriptions
 
 
 ```ruby
-def get_address(customer_id,
-                    address_id); end
+def get_subscriptions(page = nil,
+                          size = nil,
+                          code = nil,
+                          billing_type = nil,
+                          customer_id = nil,
+                          plan_id = nil,
+                          card_id = nil,
+                          status = nil,
+                          next_billing_since = nil,
+                          next_billing_until = nil,
+                          created_since = nil,
+                          created_until = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| customer_id |  ``` Required ```  | Customer id |
-| address_id |  ``` Required ```  | Address Id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| code |  ``` Optional ```  | Filter for subscription's code |
+| billing_type |  ``` Optional ```  | Filter for subscription's billing type |
+| customer_id |  ``` Optional ```  | Filter for subscription's customer id |
+| plan_id |  ``` Optional ```  | Filter for subscription's plan id |
+| card_id |  ``` Optional ```  | Filter for subscription's card id |
+| status |  ``` Optional ```  | Filter for subscription's status |
+| next_billing_since |  ``` Optional ```  | Filter for subscription's next billing date start range |
+| next_billing_until |  ``` Optional ```  | Filter for subscription's next billing date end range |
+| created_since |  ``` Optional ```  | Filter for subscription's creation date start range |
+| created_until |  ``` Optional ```  | Filter for subscriptions creation date end range |
+
+
+#### Example Usage
+
+```ruby
+page = 43
+size = 43
+code = 'code'
+billing_type = 'billing_type'
+customer_id = 'customer_id'
+plan_id = 'plan_id'
+card_id = 'card_id'
+status = 'status'
+next_billing_since = DateTime.now
+next_billing_until = DateTime.now
+created_since = DateTime.now
+created_until = DateTime.now
+
+result = subscriptions_controller.get_subscriptions(page, size, code, billing_type, customer_id, plan_id, card_id, status, next_billing_since, next_billing_until, created_since, created_until)
+
+```
+
+
+### <a name="update_subscription_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_metadata") update_subscription_metadata
+
+> Updates the metadata from a subscription
+
+
+```ruby
+def update_subscription_metadata(subscription_id,
+                                     request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | The subscription id |
+| request |  ``` Required ```  | Request for updating the subscrption metadata |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = UpdateMetadataRequest.new
+
+result = subscriptions_controller.update_subscription_metadata(subscription_id, request)
+
+```
+
+
+### <a name="delete_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_subscription_item") delete_subscription_item
+
+> Deletes a subscription item
+
+
+```ruby
+def delete_subscription_item(subscription_id,
+                                 subscription_item_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| subscription_item_id |  ``` Required ```  | Subscription item id |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+subscription_item_id = 'subscription_item_id'
+
+result = subscriptions_controller.delete_subscription_item(subscription_id, subscription_item_id)
+
+```
+
+
+### <a name="delete_usage"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_usage") delete_usage
+
+> Deletes a usage
+
+
+```ruby
+def delete_usage(subscription_id,
+                     item_id,
+                     usage_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | The subscription id |
+| item_id |  ``` Required ```  | The subscription item id |
+| usage_id |  ``` Required ```  | The usage id |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+item_id = 'item_id'
+usage_id = 'usage_id'
+
+result = subscriptions_controller.delete_usage(subscription_id, item_id, usage_id)
+
+```
+
+
+### <a name="get_usages"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_usages") get_usages
+
+> Lists all usages from a subscription item
+
+
+```ruby
+def get_usages(subscription_id,
+                   item_id,
+                   page = nil,
+                   size = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | The subscription id |
+| item_id |  ``` Required ```  | The subscription item id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+item_id = 'item_id'
+page = 43
+size = 43
+
+result = subscriptions_controller.get_usages(subscription_id, item_id, page, size)
+
+```
+
+
+### <a name="delete_discount"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_discount") delete_discount
+
+> Deletes a discount
+
+
+```ruby
+def delete_discount(subscription_id,
+                        discount_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| discount_id |  ``` Required ```  | Discount Id |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+discount_id = 'discount_id'
+
+result = subscriptions_controller.delete_discount(subscription_id, discount_id)
+
+```
+
+
+### <a name="cancel_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.cancel_subscription") cancel_subscription
+
+> Cancels a subscription
+
+
+```ruby
+def cancel_subscription(subscription_id,
+                            request = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription id |
+| request |  ``` Optional ```  | Request for cancelling a subscription |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+request = CreateCancelSubscriptionRequest.new
+
+result = subscriptions_controller.cancel_subscription(subscription_id, request)
+
+```
+
+
+### <a name="get_discount_by_id"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_discount_by_id") get_discount_by_id
+
+> TODO: Add a method description
+
+
+```ruby
+def get_discount_by_id(subscription_id,
+                           discount_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | TODO: Add a parameter description |
+| discount_id |  ``` Required ```  | TODO: Add a parameter description |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+discount_id = 'discountId'
+
+result = subscriptions_controller.get_discount_by_id(subscription_id, discount_id)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="orders_controller"></a>![Class: ](https://apidocs.io/img/class.png ".OrdersController") OrdersController
+
+### Get singleton instance
+
+The singleton instance of the ``` OrdersController ``` class can be accessed from the API Client.
+
+```ruby
+orders_controller = client.orders
+```
+
+### <a name="get_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_order") get_order
+
+> Gets an order
+
+
+```ruby
+def get_order(order_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | Order id |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'order_id'
+
+result = orders_controller.get_order(order_id)
+
+```
+
+
+### <a name="create_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.create_order") create_order
+
+> Creates a new Order
+
+
+```ruby
+def create_order(body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| body |  ``` Required ```  | Request for creating an order |
+
+
+#### Example Usage
+
+```ruby
+body = CreateOrderRequest.new
+
+result = orders_controller.create_order(body)
+
+```
+
+
+### <a name="get_orders"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_orders") get_orders
+
+> Gets all orders
+
+
+```ruby
+def get_orders(page = nil,
+                   size = nil,
+                   code = nil,
+                   status = nil,
+                   created_since = nil,
+                   created_until = nil,
+                   customer_id = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| code |  ``` Optional ```  | Filter for order's code |
+| status |  ``` Optional ```  | Filter for order's status |
+| created_since |  ``` Optional ```  | Filter for order's creation date start range |
+| created_until |  ``` Optional ```  | Filter for order's creation date end range |
+| customer_id |  ``` Optional ```  | Filter for order's customer id |
+
+
+#### Example Usage
+
+```ruby
+page = 43
+size = 43
+code = 'code'
+status = 'status'
+created_since = DateTime.now
+created_until = DateTime.now
+customer_id = 'customer_id'
+
+result = orders_controller.get_orders(page, size, code, status, created_since, created_until, customer_id)
+
+```
+
+
+### <a name="update_order_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.update_order_metadata") update_order_metadata
+
+> Updates the metadata from an order
+
+
+```ruby
+def update_order_metadata(order_id,
+                              request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | The order id |
+| request |  ``` Required ```  | Request for updating the order metadata |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'order_id'
+request = UpdateMetadataRequest.new
+
+result = orders_controller.update_order_metadata(order_id, request)
+
+```
+
+
+### <a name="delete_all_order_items"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.delete_all_order_items") delete_all_order_items
+
+> TODO: Add a method description
+
+
+```ruby
+def delete_all_order_items(order_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | Order Id |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'orderId'
+
+result = orders_controller.delete_all_order_items(order_id)
+
+```
+
+
+### <a name="update_order_item"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.update_order_item") update_order_item
+
+> TODO: Add a method description
+
+
+```ruby
+def update_order_item(order_id,
+                          item_id,
+                          request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | Order Id |
+| item_id |  ``` Required ```  | Item Id |
+| request |  ``` Required ```  | Item Model |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'orderId'
+item_id = 'itemId'
+request = UpdateOrderItemRequest.new
+
+result = orders_controller.update_order_item(order_id, item_id, request)
+
+```
+
+
+### <a name="delete_order_item"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.delete_order_item") delete_order_item
+
+> TODO: Add a method description
+
+
+```ruby
+def delete_order_item(order_id,
+                          item_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | Order Id |
+| item_id |  ``` Required ```  | Item Id |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'orderId'
+item_id = 'itemId'
+
+result = orders_controller.delete_order_item(order_id, item_id)
+
+```
+
+
+### <a name="create_order_item"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.create_order_item") create_order_item
+
+> TODO: Add a method description
+
+
+```ruby
+def create_order_item(order_id,
+                          request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | Order Id |
+| request |  ``` Required ```  | Order Item Model |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'orderId'
+request = CreateOrderItemRequest.new
+
+result = orders_controller.create_order_item(order_id, request)
+
+```
+
+
+### <a name="get_order_item"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_order_item") get_order_item
+
+> TODO: Add a method description
+
+
+```ruby
+def get_order_item(order_id,
+                       item_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| order_id |  ``` Required ```  | Order Id |
+| item_id |  ``` Required ```  | Item Id |
+
+
+#### Example Usage
+
+```ruby
+order_id = 'orderId'
+item_id = 'itemId'
+
+result = orders_controller.get_order_item(order_id, item_id)
+
+```
+
+
+### <a name="update_order_status"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.update_order_status") update_order_status
+
+> TODO: Add a method description
+
+
+```ruby
+def update_order_status(id,
+                            request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| id |  ``` Required ```  | Order Id |
+| request |  ``` Required ```  | Update Order Model |
+
+
+#### Example Usage
+
+```ruby
+id = 'id'
+request = UpdateOrderStatusRequest.new
+
+result = orders_controller.update_order_status(id, request)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="plans_controller"></a>![Class: ](https://apidocs.io/img/class.png ".PlansController") PlansController
+
+### Get singleton instance
+
+The singleton instance of the ``` PlansController ``` class can be accessed from the API Client.
+
+```ruby
+plans_controller = client.plans
+```
+
+### <a name="create_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.create_plan_item") create_plan_item
+
+> Adds a new item to a plan
+
+
+```ruby
+def create_plan_item(plan_id,
+                         request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| request |  ``` Required ```  | Request for creating a plan item |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+request = CreatePlanItemRequest.new
+
+result = plans_controller.create_plan_item(plan_id, request)
+
+```
+
+
+### <a name="update_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan_item") update_plan_item
+
+> Updates a plan item
+
+
+```ruby
+def update_plan_item(plan_id,
+                         plan_item_id,
+                         body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| plan_item_id |  ``` Required ```  | Plan item id |
+| body |  ``` Required ```  | Request for updating the plan item |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+plan_item_id = 'plan_item_id'
+body = UpdatePlanItemRequest.new
+
+result = plans_controller.update_plan_item(plan_id, plan_item_id, body)
+
+```
+
+
+### <a name="get_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plan") get_plan
+
+> Gets a plan
+
+
+```ruby
+def get_plan(plan_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+
+result = plans_controller.get_plan(plan_id)
+
+```
+
+
+### <a name="delete_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.delete_plan") delete_plan
+
+> Deletes a plan
+
+
+```ruby
+def delete_plan(plan_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+
+result = plans_controller.delete_plan(plan_id)
+
+```
+
+
+### <a name="update_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan") update_plan
+
+> Updates a plan
+
+
+```ruby
+def update_plan(plan_id,
+                    request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| request |  ``` Required ```  | Request for updating a plan |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+request = UpdatePlanRequest.new
+
+result = plans_controller.update_plan(plan_id, request)
+
+```
+
+
+### <a name="create_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.create_plan") create_plan
+
+> Creates a new plan
+
+
+```ruby
+def create_plan(body); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| body |  ``` Required ```  | Request for creating a plan |
+
+
+#### Example Usage
+
+```ruby
+body = CreatePlanRequest.new
+
+result = plans_controller.create_plan(body)
+
+```
+
+
+### <a name="get_plans"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plans") get_plans
+
+> Gets all plans
+
+
+```ruby
+def get_plans(page = nil,
+                  size = nil,
+                  name = nil,
+                  status = nil,
+                  billing_type = nil,
+                  created_since = nil,
+                  created_until = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| name |  ``` Optional ```  | Filter for Plan's name |
+| status |  ``` Optional ```  | Filter for Plan's status |
+| billing_type |  ``` Optional ```  | Filter for plan's billing type |
+| created_since |  ``` Optional ```  | Filter for plan's creation date start range |
+| created_until |  ``` Optional ```  | Filter for plan's creation date end range |
+
+
+#### Example Usage
+
+```ruby
+page = 135
+size = 135
+name = 'name'
+status = 'status'
+billing_type = 'billing_type'
+created_since = DateTime.now
+created_until = DateTime.now
+
+result = plans_controller.get_plans(page, size, name, status, billing_type, created_since, created_until)
+
+```
+
+
+### <a name="update_plan_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan_metadata") update_plan_metadata
+
+> Updates the metadata from a plan
+
+
+```ruby
+def update_plan_metadata(plan_id,
+                             request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | The plan id |
+| request |  ``` Required ```  | Request for updating the plan metadata |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+request = UpdateMetadataRequest.new
+
+result = plans_controller.update_plan_metadata(plan_id, request)
+
+```
+
+
+### <a name="get_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plan_item") get_plan_item
+
+> Gets a plan item
+
+
+```ruby
+def get_plan_item(plan_id,
+                      plan_item_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| plan_item_id |  ``` Required ```  | Plan item id |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+plan_item_id = 'plan_item_id'
+
+result = plans_controller.get_plan_item(plan_id, plan_item_id)
+
+```
+
+
+### <a name="delete_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.delete_plan_item") delete_plan_item
+
+> Removes an item from a plan
+
+
+```ruby
+def delete_plan_item(plan_id,
+                         plan_item_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| plan_id |  ``` Required ```  | Plan id |
+| plan_item_id |  ``` Required ```  | Plan item id |
+
+
+#### Example Usage
+
+```ruby
+plan_id = 'plan_id'
+plan_item_id = 'plan_item_id'
+
+result = plans_controller.delete_plan_item(plan_id, plan_item_id)
+
+```
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+## <a name="invoices_controller"></a>![Class: ](https://apidocs.io/img/class.png ".InvoicesController") InvoicesController
+
+### Get singleton instance
+
+The singleton instance of the ``` InvoicesController ``` class can be accessed from the API Client.
+
+```ruby
+invoices_controller = client.invoices
+```
+
+### <a name="cancel_invoice"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.cancel_invoice") cancel_invoice
+
+> Cancels an invoice
+
+
+```ruby
+def cancel_invoice(invoice_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| invoice_id |  ``` Required ```  | Invoice id |
+
+
+#### Example Usage
+
+```ruby
+invoice_id = 'invoice_id'
+
+result = invoices_controller.cancel_invoice(invoice_id)
+
+```
+
+
+### <a name="get_invoice"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.get_invoice") get_invoice
+
+> Gets an invoice
+
+
+```ruby
+def get_invoice(invoice_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| invoice_id |  ``` Required ```  | Invoice Id |
+
+
+#### Example Usage
+
+```ruby
+invoice_id = 'invoice_id'
+
+result = invoices_controller.get_invoice(invoice_id)
+
+```
+
+
+### <a name="create_invoice"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.create_invoice") create_invoice
+
+> Create an Invoice
+
+
+```ruby
+def create_invoice(subscription_id,
+                       cycle_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| subscription_id |  ``` Required ```  | Subscription Id |
+| cycle_id |  ``` Required ```  | Cycle Id |
+
+
+#### Example Usage
+
+```ruby
+subscription_id = 'subscription_id'
+cycle_id = 'cycle_id'
+
+result = invoices_controller.create_invoice(subscription_id, cycle_id)
+
+```
+
+
+### <a name="update_invoice_status"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.update_invoice_status") update_invoice_status
+
+> Updates the status from an invoice
+
+
+```ruby
+def update_invoice_status(invoice_id,
+                              request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| invoice_id |  ``` Required ```  | Invoice Id |
+| request |  ``` Required ```  | Request for updating an invoice's status |
+
+
+#### Example Usage
+
+```ruby
+invoice_id = 'invoice_id'
+request = UpdateInvoiceStatusRequest.new
+
+result = invoices_controller.update_invoice_status(invoice_id, request)
+
+```
+
+
+### <a name="get_invoices"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.get_invoices") get_invoices
+
+> Gets all invoices
+
+
+```ruby
+def get_invoices(page = nil,
+                     size = nil,
+                     code = nil,
+                     customer_id = nil,
+                     subscription_id = nil,
+                     created_since = nil,
+                     created_until = nil,
+                     status = nil,
+                     due_since = nil,
+                     due_until = nil); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| code |  ``` Optional ```  | Filter for Invoice's code |
+| customer_id |  ``` Optional ```  | Filter for Invoice's customer id |
+| subscription_id |  ``` Optional ```  | Filter for Invoice's subscription id |
+| created_since |  ``` Optional ```  | Filter for Invoice's creation date start range |
+| created_until |  ``` Optional ```  | Filter for Invoices creation date end range |
+| status |  ``` Optional ```  | Filter for Invoice's status |
+| due_since |  ``` Optional ```  | Filter for Invoice's due date start range |
+| due_until |  ``` Optional ```  | Filter for Invoice's due date end range |
+
+
+#### Example Usage
+
+```ruby
+page = 135
+size = 135
+code = 'code'
+customer_id = 'customer_id'
+subscription_id = 'subscription_id'
+created_since = DateTime.now
+created_until = DateTime.now
+status = 'status'
+due_since = DateTime.now
+due_until = DateTime.now
+
+result = invoices_controller.get_invoices(page, size, code, customer_id, subscription_id, created_since, created_until, status, due_since, due_until)
+
+```
+
+
+### <a name="update_invoice_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.update_invoice_metadata") update_invoice_metadata
+
+> Updates the metadata from an invoice
+
+
+```ruby
+def update_invoice_metadata(invoice_id,
+                                request); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| invoice_id |  ``` Required ```  | The invoice id |
+| request |  ``` Required ```  | Request for updating the invoice metadata |
 
 
 #### Example Usage
 
 ```ruby
-customer_id = 'customer_id'
-address_id = 'address_id'
+invoice_id = 'invoice_id'
+request = UpdateMetadataRequest.new
 
-result = customers.get_address(customer_id, address_id)
+result = invoices_controller.update_invoice_metadata(invoice_id, request)
 
 ```
 
 
-### <a name="delete_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_address") delete_address
+[Back to List of Controllers](#list_of_controllers)
 
-> Delete a Customer's address
+## <a name="customers_controller"></a>![Class: ](https://apidocs.io/img/class.png ".CustomersController") CustomersController
+
+### Get singleton instance
 
+The singleton instance of the ``` CustomersController ``` class can be accessed from the API Client.
 
 ```ruby
-def delete_address(customer_id,
-                       address_id); end
+customers_controller = client.customers
+```
+
+### <a name="update_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_card") update_card
+
+> Updates a card
+
+
+```ruby
+def update_card(customer_id,
+                    card_id,
+                    request); end
 ```
 
 #### Parameters
@@ -562,28 +1624,31 @@ def delete_address(customer_id,
 | Parameter | Tags | Description |
 |-----------|------|-------------|
 | customer_id |  ``` Required ```  | Customer Id |
-| address_id |  ``` Required ```  | Address Id |
+| card_id |  ``` Required ```  | Card id |
+| request |  ``` Required ```  | Request for updating a card |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
-address_id = 'address_id'
+card_id = 'card_id'
+request = UpdateCardRequest.new
 
-result = customers.delete_address(customer_id, address_id)
+result = customers_controller.update_card(customer_id, card_id, request)
 
 ```
 
 
-### <a name="delete_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_card") delete_card
+### <a name="update_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_address") update_address
 
-> Delete a customer's card
+> Updates an address
 
 
 ```ruby
-def delete_card(customer_id,
-                    card_id); end
+def update_address(customer_id,
+                       address_id,
+                       request); end
 ```
 
 #### Parameters
@@ -591,115 +1656,115 @@ def delete_card(customer_id,
 | Parameter | Tags | Description |
 |-----------|------|-------------|
 | customer_id |  ``` Required ```  | Customer Id |
-| card_id |  ``` Required ```  | Card Id |
+| address_id |  ``` Required ```  | Address Id |
+| request |  ``` Required ```  | Request for updating an address |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
-card_id = 'card_id'
+address_id = 'address_id'
+request = UpdateAddressRequest.new
 
-result = customers.delete_card(customer_id, card_id)
+result = customers_controller.update_address(customer_id, address_id, request)
 
 ```
 
 
-### <a name="create_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_address") create_address
+### <a name="create_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_customer") create_customer
 
-> Creates a new address for a customer
+> Creates a new customer
 
 
 ```ruby
-def create_address(customer_id,
-                       request); end
+def create_customer(request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| customer_id |  ``` Required ```  | Customer Id |
-| request |  ``` Required ```  | Request for creating an address |
+| request |  ``` Required ```  | Request for creating a customer |
 
 
 #### Example Usage
 
 ```ruby
-customer_id = 'customer_id'
-request = CreateAddressRequest.new
+request = CreateCustomerRequest.new
 
-result = customers.create_address(customer_id, request)
+result = customers_controller.create_customer(request)
 
 ```
 
 
-### <a name="get_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_card") get_card
+### <a name="get_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_customer") get_customer
 
-> Get a customer's card
+> Get a customer
 
 
 ```ruby
-def get_card(customer_id,
-                 card_id); end
+def get_customer(customer_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| customer_id |  ``` Required ```  | Customer id |
-| card_id |  ``` Required ```  | Card id |
+| customer_id |  ``` Required ```  | Customer Id |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
-card_id = 'card_id'
 
-result = customers.get_card(customer_id, card_id)
+result = customers_controller.get_customer(customer_id)
 
 ```
 
 
-### <a name="create_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_card") create_card
+### <a name="get_access_tokens"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_access_tokens") get_access_tokens
 
-> Creates a new card for a customer
+> Get all access tokens from a customer
 
 
 ```ruby
-def create_card(customer_id,
-                    request); end
+def get_access_tokens(customer_id,
+                          page = nil,
+                          size = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| customer_id |  ``` Required ```  | Customer id |
-| request |  ``` Required ```  | Request for creating a card |
+| customer_id |  ``` Required ```  | Customer Id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
-request = CreateCardRequest.new
+page = 135
+size = 135
 
-result = customers.create_card(customer_id, request)
+result = customers_controller.get_access_tokens(customer_id, page, size)
 
 ```
 
 
-### <a name="update_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_customer") update_customer
+### <a name="get_addresses"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_addresses") get_addresses
 
-> Updates a customer
+> Gets all adressess from a customer
 
 
 ```ruby
-def update_customer(customer_id,
-                        request); end
+def get_addresses(customer_id,
+                      page = nil,
+                      size = nil); end
 ```
 
 #### Parameters
@@ -707,27 +1772,31 @@ def update_customer(customer_id,
 | Parameter | Tags | Description |
 |-----------|------|-------------|
 | customer_id |  ``` Required ```  | Customer id |
-| request |  ``` Required ```  | Request for updating a customer |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
-request = UpdateCustomerRequest.new
+page = 135
+size = 135
 
-result = customers.update_customer(customer_id, request)
+result = customers_controller.get_addresses(customer_id, page, size)
 
 ```
 
 
-### <a name="delete_access_tokens"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_access_tokens") delete_access_tokens
+### <a name="get_cards"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_cards") get_cards
 
-> Delete a Customer's access tokens
+> Get all cards from a customer
 
 
 ```ruby
-def delete_access_tokens(customer_id); end
+def get_cards(customer_id,
+                  page = nil,
+                  size = nil); end
 ```
 
 #### Parameters
@@ -735,52 +1804,44 @@ def delete_access_tokens(customer_id); end
 | Parameter | Tags | Description |
 |-----------|------|-------------|
 | customer_id |  ``` Required ```  | Customer Id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
+page = 135
+size = 135
 
-result = customers.delete_access_tokens(customer_id)
+result = customers_controller.get_cards(customer_id, page, size)
 
 ```
 
 
-### <a name="get_customers"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_customers") get_customers
+### <a name="delete_access_tokens"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_access_tokens") delete_access_tokens
 
-> Get all Customers
+> Delete a Customer's access tokens
 
 
 ```ruby
-def get_customers(name = nil,
-                      document = nil,
-                      page = 1,
-                      size = 10,
-                      email = nil); end
+def delete_access_tokens(customer_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| name |  ``` Optional ```  | Name of the Customer |
-| document |  ``` Optional ```  | Document of the Customer |
-| page |  ``` Optional ```  ``` DefaultValue ```  | Current page the the search |
-| size |  ``` Optional ```  ``` DefaultValue ```  | Quantity pages of the search |
-| email |  ``` Optional ```  | Customer's email |
+| customer_id |  ``` Required ```  | Customer Id |
 
 
 #### Example Usage
 
 ```ruby
-name = 'name'
-document = 'document'
-page = 1
-size = 10
-email = 'email'
+customer_id = 'customer_id'
 
-result = customers.get_customers(name, document, page, size, email)
+result = customers_controller.delete_access_tokens(customer_id)
 
 ```
 
@@ -809,7 +1870,7 @@ def get_access_token(customer_id,
 customer_id = 'customer_id'
 token_id = 'token_id'
 
-result = customers.get_access_token(customer_id, token_id)
+result = customers_controller.get_access_token(customer_id, token_id)
 
 ```
 
@@ -838,7 +1899,7 @@ def create_access_token(customer_id,
 customer_id = 'customer_id'
 request = CreateAccessTokenRequest.new
 
-result = customers.create_access_token(customer_id, request)
+result = customers_controller.create_access_token(customer_id, request)
 
 ```
 
@@ -867,7 +1928,7 @@ def delete_access_token(customer_id,
 customer_id = 'customer_id'
 token_id = 'token_id'
 
-result = customers.delete_access_token(customer_id, token_id)
+result = customers_controller.delete_access_token(customer_id, token_id)
 
 ```
 
@@ -896,52 +1957,48 @@ def update_customer_metadata(customer_id,
 customer_id = 'customer_id'
 request = UpdateMetadataRequest.new
 
-result = customers.update_customer_metadata(customer_id, request)
+result = customers_controller.update_customer_metadata(customer_id, request)
 
 ```
 
 
-### <a name="get_access_tokens"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_access_tokens") get_access_tokens
+### <a name="update_customer"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.update_customer") update_customer
 
-> Get all access tokens from a customer
+> Updates a customer
 
 
 ```ruby
-def get_access_tokens(customer_id,
-                          page = nil,
-                          size = nil); end
+def update_customer(customer_id,
+                        request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| customer_id |  ``` Required ```  | Customer Id |
-| page |  ``` Optional ```  | Page number |
-| size |  ``` Optional ```  | Page size |
+| customer_id |  ``` Required ```  | Customer id |
+| request |  ``` Required ```  | Request for updating a customer |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
-page = 60
-size = 60
+request = UpdateCustomerRequest.new
 
-result = customers.get_access_tokens(customer_id, page, size)
+result = customers_controller.update_customer(customer_id, request)
 
 ```
 
 
-### <a name="get_addresses"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_addresses") get_addresses
+### <a name="get_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_address") get_address
 
-> Gets all adressess from a customer
+> Get a customer's address
 
 
 ```ruby
-def get_addresses(customer_id,
-                      page = nil,
-                      size = nil); end
+def get_address(customer_id,
+                    address_id); end
 ```
 
 #### Parameters
@@ -949,31 +2006,28 @@ def get_addresses(customer_id,
 | Parameter | Tags | Description |
 |-----------|------|-------------|
 | customer_id |  ``` Required ```  | Customer id |
-| page |  ``` Optional ```  | Page number |
-| size |  ``` Optional ```  | Page size |
+| address_id |  ``` Required ```  | Address Id |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
-page = 60
-size = 60
+address_id = 'address_id'
 
-result = customers.get_addresses(customer_id, page, size)
+result = customers_controller.get_address(customer_id, address_id)
 
 ```
 
 
-### <a name="get_cards"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_cards") get_cards
+### <a name="delete_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_address") delete_address
 
-> Get all cards from a customer
+> Delete a Customer's address
 
 
 ```ruby
-def get_cards(customer_id,
-                  page = nil,
-                  size = nil); end
+def delete_address(customer_id,
+                       address_id); end
 ```
 
 #### Parameters
@@ -981,1100 +2035,1115 @@ def get_cards(customer_id,
 | Parameter | Tags | Description |
 |-----------|------|-------------|
 | customer_id |  ``` Required ```  | Customer Id |
-| page |  ``` Optional ```  | Page number |
-| size |  ``` Optional ```  | Page size |
+| address_id |  ``` Required ```  | Address Id |
 
 
 #### Example Usage
 
 ```ruby
 customer_id = 'customer_id'
-page = 19
-size = 19
+address_id = 'address_id'
 
-result = customers.get_cards(customer_id, page, size)
+result = customers_controller.delete_address(customer_id, address_id)
 
 ```
 
 
-[Back to List of Controllers](#list_of_controllers)
+### <a name="delete_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.delete_card") delete_card
 
-## <a name="invoices_controller"></a>![Class: ](https://apidocs.io/img/class.png ".InvoicesController") InvoicesController
+> Delete a customer's card
 
-### Get singleton instance
 
-The singleton instance of the ``` InvoicesController ``` class can be accessed from the API Client.
+```ruby
+def delete_card(customer_id,
+                    card_id); end
+```
+
+#### Parameters
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| customer_id |  ``` Required ```  | Customer Id |
+| card_id |  ``` Required ```  | Card Id |
+
+
+#### Example Usage
 
 ```ruby
-invoices = client.invoices
+customer_id = 'customer_id'
+card_id = 'card_id'
+
+result = customers_controller.delete_card(customer_id, card_id)
+
 ```
 
-### <a name="get_invoice"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.get_invoice") get_invoice
 
-> Gets an invoice
+### <a name="create_address"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_address") create_address
+
+> Creates a new address for a customer
 
 
 ```ruby
-def get_invoice(invoice_id); end
+def create_address(customer_id,
+                       request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| invoice_id |  ``` Required ```  | Invoice Id |
+| customer_id |  ``` Required ```  | Customer Id |
+| request |  ``` Required ```  | Request for creating an address |
 
 
 #### Example Usage
 
 ```ruby
-invoice_id = 'invoice_id'
+customer_id = 'customer_id'
+request = CreateAddressRequest.new
 
-result = invoices.get_invoice(invoice_id)
+result = customers_controller.create_address(customer_id, request)
 
 ```
 
 
-### <a name="cancel_invoice"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.cancel_invoice") cancel_invoice
+### <a name="get_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_card") get_card
 
-> Cancels an invoice
+> Get a customer's card
 
 
 ```ruby
-def cancel_invoice(invoice_id); end
+def get_card(customer_id,
+                 card_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| invoice_id |  ``` Required ```  | Invoice id |
+| customer_id |  ``` Required ```  | Customer id |
+| card_id |  ``` Required ```  | Card id |
 
 
 #### Example Usage
 
 ```ruby
-invoice_id = 'invoice_id'
+customer_id = 'customer_id'
+card_id = 'card_id'
 
-result = invoices.cancel_invoice(invoice_id)
+result = customers_controller.get_card(customer_id, card_id)
 
 ```
 
 
-### <a name="update_invoice_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.update_invoice_metadata") update_invoice_metadata
+### <a name="create_card"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.create_card") create_card
 
-> Updates the metadata from an invoice
+> Creates a new card for a customer
 
 
 ```ruby
-def update_invoice_metadata(invoice_id,
-                                request); end
+def create_card(customer_id,
+                    request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| invoice_id |  ``` Required ```  | The invoice id |
-| request |  ``` Required ```  | Request for updating the invoice metadata |
+| customer_id |  ``` Required ```  | Customer id |
+| request |  ``` Required ```  | Request for creating a card |
 
 
 #### Example Usage
 
 ```ruby
-invoice_id = 'invoice_id'
-request = UpdateMetadataRequest.new
+customer_id = 'customer_id'
+request = CreateCardRequest.new
 
-result = invoices.update_invoice_metadata(invoice_id, request)
+result = customers_controller.create_card(customer_id, request)
 
 ```
 
 
-### <a name="get_invoices"></a>![Method: ](https://apidocs.io/img/method.png ".InvoicesController.get_invoices") get_invoices
-
-> Gets all invoices
-
-
-```ruby
-def get_invoices(page = nil,
-                     size = nil,
-                     code = nil,
-                     customer_id = nil,
-                     subscription_id = nil,
-                     created_since = nil,
-                     created_until = nil,
-                     status = nil,
-                     due_since = nil,
-                     due_until = nil); end
+### <a name="get_customers"></a>![Method: ](https://apidocs.io/img/method.png ".CustomersController.get_customers") get_customers
+
+> Get all Customers
+
+
+```ruby
+def get_customers(code,
+                      name = nil,
+                      document = nil,
+                      page = 1,
+                      size = 10,
+                      email = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| page |  ``` Optional ```  | Page number |
-| size |  ``` Optional ```  | Page size |
-| code |  ``` Optional ```  | Filter for Invoice's code |
-| customer_id |  ``` Optional ```  | Filter for Invoice's customer id |
-| subscription_id |  ``` Optional ```  | Filter for Invoice's subscription id |
-| created_since |  ``` Optional ```  | Filter for Invoice's creation date start range |
-| created_until |  ``` Optional ```  | Filter for Invoices creation date end range |
-| status |  ``` Optional ```  | Filter for Invoice's status |
-| due_since |  ``` Optional ```  | Filter for Invoice's due date start range |
-| due_until |  ``` Optional ```  | Filter for Invoice's due date end range |
+| code |  ``` Required ```  | Customer's code |
+| name |  ``` Optional ```  | Name of the Customer |
+| document |  ``` Optional ```  | Document of the Customer |
+| page |  ``` Optional ```  ``` DefaultValue ```  | Current page the the search |
+| size |  ``` Optional ```  ``` DefaultValue ```  | Quantity pages of the search |
+| email |  ``` Optional ```  | Customer's email |
 
 
 #### Example Usage
 
 ```ruby
-page = 19
-size = 19
-code = 'code'
-customer_id = 'customer_id'
-subscription_id = 'subscription_id'
-created_since = DateTime.now
-created_until = DateTime.now
-status = 'status'
-due_since = DateTime.now
-due_until = DateTime.now
+code = 'Code'
+name = 'name'
+document = 'document'
+page = 1
+size = 10
+email = 'email'
 
-result = invoices.get_invoices(page, size, code, customer_id, subscription_id, created_since, created_until, status, due_since, due_until)
+result = customers_controller.get_customers(code, name, document, page, size, email)
 
 ```
 
 
 [Back to List of Controllers](#list_of_controllers)
 
-## <a name="plans_controller"></a>![Class: ](https://apidocs.io/img/class.png ".PlansController") PlansController
+## <a name="charges_controller"></a>![Class: ](https://apidocs.io/img/class.png ".ChargesController") ChargesController
 
 ### Get singleton instance
 
-The singleton instance of the ``` PlansController ``` class can be accessed from the API Client.
+The singleton instance of the ``` ChargesController ``` class can be accessed from the API Client.
 
 ```ruby
-plans = client.plans
+charges_controller = client.charges
 ```
 
-### <a name="update_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan_item") update_plan_item
+### <a name="update_charge_card"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_card") update_charge_card
 
-> Updates a plan item
+> Updates the card from a charge
 
 
 ```ruby
-def update_plan_item(plan_id,
-                         plan_item_id,
-                         body); end
+def update_charge_card(charge_id,
+                           request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| plan_id |  ``` Required ```  | Plan id |
-| plan_item_id |  ``` Required ```  | Plan item id |
-| body |  ``` Required ```  | Request for updating the plan item |
+| charge_id |  ``` Required ```  | Charge id |
+| request |  ``` Required ```  | Request for updating a charge's card |
 
 
 #### Example Usage
 
 ```ruby
-plan_id = 'plan_id'
-plan_item_id = 'plan_item_id'
-body = UpdatePlanItemRequest.new
+charge_id = 'charge_id'
+request = UpdateChargeCardRequest.new
 
-result = plans.update_plan_item(plan_id, plan_item_id, body)
+result = charges_controller.update_charge_card(charge_id, request)
 
 ```
 
 
-### <a name="get_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plan") get_plan
+### <a name="update_charge_payment_method"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_payment_method") update_charge_payment_method
 
-> Gets a plan
+> Updates a charge's payment method
 
 
 ```ruby
-def get_plan(plan_id); end
+def update_charge_payment_method(charge_id,
+                                     request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| plan_id |  ``` Required ```  | Plan id |
+| charge_id |  ``` Required ```  | Charge id |
+| request |  ``` Required ```  | Request for updating the payment method from a charge |
 
 
 #### Example Usage
 
 ```ruby
-plan_id = 'plan_id'
+charge_id = 'charge_id'
+request = UpdateChargePaymentMethodRequest.new
 
-result = plans.get_plan(plan_id)
+result = charges_controller.update_charge_payment_method(charge_id, request)
 
 ```
 
 
-### <a name="create_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.create_plan_item") create_plan_item
+### <a name="create_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.create_charge") create_charge
 
-> Adds a new item to a plan
+> Creates a new charge
 
 
 ```ruby
-def create_plan_item(plan_id,
-                         request); end
+def create_charge(request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| plan_id |  ``` Required ```  | Plan id |
-| request |  ``` Required ```  | Request for creating a plan item |
+| request |  ``` Required ```  | Request for creating a charge |
 
 
 #### Example Usage
 
 ```ruby
-plan_id = 'plan_id'
-request = CreatePlanItemRequest.new
+request = CreateChargeRequest.new
 
-result = plans.create_plan_item(plan_id, request)
+result = charges_controller.create_charge(request)
 
 ```
 
 
-### <a name="update_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan") update_plan
+### <a name="get_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.get_charge") get_charge
 
-> Updates a plan
+> Get a charge from its id
 
 
 ```ruby
-def update_plan(plan_id,
-                    request); end
+def get_charge(charge_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| plan_id |  ``` Required ```  | Plan id |
-| request |  ``` Required ```  | Request for updating a plan |
+| charge_id |  ``` Required ```  | Charge id |
 
 
 #### Example Usage
 
 ```ruby
-plan_id = 'plan_id'
-request = UpdatePlanRequest.new
+charge_id = 'charge_id'
 
-result = plans.update_plan(plan_id, request)
+result = charges_controller.get_charge(charge_id)
 
 ```
 
 
-### <a name="create_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.create_plan") create_plan
+### <a name="retry_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.retry_charge") retry_charge
 
-> Creates a new plan
+> Retries a charge
 
 
 ```ruby
-def create_plan(body); end
+def retry_charge(charge_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| body |  ``` Required ```  | Request for creating a plan |
+| charge_id |  ``` Required ```  | Charge id |
 
 
 #### Example Usage
 
 ```ruby
-body = CreatePlanRequest.new
+charge_id = 'charge_id'
 
-result = plans.create_plan(body)
+result = charges_controller.retry_charge(charge_id)
 
 ```
 
 
-### <a name="delete_plan"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.delete_plan") delete_plan
+### <a name="get_charges"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.get_charges") get_charges
 
-> Deletes a plan
+> Lists all charges
 
 
 ```ruby
-def delete_plan(plan_id); end
+def get_charges(page = nil,
+                    size = nil,
+                    code = nil,
+                    status = nil,
+                    payment_method = nil,
+                    customer_id = nil,
+                    order_id = nil,
+                    created_since = nil,
+                    created_until = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| plan_id |  ``` Required ```  | Plan id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| code |  ``` Optional ```  | Filter for charge's code |
+| status |  ``` Optional ```  | Filter for charge's status |
+| payment_method |  ``` Optional ```  | Filter for charge's payment method |
+| customer_id |  ``` Optional ```  | Filter for charge's customer id |
+| order_id |  ``` Optional ```  | Filter for charge's order id |
+| created_since |  ``` Optional ```  | Filter for the beginning of the range for charge's creation |
+| created_until |  ``` Optional ```  | Filter for the end of the range for charge's creation |
 
 
 #### Example Usage
 
 ```ruby
-plan_id = 'plan_id'
+page = 93
+size = 93
+code = 'code'
+status = 'status'
+payment_method = 'payment_method'
+customer_id = 'customer_id'
+order_id = 'order_id'
+created_since = DateTime.now
+created_until = DateTime.now
 
-result = plans.delete_plan(plan_id)
+result = charges_controller.get_charges(page, size, code, status, payment_method, customer_id, order_id, created_since, created_until)
 
 ```
 
 
-### <a name="get_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plan_item") get_plan_item
+### <a name="update_charge_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_metadata") update_charge_metadata
 
-> Gets a plan item
+> Updates the metadata from a charge
 
 
 ```ruby
-def get_plan_item(plan_id,
-                      plan_item_id); end
+def update_charge_metadata(charge_id,
+                               request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| plan_id |  ``` Required ```  | Plan id |
-| plan_item_id |  ``` Required ```  | Plan item id |
+| charge_id |  ``` Required ```  | The charge id |
+| request |  ``` Required ```  | Request for updating the charge metadata |
 
 
 #### Example Usage
 
 ```ruby
-plan_id = 'plan_id'
-plan_item_id = 'plan_item_id'
+charge_id = 'charge_id'
+request = UpdateMetadataRequest.new
 
-result = plans.get_plan_item(plan_id, plan_item_id)
+result = charges_controller.update_charge_metadata(charge_id, request)
 
 ```
 
 
-### <a name="delete_plan_item"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.delete_plan_item") delete_plan_item
+### <a name="cancel_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.cancel_charge") cancel_charge
 
-> Removes an item from a plan
+> Cancel a charge
 
 
 ```ruby
-def delete_plan_item(plan_id,
-                         plan_item_id); end
+def cancel_charge(charge_id,
+                      request = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| plan_id |  ``` Required ```  | Plan id |
-| plan_item_id |  ``` Required ```  | Plan item id |
+| charge_id |  ``` Required ```  | Charge id |
+| request |  ``` Optional ```  | Request for cancelling a charge |
 
 
 #### Example Usage
 
 ```ruby
-plan_id = 'plan_id'
-plan_item_id = 'plan_item_id'
+charge_id = 'charge_id'
+request = CreateCancelChargeRequest.new
 
-result = plans.delete_plan_item(plan_id, plan_item_id)
+result = charges_controller.cancel_charge(charge_id, request)
 
 ```
 
 
-### <a name="update_plan_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.update_plan_metadata") update_plan_metadata
+### <a name="capture_charge"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.capture_charge") capture_charge
 
-> Updates the metadata from a plan
+> Captures a charge
 
 
 ```ruby
-def update_plan_metadata(plan_id,
-                             request); end
+def capture_charge(charge_id,
+                       request = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| plan_id |  ``` Required ```  | The plan id |
-| request |  ``` Required ```  | Request for updating the plan metadata |
+| charge_id |  ``` Required ```  | Charge id |
+| request |  ``` Optional ```  | Request for capturing a charge |
 
 
 #### Example Usage
 
 ```ruby
-plan_id = 'plan_id'
-request = UpdateMetadataRequest.new
+charge_id = 'charge_id'
+request = CreateCaptureChargeRequest.new
 
-result = plans.update_plan_metadata(plan_id, request)
+result = charges_controller.capture_charge(charge_id, request)
 
 ```
 
 
-### <a name="get_plans"></a>![Method: ](https://apidocs.io/img/method.png ".PlansController.get_plans") get_plans
+### <a name="update_charge_due_date"></a>![Method: ](https://apidocs.io/img/method.png ".ChargesController.update_charge_due_date") update_charge_due_date
 
-> Gets all plans
+> Updates the due date from a charge
 
 
 ```ruby
-def get_plans(page = nil,
-                  size = nil,
-                  name = nil,
-                  status = nil,
-                  billing_type = nil,
-                  created_since = nil,
-                  created_until = nil); end
+def update_charge_due_date(charge_id,
+                               request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| page |  ``` Optional ```  | Page number |
-| size |  ``` Optional ```  | Page size |
-| name |  ``` Optional ```  | Filter for Plan's name |
-| status |  ``` Optional ```  | Filter for Plan's status |
-| billing_type |  ``` Optional ```  | Filter for plan's billing type |
-| created_since |  ``` Optional ```  | Filter for plan's creation date start range |
-| created_until |  ``` Optional ```  | Filter for plan's creation date end range |
+| charge_id |  ``` Required ```  | Charge Id |
+| request |  ``` Required ```  | Request for updating the due date |
 
 
 #### Example Usage
 
 ```ruby
-page = 19
-size = 19
-name = 'name'
-status = 'status'
-billing_type = 'billing_type'
-created_since = DateTime.now
-created_until = DateTime.now
+charge_id = 'charge_id'
+request = UpdateChargeDueDateRequest.new
 
-result = plans.get_plans(page, size, name, status, billing_type, created_since, created_until)
+result = charges_controller.update_charge_due_date(charge_id, request)
 
 ```
 
 
 [Back to List of Controllers](#list_of_controllers)
 
-## <a name="subscriptions_controller"></a>![Class: ](https://apidocs.io/img/class.png ".SubscriptionsController") SubscriptionsController
+## <a name="recipients_controller"></a>![Class: ](https://apidocs.io/img/class.png ".RecipientsController") RecipientsController
 
 ### Get singleton instance
 
-The singleton instance of the ``` SubscriptionsController ``` class can be accessed from the API Client.
+The singleton instance of the ``` RecipientsController ``` class can be accessed from the API Client.
 
 ```ruby
-subscriptions = client.subscriptions
+recipients_controller = client.recipients
 ```
 
-### <a name="update_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_item") update_subscription_item
+### <a name="update_recipient_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.update_recipient_metadata") update_recipient_metadata
 
-> Updates a subscription item
+> Updates recipient metadata
 
 
 ```ruby
-def update_subscription_item(subscription_id,
-                                 item_id,
-                                 body); end
+def update_recipient_metadata(recipient_id,
+                                  request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription Id |
-| item_id |  ``` Required ```  | Item id |
-| body |  ``` Required ```  | Request for updating a subscription item |
+| recipient_id |  ``` Required ```  | Recipient id |
+| request |  ``` Required ```  | Metadata |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-item_id = 'item_id'
-body = UpdateSubscriptionItemRequest.new
+recipient_id = 'recipient_id'
+request = UpdateMetadataRequest.new
 
-result = subscriptions.update_subscription_item(subscription_id, item_id, body)
+result = recipients_controller.update_recipient_metadata(recipient_id, request)
 
 ```
 
 
-### <a name="create_usage"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_usage") create_usage
+### <a name="get_transfer"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.get_transfer") get_transfer
 
-> Creates a usage
+> Gets a transfer
 
 
 ```ruby
-def create_usage(subscription_id,
-                     item_id,
-                     body); end
+def get_transfer(recipient_id,
+                     transfer_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription Id |
-| item_id |  ``` Required ```  | Item id |
-| body |  ``` Required ```  | Request for creating a usage |
+| recipient_id |  ``` Required ```  | Recipient id |
+| transfer_id |  ``` Required ```  | Transfer id |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-item_id = 'item_id'
-body = CreateUsageRequest.new
+recipient_id = 'recipient_id'
+transfer_id = 'transfer_id'
 
-result = subscriptions.create_usage(subscription_id, item_id, body)
+result = recipients_controller.get_transfer(recipient_id, transfer_id)
 
 ```
 
 
-### <a name="update_subscription_billing_date"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_billing_date") update_subscription_billing_date
+### <a name="get_transfers"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.get_transfers") get_transfers
 
-> Updates the billing date from a subscription
+> Gets a paginated list of transfers for the recipient
 
 
 ```ruby
-def update_subscription_billing_date(subscription_id,
-                                         request); end
+def get_transfers(recipient_id,
+                      page = nil,
+                      size = nil,
+                      status = nil,
+                      created_since = nil,
+                      created_until = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | The subscription id |
-| request |  ``` Required ```  | Request for updating the subscription billing date |
+| recipient_id |  ``` Required ```  | Recipient id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| status |  ``` Optional ```  | Filter for transfer status |
+| created_since |  ``` Optional ```  | Filter for start range of transfer creation date |
+| created_until |  ``` Optional ```  | Filter for end range of transfer creation date |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-request = UpdateSubscriptionBillingDateRequest.new
+recipient_id = 'recipient_id'
+page = 93
+size = 93
+status = 'status'
+created_since = DateTime.now
+created_until = DateTime.now
 
-result = subscriptions.update_subscription_billing_date(subscription_id, request)
+result = recipients_controller.get_transfers(recipient_id, page, size, status, created_since, created_until)
 
 ```
 
 
-### <a name="update_subscription_card"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_card") update_subscription_card
+### <a name="create_anticipation"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.create_anticipation") create_anticipation
 
-> Updates the credit card from a subscription
+> Creates an anticipation
 
 
-```ruby
-def update_subscription_card(subscription_id,
-                                 request); end
+```ruby
+def create_anticipation(recipient_id,
+                            request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription id |
-| request |  ``` Required ```  | Request for updating a card |
+| recipient_id |  ``` Required ```  | Recipient id |
+| request |  ``` Required ```  | Anticipation data |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-request = UpdateSubscriptionCardRequest.new
+recipient_id = 'recipient_id'
+request = CreateAnticipationRequest.new
 
-result = subscriptions.update_subscription_card(subscription_id, request)
+result = recipients_controller.create_anticipation(recipient_id, request)
 
 ```
 
 
-### <a name="create_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_subscription") create_subscription
+### <a name="get_anticipation"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.get_anticipation") get_anticipation
 
-> Creates a new subscription
+> Gets an anticipation
 
 
 ```ruby
-def create_subscription(body); end
+def get_anticipation(recipient_id,
+                         anticipation_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| body |  ``` Required ```  | Request for creating a subscription |
+| recipient_id |  ``` Required ```  | Recipient id |
+| anticipation_id |  ``` Required ```  | Anticipation id |
 
 
 #### Example Usage
 
 ```ruby
-body = CreateSubscriptionRequest.new
+recipient_id = 'recipient_id'
+anticipation_id = 'anticipation_id'
 
-result = subscriptions.create_subscription(body)
+result = recipients_controller.get_anticipation(recipient_id, anticipation_id)
 
 ```
 
 
-### <a name="create_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_subscription_item") create_subscription_item
+### <a name="get_anticipation_limits"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.get_anticipation_limits") get_anticipation_limits
 
-> Creates a new Subscription item
+> Gets the anticipation limits for a recipient
 
 
 ```ruby
-def create_subscription_item(subscription_id,
-                                 request); end
+def get_anticipation_limits(recipient_id,
+                                timeframe,
+                                payment_date); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription id |
-| request |  ``` Required ```  | Request for creating a subscription item |
+| recipient_id |  ``` Required ```  | Recipient id |
+| timeframe |  ``` Required ```  | Timeframe |
+| payment_date |  ``` Required ```  | Anticipation payment date |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-request = CreateSubscriptionItemRequest.new
+recipient_id = 'recipient_id'
+timeframe = 'timeframe'
+payment_date = DateTime.now
 
-result = subscriptions.create_subscription_item(subscription_id, request)
+result = recipients_controller.get_anticipation_limits(recipient_id, timeframe, payment_date)
 
 ```
 
 
-### <a name="create_discount"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.create_discount") create_discount
+### <a name="get_anticipations"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.get_anticipations") get_anticipations
 
-> Creates a discount
+> Retrieves a paginated list of anticipations from a recipient
 
 
 ```ruby
-def create_discount(subscription_id,
-                        request); end
+def get_anticipations(recipient_id,
+                          page = nil,
+                          size = nil,
+                          status = nil,
+                          timeframe = nil,
+                          payment_date_since = nil,
+                          payment_date_until = nil,
+                          created_since = nil,
+                          created_until = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription id |
-| request |  ``` Required ```  | Request for creating a discount |
+| recipient_id |  ``` Required ```  | Recipient id |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
+| status |  ``` Optional ```  | Filter for anticipation status |
+| timeframe |  ``` Optional ```  | Filter for anticipation timeframe |
+| payment_date_since |  ``` Optional ```  | Filter for start range for anticipation payment date |
+| payment_date_until |  ``` Optional ```  | Filter for end range for anticipation payment date |
+| created_since |  ``` Optional ```  | Filter for start range for anticipation creation date |
+| created_until |  ``` Optional ```  | Filter for end range for anticipation creation date |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-request = CreateDiscountRequest.new
+recipient_id = 'recipient_id'
+page = 184
+size = 184
+status = 'status'
+timeframe = 'timeframe'
+payment_date_since = DateTime.now
+payment_date_until = DateTime.now
+created_since = DateTime.now
+created_until = DateTime.now
 
-result = subscriptions.create_discount(subscription_id, request)
+result = recipients_controller.get_anticipations(recipient_id, page, size, status, timeframe, payment_date_since, payment_date_until, created_since, created_until)
 
 ```
 
 
-### <a name="get_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_subscription") get_subscription
+### <a name="update_recipient"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.update_recipient") update_recipient
 
-> Gets a subscription
+> Updates a recipient
 
 
 ```ruby
-def get_subscription(subscription_id); end
+def update_recipient(recipient_id,
+                         request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription id |
+| recipient_id |  ``` Required ```  | Recipient id |
+| request |  ``` Required ```  | Recipient data |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
+recipient_id = 'recipient_id'
+request = UpdateRecipientRequest.new
 
-result = subscriptions.get_subscription(subscription_id)
+result = recipients_controller.update_recipient(recipient_id, request)
 
 ```
 
 
-### <a name="update_subscription_payment_method"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_payment_method") update_subscription_payment_method
+### <a name="update_recipient_default_bank_account"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.update_recipient_default_bank_account") update_recipient_default_bank_account
 
-> Updates the payment method from a subscription
+> Updates the default bank account from a recipient
 
 
 ```ruby
-def update_subscription_payment_method(subscription_id,
-                                           request); end
+def update_recipient_default_bank_account(recipient_id,
+                                              request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription id |
-| request |  ``` Required ```  | Request for updating the paymentmethod from a subscription |
+| recipient_id |  ``` Required ```  | Recipient id |
+| request |  ``` Required ```  | Bank account data |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-request = UpdateSubscriptionPaymentMethodRequest.new
+recipient_id = 'recipient_id'
+request = UpdateRecipientBankAccountRequest.new
 
-result = subscriptions.update_subscription_payment_method(subscription_id, request)
+result = recipients_controller.update_recipient_default_bank_account(recipient_id, request)
 
 ```
 
 
-### <a name="delete_discount"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_discount") delete_discount
+### <a name="get_recipient"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.get_recipient") get_recipient
 
-> Deletes a discount
+> Retrieves recipient information
 
 
 ```ruby
-def delete_discount(subscription_id,
-                        discount_id); end
+def get_recipient(recipient_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription id |
-| discount_id |  ``` Required ```  | Discount Id |
+| recipient_id |  ``` Required ```  | Recipiend id |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-discount_id = 'discount_id'
+recipient_id = 'recipient_id'
 
-result = subscriptions.delete_discount(subscription_id, discount_id)
+result = recipients_controller.get_recipient(recipient_id)
 
 ```
 
 
-### <a name="cancel_subscription"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.cancel_subscription") cancel_subscription
+### <a name="get_recipients"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.get_recipients") get_recipients
 
-> Cancels a subscription
+> Retrieves paginated recipients information
 
 
 ```ruby
-def cancel_subscription(subscription_id,
-                            request = nil); end
+def get_recipients(page = nil,
+                       size = nil); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription id |
-| request |  ``` Optional ```  | Request for cancelling a subscription |
+| page |  ``` Optional ```  | Page number |
+| size |  ``` Optional ```  | Page size |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-request = CreateCancelSubscriptionRequest.new
+page = 184
+size = 184
 
-result = subscriptions.cancel_subscription(subscription_id, request)
+result = recipients_controller.get_recipients(page, size)
 
 ```
 
 
-### <a name="delete_subscription_item"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_subscription_item") delete_subscription_item
+### <a name="get_balance"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.get_balance") get_balance
 
-> Deletes a subscription item
+> Get balance information for a recipient
 
 
 ```ruby
-def delete_subscription_item(subscription_id,
-                                 subscription_item_id); end
+def get_balance(recipient_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | Subscription id |
-| subscription_item_id |  ``` Required ```  | Subscription item id |
+| recipient_id |  ``` Required ```  | Recipient id |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-subscription_item_id = 'subscription_item_id'
+recipient_id = 'recipient_id'
 
-result = subscriptions.delete_subscription_item(subscription_id, subscription_item_id)
+result = recipients_controller.get_balance(recipient_id)
 
 ```
 
 
-### <a name="delete_usage"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.delete_usage") delete_usage
+### <a name="create_transfer"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.create_transfer") create_transfer
 
-> Deletes a usage
+> Creates a transfer for a recipient
 
 
 ```ruby
-def delete_usage(subscription_id,
-                     item_id,
-                     usage_id); end
+def create_transfer(recipient_id,
+                        request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | The subscription id |
-| item_id |  ``` Required ```  | The subscription item id |
-| usage_id |  ``` Required ```  | The usage id |
+| recipient_id |  ``` Required ```  | Recipient Id |
+| request |  ``` Required ```  | Transfer data |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-item_id = 'item_id'
-usage_id = 'usage_id'
+recipient_id = 'recipient_id'
+request = CreateTransferRequest.new
 
-result = subscriptions.delete_usage(subscription_id, item_id, usage_id)
+result = recipients_controller.create_transfer(recipient_id, request)
 
 ```
 
 
-### <a name="get_usages"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_usages") get_usages
+### <a name="create_recipient"></a>![Method: ](https://apidocs.io/img/method.png ".RecipientsController.create_recipient") create_recipient
 
-> Lists all usages from a subscription item
+> Creates a new recipient
 
 
 ```ruby
-def get_usages(subscription_id,
-                   item_id,
-                   page = nil,
-                   size = nil); end
+def create_recipient(request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | The subscription id |
-| item_id |  ``` Required ```  | The subscription item id |
-| page |  ``` Optional ```  | Page number |
-| size |  ``` Optional ```  | Page size |
+| request |  ``` Required ```  | Recipient data |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-item_id = 'item_id'
-page = 110
-size = 110
+request = CreateRecipientRequest.new
 
-result = subscriptions.get_usages(subscription_id, item_id, page, size)
+result = recipients_controller.create_recipient(request)
 
 ```
 
 
-### <a name="update_subscription_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.update_subscription_metadata") update_subscription_metadata
+[Back to List of Controllers](#list_of_controllers)
 
-> Updates the metadata from a subscription
+## <a name="tokens_controller"></a>![Class: ](https://apidocs.io/img/class.png ".TokensController") TokensController
+
+### Get singleton instance
 
+The singleton instance of the ``` TokensController ``` class can be accessed from the API Client.
 
 ```ruby
-def update_subscription_metadata(subscription_id,
-                                     request); end
+tokens_controller = client.tokens
+```
+
+### <a name="get_token"></a>![Method: ](https://apidocs.io/img/method.png ".TokensController.get_token") get_token
+
+> *Tags:*  ``` Skips Authentication ``` 
+
+> Gets a token from its id
+
+
+```ruby
+def get_token(id,
+                  public_key); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| subscription_id |  ``` Required ```  | The subscription id |
-| request |  ``` Required ```  | Request for updating the subscrption metadata |
+| id |  ``` Required ```  | Token id |
+| public_key |  ``` Required ```  | Public key |
 
 
 #### Example Usage
 
 ```ruby
-subscription_id = 'subscription_id'
-request = UpdateMetadataRequest.new
+id = 'id'
+public_key = 'public_key'
 
-result = subscriptions.update_subscription_metadata(subscription_id, request)
+result = tokens_controller.get_token(id, public_key)
 
 ```
 
 
-### <a name="get_subscriptions"></a>![Method: ](https://apidocs.io/img/method.png ".SubscriptionsController.get_subscriptions") get_subscriptions
+### <a name="create_token"></a>![Method: ](https://apidocs.io/img/method.png ".TokensController.create_token") create_token
 
-> Gets all subscriptions
+> *Tags:*  ``` Skips Authentication ``` 
+
+> TODO: Add a method description
 
 
 ```ruby
-def get_subscriptions(page = nil,
-                          size = nil,
-                          code = nil,
-                          billing_type = nil,
-                          customer_id = nil,
-                          plan_id = nil,
-                          card_id = nil,
-                          status = nil,
-                          next_billing_since = nil,
-                          next_billing_until = nil,
-                          created_since = nil,
-                          created_until = nil); end
+def create_token(public_key,
+                     request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| page |  ``` Optional ```  | Page number |
-| size |  ``` Optional ```  | Page size |
-| code |  ``` Optional ```  | Filter for subscription's code |
-| billing_type |  ``` Optional ```  | Filter for subscription's billing type |
-| customer_id |  ``` Optional ```  | Filter for subscription's customer id |
-| plan_id |  ``` Optional ```  | Filter for subscription's plan id |
-| card_id |  ``` Optional ```  | Filter for subscription's card id |
-| status |  ``` Optional ```  | Filter for subscription's status |
-| next_billing_since |  ``` Optional ```  | Filter for subscription's next billing date start range |
-| next_billing_until |  ``` Optional ```  | Filter for subscription's next billing date end range |
-| created_since |  ``` Optional ```  | Filter for subscription's creation date start range |
-| created_until |  ``` Optional ```  | Filter for subscriptions creation date end range |
+| public_key |  ``` Required ```  | Public key |
+| request |  ``` Required ```  | Request for creating a token |
 
 
 #### Example Usage
 
 ```ruby
-page = 110
-size = 110
-code = 'code'
-billing_type = 'billing_type'
-customer_id = 'customer_id'
-plan_id = 'plan_id'
-card_id = 'card_id'
-status = 'status'
-next_billing_since = DateTime.now
-next_billing_until = DateTime.now
-created_since = DateTime.now
-created_until = DateTime.now
+public_key = 'public_key'
+request = CreateTokenRequest.new
 
-result = subscriptions.get_subscriptions(page, size, code, billing_type, customer_id, plan_id, card_id, status, next_billing_since, next_billing_until, created_since, created_until)
+result = tokens_controller.create_token(public_key, request)
 
 ```
 
 
 [Back to List of Controllers](#list_of_controllers)
 
-## <a name="orders_controller"></a>![Class: ](https://apidocs.io/img/class.png ".OrdersController") OrdersController
+## <a name="sellers_controller"></a>![Class: ](https://apidocs.io/img/class.png ".SellersController") SellersController
 
 ### Get singleton instance
 
-The singleton instance of the ``` OrdersController ``` class can be accessed from the API Client.
+The singleton instance of the ``` SellersController ``` class can be accessed from the API Client.
 
 ```ruby
-orders = client.orders
+sellers_controller = client.sellers
 ```
 
-### <a name="get_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_order") get_order
+### <a name="get_seller_by_id"></a>![Method: ](https://apidocs.io/img/method.png ".SellersController.get_seller_by_id") get_seller_by_id
 
-> Gets an order
+> TODO: Add a method description
 
 
 ```ruby
-def get_order(order_id); end
+def get_seller_by_id(id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| order_id |  ``` Required ```  | Order id |
+| id |  ``` Required ```  | Seller Id |
 
 
 #### Example Usage
 
 ```ruby
-order_id = 'order_id'
+id = 'id'
 
-result = orders.get_order(order_id)
+result = sellers_controller.get_seller_by_id(id)
 
 ```
 
 
-### <a name="create_order"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.create_order") create_order
+### <a name="delete_seller"></a>![Method: ](https://apidocs.io/img/method.png ".SellersController.delete_seller") delete_seller
 
-> Creates a new Order
+> TODO: Add a method description
 
 
 ```ruby
-def create_order(body); end
+def delete_seller(seller_id); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| body |  ``` Required ```  | Request for creating an order |
+| seller_id |  ``` Required ```  | Seller Id |
 
 
 #### Example Usage
 
 ```ruby
-body = CreateOrderRequest.new
+seller_id = 'sellerId'
 
-result = orders.create_order(body)
+result = sellers_controller.delete_seller(seller_id)
 
 ```
 
 
-### <a name="update_order_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.update_order_metadata") update_order_metadata
+### <a name="create_seller"></a>![Method: ](https://apidocs.io/img/method.png ".SellersController.create_seller") create_seller
 
-> Updates the metadata from an order
+> TODO: Add a method description
 
 
 ```ruby
-def update_order_metadata(order_id,
-                              request); end
+def create_seller(request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| order_id |  ``` Required ```  | The order id |
-| request |  ``` Required ```  | Request for updating the order metadata |
+| request |  ``` Required ```  | Seller Model |
 
 
 #### Example Usage
 
 ```ruby
-order_id = 'order_id'
-request = UpdateMetadataRequest.new
+request = CreateSellerRequest.new
 
-result = orders.update_order_metadata(order_id, request)
+result = sellers_controller.create_seller(request)
 
 ```
 
 
-### <a name="get_orders"></a>![Method: ](https://apidocs.io/img/method.png ".OrdersController.get_orders") get_orders
+### <a name="get_sellers"></a>![Method: ](https://apidocs.io/img/method.png ".SellersController.get_sellers") get_sellers
 
-> Gets all orders
+> TODO: Add a method description
 
 
 ```ruby
-def get_orders(page = nil,
-                   size = nil,
-                   code = nil,
-                   status = nil,
-                   created_since = nil,
-                   created_until = nil,
-                   customer_id = nil); end
+def get_sellers(page = nil,
+                    size = nil,
+                    name = nil,
+                    document = nil,
+                    code = nil,
+                    status = nil,
+                    type = nil,
+                    created_since = nil,
+                    created_until = nil); end
 ```
 
 #### Parameters
@@ -2083,99 +3152,87 @@ def get_orders(page = nil,
 |-----------|------|-------------|
 | page |  ``` Optional ```  | Page number |
 | size |  ``` Optional ```  | Page size |
-| code |  ``` Optional ```  | Filter for order's code |
-| status |  ``` Optional ```  | Filter for order's status |
-| created_since |  ``` Optional ```  | Filter for order's creation date start range |
-| created_until |  ``` Optional ```  | Filter for order's creation date end range |
-| customer_id |  ``` Optional ```  | Filter for order's customer id |
+| name |  ``` Optional ```  | TODO: Add a parameter description |
+| document |  ``` Optional ```  | TODO: Add a parameter description |
+| code |  ``` Optional ```  | TODO: Add a parameter description |
+| status |  ``` Optional ```  | TODO: Add a parameter description |
+| type |  ``` Optional ```  | TODO: Add a parameter description |
+| created_since |  ``` Optional ```  | TODO: Add a parameter description |
+| created_until |  ``` Optional ```  | TODO: Add a parameter description |
 
 
 #### Example Usage
 
 ```ruby
-page = 110
-size = 110
+page = 184
+size = 184
+name = 'name'
+document = 'document'
 code = 'code'
 status = 'status'
+type = 'type'
 created_since = DateTime.now
 created_until = DateTime.now
-customer_id = 'customer_id'
-
-result = orders.get_orders(page, size, code, status, created_since, created_until, customer_id)
 
-```
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="tokens_controller"></a>![Class: ](https://apidocs.io/img/class.png ".TokensController") TokensController
-
-### Get singleton instance
+result = sellers_controller.get_sellers(page, size, name, document, code, status, type, created_since, created_until)
 
-The singleton instance of the ``` TokensController ``` class can be accessed from the API Client.
-
-```ruby
-tokens = client.tokens
 ```
 
-### <a name="get_token"></a>![Method: ](https://apidocs.io/img/method.png ".TokensController.get_token") get_token
 
-> *Tags:*  ``` Skips Authentication ``` 
+### <a name="update_seller"></a>![Method: ](https://apidocs.io/img/method.png ".SellersController.update_seller") update_seller
 
-> Gets a token from its id
+> TODO: Add a method description
 
 
 ```ruby
-def get_token(id,
-                  public_key); end
+def update_seller(id,
+                      request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| id |  ``` Required ```  | Token id |
-| public_key |  ``` Required ```  | Public key |
+| id |  ``` Required ```  | TODO: Add a parameter description |
+| request |  ``` Required ```  | Update Seller model |
 
 
 #### Example Usage
 
 ```ruby
 id = 'id'
-public_key = 'public_key'
+request = UpdateSellerRequest.new
 
-result = tokens.get_token(id, public_key)
+result = sellers_controller.update_seller(id, request)
 
 ```
 
 
-### <a name="create_token"></a>![Method: ](https://apidocs.io/img/method.png ".TokensController.create_token") create_token
-
-> *Tags:*  ``` Skips Authentication ``` 
+### <a name="update_seller_metadata"></a>![Method: ](https://apidocs.io/img/method.png ".SellersController.update_seller_metadata") update_seller_metadata
 
 > TODO: Add a method description
 
 
 ```ruby
-def create_token(public_key,
-                     request); end
+def update_seller_metadata(seller_id,
+                               request); end
 ```
 
 #### Parameters
 
 | Parameter | Tags | Description |
 |-----------|------|-------------|
-| public_key |  ``` Required ```  | Public key |
-| request |  ``` Required ```  | Request for creating a token |
+| seller_id |  ``` Required ```  | Seller Id |
+| request |  ``` Required ```  | Request for updating the charge metadata |
 
 
 #### Example Usage
 
 ```ruby
-public_key = 'public_key'
-request = CreateTokenRequest.new
+seller_id = 'seller_id'
+request = UpdateMetadataRequest.new
 
-result = tokens.create_token(public_key, request)
+result = sellers_controller.update_seller_metadata(seller_id, request)
 
 ```