Categorygithub.com/billabear/go-sdk
modulepackage
0.0.0-20250125132449-010b22da568b
Repository: https://github.com/billabear/go-sdk.git
Documentation: pkg.go.dev

# README

# Go API client for billabear

The REST API provided by BillaBear

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.1.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit http://www.billabear.com/support

Installation

Put the package under your project folder and add the following in import:

import "./billabear"

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
CheckoutApiCreateCheckoutPost /checkoutCreate Checkout
CustomersApiAddSeatsSubscriptionsPost /subscription/{subscriptionId}/seats/addAdd Seats
CustomersApiApplyVoucherToCustomerPost /customer/{customerId}/voucherApply voucher
CustomersApiCreateCustomerPost /customerCreate
CustomersApiCreateCustomerUsageLimitPost /customer/{customerId}/uasge-limitCreate Usage Limit
CustomersApiCustomerCustomerIdUasgeLimitLimitIdDeleteDelete /customer/{customerId}/uasge-limit/{limitId}Delete Usage Limit
CustomersApiDisableCustomerPost /customer/{customerId}/disableDisable Customer
CustomersApiEnableCustomerPost /customer/{customerId}/enableEnable Customer
CustomersApiGetActiveForCustomerGet /customer/{customerId}/subscription/activeList Customer Active Subscriptions
CustomersApiGetAllCustomersGet /customerList
CustomersApiGetCustomerByIdGet /customer/{customerId}Detail
CustomersApiGetCustomerCostsGet /customer/{customerId}/costsUsage Cost Estimate
CustomersApiGetCustomerLimitsByIdGet /customer/{customerId}/limitsFetch Customer Limits
CustomersApiGetCustomerUsageLimitsByIdGet /customer/{customerId}/uasge-limitFetch Customer Usage Limits
CustomersApiGetForCustomerGet /customer/{customerId}/subscriptionList Customer Subscriptions
CustomersApiGetInvoicesForCustomerGet /customer/{customerId}/invoicesList Customer Invoices
CustomersApiGetPaymentsForCustomerGet /customer/{customerId}/paymentList Customer Payments
CustomersApiGetRefundsForCustomerGet /customer/{customerId}/refundList Customer Refunds
CustomersApiListPaymentDetailsGet /customer/{customerId}/payment-methodsList Customer's Payment Details
CustomersApiRemoveSeatsSubscriptionsPost /subscription/{subscriptionId}/seats/removeRemove Seats
CustomersApiUpdateCustomerPut /customer/{customerId}Update
InvoicesApiChargeInvoicePost /invoice/{invoiceId}/chargeCharge Invoice
InvoicesApiDownloadInvoiceGet /invoice/{invoiceId}/downloadDownload Invoice
InvoicesApiGetInvoicesForCustomerGet /customer/{customerId}/invoicesList Customer Invoices
PaymentDetailsApiCompleteFrontendPaymentDetailsPost /customer/{customerId}/payment-methods/frontend-payment-tokenComplete Frontend Detail Collection
PaymentDetailsApiDeletePaymentDetailsDelete /payment-methods/{paymentDetailsId}Delete
PaymentDetailsApiDeletePaymentDetailsCustomerDelete /customer/{customerId}/payment-methods/{paymentDetailsId}Delete With Customer
PaymentDetailsApiGetPaymentDetailsGet /payment-methods/{paymentDetailsId}Fetch
PaymentDetailsApiListPaymentDetailsGet /customer/{customerId}/payment-methodsList Customer's Payment Details
PaymentDetailsApiMakeDefaultPaymentDetailsPost /payment-methods/{paymentDetailsId}/defaultMake Default
PaymentDetailsApiMakeDefaultPaymentDetailsCustomerPost /customer/{customerId}/payment-methods/{paymentDetailsId}/defaultMake Default With Customer
PaymentDetailsApiStartFrontendPaymentDetailsGet /customer/{customerId}/payment-methods/frontend-payment-tokenStart Frontend Detail Collection
PaymentsApiChargeInvoicePost /invoice/{invoiceId}/chargeCharge Invoice
PaymentsApiDownloadInvoiceGet /invoice/{invoiceId}/downloadDownload Invoice
PaymentsApiDownloadReceiptGet /receipt/{receiptId}/downloadDownload Receipt
PaymentsApiGetInvoicesForCustomerGet /customer/{customerId}/invoicesList Customer Invoices
PaymentsApiGetPaymentsForCustomerGet /customer/{customerId}/paymentList Customer Payments
PaymentsApiListPaymentGet /paymentList
PaymentsApiRefundPaymentPost /payment/{paymentId}/refundRefund Payment
PricesApiCreatePricePost /product/{productId}/priceCreate
PricesApiListPriceGet /product/{productId}/priceList
ProductsApiCreateProductPost /productCreate
ProductsApiListProductGet /productList
ProductsApiShowProductByIdGet /product/{productId}Detail
ProductsApiUpdateProductPut /product/{productId}Update
ReceiptApiDownloadReceiptGet /receipt/{receiptId}/downloadDownload Receipt
RefundsApiGetRefundsForCustomerGet /customer/{customerId}/refundList Customer Refunds
RefundsApiListRefundGet /refundList
RefundsApiShowRefundByIdGet /refund/{refundId}Detail
SubscriptionsApiAddSeatsSubscriptionsPost /subscription/{subscriptionId}/seats/addAdd Seats
SubscriptionsApiCancelSubscriptionPost /subscription/{subscriptionId}/cancelCancel Subscription
SubscriptionsApiChangeSubscriptionPricePost /subscription/{subscriptionId}/priceChange Price
SubscriptionsApiCreateSubscriptionPost /customer/{customerId}/subscription/startCreate Subscription
SubscriptionsApiCustomerChangeSubscriptionPlanPost /subscription/{subscriptionId}/planChange Subscription Plan
SubscriptionsApiExtendTrialPost /subscription/{subscriptionId}/extendExtend Trial Subscription
SubscriptionsApiGetActiveForCustomerGet /customer/{customerId}/subscription/activeList Customer Active Subscriptions
SubscriptionsApiGetForCustomerGet /customer/{customerId}/subscriptionList Customer Subscriptions
SubscriptionsApiListSubscriptionPlansGet /subscription/plansList Subscription Plans
SubscriptionsApiListSubscriptionsGet /subscriptionList
SubscriptionsApiRemoveSeatsSubscriptionsPost /subscription/{subscriptionId}/seats/removeRemove Seats
SubscriptionsApiShowSubscriptionByIdGet /subscription/{subscriptionId}Detail
SubscriptionsApiStartTrialPost /customer/{customerId}/subscription/trialStart Trial Subscription For Customer
UsageApiCreateCustomerUsageLimitPost /customer/{customerId}/uasge-limitCreate Usage Limit
UsageApiCreateEventPost /eventsCreate Event
UsageApiCustomerCustomerIdUasgeLimitLimitIdDeleteDelete /customer/{customerId}/uasge-limit/{limitId}Delete Usage Limit
UsageApiGetCustomerCostsGet /customer/{customerId}/costsUsage Cost Estimate
UsageApiGetCustomerUsageLimitsByIdGet /customer/{customerId}/uasge-limitFetch Customer Usage Limits

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

[email protected]

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

No description provided by the author
APIClient manages communication with the BillaBear API v1.1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author