Skip to content

Latest commit

 

History

History
625 lines (397 loc) · 21.2 KB

CustomersApi.md

File metadata and controls

625 lines (397 loc) · 21.2 KB

{{classname}}

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(ctx, body, subscriptionId) Add Seats

Adds seats to a per seat subscription

Since 1.1.4

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApplyVoucherToCustomer

ApplyVoucherToCustomer(ctx, body, customerId) Apply voucher

Apply Voucher to Customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body VoucherCode
customerId string The id of the customer to retrieve

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateCustomer

Customer CreateCustomer(ctx, body) Create

Create a customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Customer

Return type

Customer

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateCustomerUsageLimit

UsageLimit CreateCustomerUsageLimit(ctx, body, customerId) Create Usage Limit

Create Usage Limit for the custoemr

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomerCustomerIdUasgeLimitLimitIdDelete

CustomerCustomerIdUasgeLimitLimitIdDelete(ctx, customerId, usageLimitId) Delete Usage Limit

Delete Usage Limit for the custoemr

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve
usageLimitId string The id of the usage limit

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DisableCustomer

DisableCustomer(ctx, customerId) Disable Customer

Disable customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnableCustomer

EnableCustomer(ctx, customerId) Enable Customer

Enable a customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetActiveForCustomer

InlineResponse2008 GetActiveForCustomer(ctx, customerId) List Customer Active Subscriptions

List all Active customer subscriptions

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2008

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllCustomers

InlineResponse200 GetAllCustomers(ctx, optional) List

List all customers

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CustomersApiGetAllCustomersOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CustomersApiGetAllCustomersOpts struct

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

Return type

InlineResponse200

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCustomerById

Customer GetCustomerById(ctx, customerId) Detail

Info for a specific customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

Customer

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCustomerCosts

InlineResponse2001 GetCustomerCosts(ctx, customerId) Usage Cost Estimate

The estimated costs from usage based billing for a customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2001

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCustomerLimitsById

InlineResponse2002 GetCustomerLimitsById(ctx, customerId) Fetch Customer Limits

Limits for a specific customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2002

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCustomerUsageLimitsById

InlineResponse2005 GetCustomerUsageLimitsById(ctx, customerId) Fetch Customer Usage Limits

Usage Limits for a specific customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2005

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetForCustomer

InlineResponse2008 GetForCustomer(ctx, customerId) List Customer Subscriptions

List all customer subscriptions

Since 1.1

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2008

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInvoicesForCustomer

InlineResponse2006 GetInvoicesForCustomer(ctx, customerId) List Customer Invoices

List Customer Invoices

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2006

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPaymentsForCustomer

InlineResponse2004 GetPaymentsForCustomer(ctx, customerId, optional) List Customer Payments

List Customer Payment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve
optional *CustomersApiGetPaymentsForCustomerOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CustomersApiGetPaymentsForCustomerOpts struct

Name Type Description Notes

limit | optional.Int32| How many items to return at one time (max 100) | lastKey | optional.String| The key to be used in pagination to say what the last key of the previous page was | name | optional.String| The name to search for |

Return type

InlineResponse2004

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRefundsForCustomer

InlineResponse2003 GetRefundsForCustomer(ctx, customerId, optional) List Customer Refunds

List Customer Refund

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve
optional *CustomersApiGetRefundsForCustomerOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CustomersApiGetRefundsForCustomerOpts struct

Name Type Description Notes

limit | optional.Int32| How many items to return at one time (max 100) | lastKey | optional.String| The key to be used in pagination to say what the last key of the previous page was | name | optional.String| The name to search for |

Return type

InlineResponse2003

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListPaymentDetails

InlineResponse2007 ListPaymentDetails(ctx, customerId) List Customer's Payment Details

List all customers

Added in version 1.1

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2007

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveSeatsSubscriptions

InlineResponse20013 RemoveSeatsSubscriptions(ctx, body, subscriptionId) Remove Seats

Remove seats to a per seat subscription

Since 1.1.4

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCustomer

Customer UpdateCustomer(ctx, body, customerId) Update

Update a customer

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]