Skip to content

Latest commit

 

History

History
154 lines (96 loc) · 5.02 KB

UsageApi.md

File metadata and controls

154 lines (96 loc) · 5.02 KB

{{classname}}

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

Method HTTP request Description
CreateCustomerUsageLimit Post /customer/{customerId}/uasge-limit Create Usage Limit
CreateEvent Post /events Create Event
CustomerCustomerIdUasgeLimitLimitIdDelete Delete /customer/{customerId}/uasge-limit/{limitId} Delete Usage Limit
GetCustomerCosts Get /customer/{customerId}/costs Usage Cost Estimate
GetCustomerUsageLimitsById Get /customer/{customerId}/uasge-limit Fetch Customer Usage Limits

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]

CreateEvent

CreateEvent(ctx, body) Create Event

Creates an event that is used for usage billing

Required Parameters

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

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]

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]

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]

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]