Skip to content

Latest commit

 

History

History
1159 lines (856 loc) · 36.7 KB

CustomersApi.md

File metadata and controls

1159 lines (856 loc) · 36.7 KB

CustomersApi

All URIs are relative to https://{customerId}.billabear.cloud/api/v1

Method HTTP request Description
addSeatsSubscriptions POST /subscription/{subscriptionId}/seats/add Add Seats
applyVoucherToCustomer POST /customer/{customerId}/voucher Apply voucher
createCustomer POST /customer Create
createCustomerUsageLimit POST /customer/{customerId}/uasge-limit Create Usage Limit
customerCustomerIdUasgeLimitLimitIdDelete DELETE /customer/{customerId}/uasge-limit/{limitId} Delete Usage Limit
disableCustomer POST /customer/{customerId}/disable Disable Customer
enableCustomer POST /customer/{customerId}/enable Enable Customer
getActiveForCustomer GET /customer/{customerId}/subscription/active List Customer Active Subscriptions
getAllCustomers GET /customer List
getCustomerById GET /customer/{customerId} Detail
getCustomerCosts GET /customer/{customerId}/costs Usage Cost Estimate
getCustomerLimitsById GET /customer/{customerId}/limits Fetch Customer Limits
getCustomerUsageLimitsById GET /customer/{customerId}/uasge-limit Fetch Customer Usage Limits
getForCustomer GET /customer/{customerId}/subscription List Customer Subscriptions
getInvoicesForCustomer GET /customer/{customerId}/invoices List Customer Invoices
getPaymentsForCustomer GET /customer/{customerId}/payment List Customer Payments
getRefundsForCustomer GET /customer/{customerId}/refund List Customer Refunds
listPaymentDetails GET /customer/{customerId}/payment-methods List Customer's Payment Details
removeSeatsSubscriptions POST /subscription/{subscriptionId}/seats/remove Remove Seats
updateCustomer PUT /customer/{customerId} Update

addSeatsSubscriptions

InlineResponse20013 addSeatsSubscriptions(body, subscriptionId)

Add Seats

Adds seats to a per seat subscription<br><br><strong>Since 1.1.4</strong>

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
SeatsAddBody body = new SeatsAddBody(); // SeatsAddBody | 
String subscriptionId = "subscriptionId_example"; // String | The id of the subscription to retrieve
try {
    InlineResponse20013 result = apiInstance.addSeatsSubscriptions(body, subscriptionId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#addSeatsSubscriptions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body SeatsAddBody
subscriptionId String The id of the subscription to retrieve

Return type

InlineResponse20013

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

applyVoucherToCustomer

applyVoucherToCustomer(body, customerId)

Apply voucher

Apply Voucher to Customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
VoucherCode body = new VoucherCode(); // VoucherCode | 
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    apiInstance.applyVoucherToCustomer(body, customerId);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#applyVoucherToCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body VoucherCode
customerId String The id of the customer to retrieve

Return type

null (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createCustomer

Customer createCustomer(body)

Create

Create a customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
Customer body = new Customer(); // Customer | 
try {
    Customer result = apiInstance.createCustomer(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#createCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Customer

Return type

Customer

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createCustomerUsageLimit

UsageLimit createCustomerUsageLimit(body, customerId)

Create Usage Limit

Create Usage Limit for the custoemr

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
CustomerIdUasgelimitBody body = new CustomerIdUasgelimitBody(); // CustomerIdUasgelimitBody | 
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    UsageLimit result = apiInstance.createCustomerUsageLimit(body, customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#createCustomerUsageLimit");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body CustomerIdUasgelimitBody
customerId String The id of the customer to retrieve

Return type

UsageLimit

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

customerCustomerIdUasgeLimitLimitIdDelete

customerCustomerIdUasgeLimitLimitIdDelete(customerId, usageLimitId)

Delete Usage Limit

Delete Usage Limit for the custoemr

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
String usageLimitId = "usageLimitId_example"; // String | The id of the usage limit
try {
    apiInstance.customerCustomerIdUasgeLimitLimitIdDelete(customerId, usageLimitId);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#customerCustomerIdUasgeLimitLimitIdDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve
usageLimitId String The id of the usage limit

Return type

null (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

disableCustomer

disableCustomer(customerId)

Disable Customer

Disable customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    apiInstance.disableCustomer(customerId);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#disableCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

null (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

enableCustomer

enableCustomer(customerId)

Enable Customer

Enable a customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    apiInstance.enableCustomer(customerId);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#enableCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

null (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getActiveForCustomer

InlineResponse2008 getActiveForCustomer(customerId)

List Customer Active Subscriptions

List all Active customer subscriptions

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    InlineResponse2008 result = apiInstance.getActiveForCustomer(customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getActiveForCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

InlineResponse2008

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAllCustomers

InlineResponse200 getAllCustomers(limit, lastKey, email, country, reference, externalReference, companyName)

List

List all customers

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
Integer limit = 56; // Integer | How many items to return at one time (max 100)
String lastKey = "lastKey_example"; // String | The key to be used in pagination to say what the last key of the previous page was
String email = "email_example"; // String | The email to search for
String country = "country_example"; // String | The country code to search for
String reference = "reference_example"; // String | The reference to search for
String externalReference = "externalReference_example"; // String | The external reference to search for
String companyName = "companyName_example"; // String | The company name to search for
try {
    InlineResponse200 result = apiInstance.getAllCustomers(limit, lastKey, email, country, reference, externalReference, companyName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getAllCustomers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
limit Integer How many items to return at one time (max 100) [optional]
lastKey String The key to be used in pagination to say what the last key of the previous page was [optional]
email String The email to search for [optional]
country String The country code to search for [optional]
reference String The reference to search for [optional]
externalReference String The external reference to search for [optional]
companyName String The company name to search for [optional]

Return type

InlineResponse200

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getCustomerById

Customer getCustomerById(customerId)

Detail

Info for a specific customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    Customer result = apiInstance.getCustomerById(customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getCustomerById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

Customer

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getCustomerCosts

InlineResponse2001 getCustomerCosts(customerId)

Usage Cost Estimate

The estimated costs from usage based billing for a customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    InlineResponse2001 result = apiInstance.getCustomerCosts(customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getCustomerCosts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

InlineResponse2001

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getCustomerLimitsById

InlineResponse2002 getCustomerLimitsById(customerId)

Fetch Customer Limits

Limits for a specific customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    InlineResponse2002 result = apiInstance.getCustomerLimitsById(customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getCustomerLimitsById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

InlineResponse2002

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getCustomerUsageLimitsById

InlineResponse2005 getCustomerUsageLimitsById(customerId)

Fetch Customer Usage Limits

Usage Limits for a specific customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    InlineResponse2005 result = apiInstance.getCustomerUsageLimitsById(customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getCustomerUsageLimitsById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

InlineResponse2005

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getForCustomer

InlineResponse2008 getForCustomer(customerId)

List Customer Subscriptions

List all customer subscriptions<br><br><strong>Since 1.1</strong>

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    InlineResponse2008 result = apiInstance.getForCustomer(customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getForCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

InlineResponse2008

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getInvoicesForCustomer

InlineResponse2006 getInvoicesForCustomer(customerId)

List Customer Invoices

List Customer Invoices

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    InlineResponse2006 result = apiInstance.getInvoicesForCustomer(customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getInvoicesForCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

InlineResponse2006

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getPaymentsForCustomer

InlineResponse2004 getPaymentsForCustomer(customerId, limit, lastKey, name)

List Customer Payments

List Customer Payment

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
Integer limit = 56; // Integer | How many items to return at one time (max 100)
String lastKey = "lastKey_example"; // String | The key to be used in pagination to say what the last key of the previous page was
String name = "name_example"; // String | The name to search for
try {
    InlineResponse2004 result = apiInstance.getPaymentsForCustomer(customerId, limit, lastKey, name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getPaymentsForCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve
limit Integer How many items to return at one time (max 100) [optional]
lastKey String The key to be used in pagination to say what the last key of the previous page was [optional]
name String The name to search for [optional]

Return type

InlineResponse2004

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getRefundsForCustomer

InlineResponse2003 getRefundsForCustomer(customerId, limit, lastKey, name)

List Customer Refunds

List Customer Refund

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
Integer limit = 56; // Integer | How many items to return at one time (max 100)
String lastKey = "lastKey_example"; // String | The key to be used in pagination to say what the last key of the previous page was
String name = "name_example"; // String | The name to search for
try {
    InlineResponse2003 result = apiInstance.getRefundsForCustomer(customerId, limit, lastKey, name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getRefundsForCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve
limit Integer How many items to return at one time (max 100) [optional]
lastKey String The key to be used in pagination to say what the last key of the previous page was [optional]
name String The name to search for [optional]

Return type

InlineResponse2003

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listPaymentDetails

InlineResponse2007 listPaymentDetails(customerId)

List Customer's Payment Details

List all customers <br><br>Added in version 1.1

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    InlineResponse2007 result = apiInstance.listPaymentDetails(customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#listPaymentDetails");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customerId String The id of the customer to retrieve

Return type

InlineResponse2007

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

removeSeatsSubscriptions

InlineResponse20013 removeSeatsSubscriptions(body, subscriptionId)

Remove Seats

Remove seats to a per seat subscription<br><br><strong>Since 1.1.4</strong>

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
SeatsRemoveBody body = new SeatsRemoveBody(); // SeatsRemoveBody | 
String subscriptionId = "subscriptionId_example"; // String | The id of the subscription to retrieve
try {
    InlineResponse20013 result = apiInstance.removeSeatsSubscriptions(body, subscriptionId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#removeSeatsSubscriptions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body SeatsRemoveBody
subscriptionId String The id of the subscription to retrieve

Return type

InlineResponse20013

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateCustomer

Customer updateCustomer(body, customerId)

Update

Update a customer

Example

// Import classes:
//import com.billabear.sdk.invoker.ApiClient;
//import com.billabear.sdk.invoker.ApiException;
//import com.billabear.sdk.invoker.Configuration;
//import com.billabear.sdk.invoker.auth.*;
//import com.billabear.sdk.api.CustomersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CustomersApi apiInstance = new CustomersApi();
Customer body = new Customer(); // Customer | 
String customerId = "customerId_example"; // String | The id of the customer to retrieve
try {
    Customer result = apiInstance.updateCustomer(body, customerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#updateCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Customer
customerId String The id of the customer to retrieve

Return type

Customer

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json