modulepackage
0.0.0-20250125132449-010b22da568b
Repository: https://github.com/billabear/go-sdk.git
Documentation: pkg.go.dev
# README
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
Class | Method | HTTP request | Description |
---|---|---|---|
CheckoutApi | CreateCheckout | Post /checkout | Create Checkout |
CustomersApi | AddSeatsSubscriptions | Post /subscription/{subscriptionId}/seats/add | Add Seats |
CustomersApi | ApplyVoucherToCustomer | Post /customer/{customerId}/voucher | Apply voucher |
CustomersApi | CreateCustomer | Post /customer | Create |
CustomersApi | CreateCustomerUsageLimit | Post /customer/{customerId}/uasge-limit | Create Usage Limit |
CustomersApi | CustomerCustomerIdUasgeLimitLimitIdDelete | Delete /customer/{customerId}/uasge-limit/{limitId} | Delete Usage Limit |
CustomersApi | DisableCustomer | Post /customer/{customerId}/disable | Disable Customer |
CustomersApi | EnableCustomer | Post /customer/{customerId}/enable | Enable Customer |
CustomersApi | GetActiveForCustomer | Get /customer/{customerId}/subscription/active | List Customer Active Subscriptions |
CustomersApi | GetAllCustomers | Get /customer | List |
CustomersApi | GetCustomerById | Get /customer/{customerId} | Detail |
CustomersApi | GetCustomerCosts | Get /customer/{customerId}/costs | Usage Cost Estimate |
CustomersApi | GetCustomerLimitsById | Get /customer/{customerId}/limits | Fetch Customer Limits |
CustomersApi | GetCustomerUsageLimitsById | Get /customer/{customerId}/uasge-limit | Fetch Customer Usage Limits |
CustomersApi | GetForCustomer | Get /customer/{customerId}/subscription | List Customer Subscriptions |
CustomersApi | GetInvoicesForCustomer | Get /customer/{customerId}/invoices | List Customer Invoices |
CustomersApi | GetPaymentsForCustomer | Get /customer/{customerId}/payment | List Customer Payments |
CustomersApi | GetRefundsForCustomer | Get /customer/{customerId}/refund | List Customer Refunds |
CustomersApi | ListPaymentDetails | Get /customer/{customerId}/payment-methods | List Customer's Payment Details |
CustomersApi | RemoveSeatsSubscriptions | Post /subscription/{subscriptionId}/seats/remove | Remove Seats |
CustomersApi | UpdateCustomer | Put /customer/{customerId} | Update |
InvoicesApi | ChargeInvoice | Post /invoice/{invoiceId}/charge | Charge Invoice |
InvoicesApi | DownloadInvoice | Get /invoice/{invoiceId}/download | Download Invoice |
InvoicesApi | GetInvoicesForCustomer | Get /customer/{customerId}/invoices | List Customer Invoices |
PaymentDetailsApi | CompleteFrontendPaymentDetails | Post /customer/{customerId}/payment-methods/frontend-payment-token | Complete Frontend Detail Collection |
PaymentDetailsApi | DeletePaymentDetails | Delete /payment-methods/{paymentDetailsId} | Delete |
PaymentDetailsApi | DeletePaymentDetailsCustomer | Delete /customer/{customerId}/payment-methods/{paymentDetailsId} | Delete With Customer |
PaymentDetailsApi | GetPaymentDetails | Get /payment-methods/{paymentDetailsId} | Fetch |
PaymentDetailsApi | ListPaymentDetails | Get /customer/{customerId}/payment-methods | List Customer's Payment Details |
PaymentDetailsApi | MakeDefaultPaymentDetails | Post /payment-methods/{paymentDetailsId}/default | Make Default |
PaymentDetailsApi | MakeDefaultPaymentDetailsCustomer | Post /customer/{customerId}/payment-methods/{paymentDetailsId}/default | Make Default With Customer |
PaymentDetailsApi | StartFrontendPaymentDetails | Get /customer/{customerId}/payment-methods/frontend-payment-token | Start Frontend Detail Collection |
PaymentsApi | ChargeInvoice | Post /invoice/{invoiceId}/charge | Charge Invoice |
PaymentsApi | DownloadInvoice | Get /invoice/{invoiceId}/download | Download Invoice |
PaymentsApi | DownloadReceipt | Get /receipt/{receiptId}/download | Download Receipt |
PaymentsApi | GetInvoicesForCustomer | Get /customer/{customerId}/invoices | List Customer Invoices |
PaymentsApi | GetPaymentsForCustomer | Get /customer/{customerId}/payment | List Customer Payments |
PaymentsApi | ListPayment | Get /payment | List |
PaymentsApi | RefundPayment | Post /payment/{paymentId}/refund | Refund Payment |
PricesApi | CreatePrice | Post /product/{productId}/price | Create |
PricesApi | ListPrice | Get /product/{productId}/price | List |
ProductsApi | CreateProduct | Post /product | Create |
ProductsApi | ListProduct | Get /product | List |
ProductsApi | ShowProductById | Get /product/{productId} | Detail |
ProductsApi | UpdateProduct | Put /product/{productId} | Update |
ReceiptApi | DownloadReceipt | Get /receipt/{receiptId}/download | Download Receipt |
RefundsApi | GetRefundsForCustomer | Get /customer/{customerId}/refund | List Customer Refunds |
RefundsApi | ListRefund | Get /refund | List |
RefundsApi | ShowRefundById | Get /refund/{refundId} | Detail |
SubscriptionsApi | AddSeatsSubscriptions | Post /subscription/{subscriptionId}/seats/add | Add Seats |
SubscriptionsApi | CancelSubscription | Post /subscription/{subscriptionId}/cancel | Cancel Subscription |
SubscriptionsApi | ChangeSubscriptionPrice | Post /subscription/{subscriptionId}/price | Change Price |
SubscriptionsApi | CreateSubscription | Post /customer/{customerId}/subscription/start | Create Subscription |
SubscriptionsApi | CustomerChangeSubscriptionPlan | Post /subscription/{subscriptionId}/plan | Change Subscription Plan |
SubscriptionsApi | ExtendTrial | Post /subscription/{subscriptionId}/extend | Extend Trial Subscription |
SubscriptionsApi | GetActiveForCustomer | Get /customer/{customerId}/subscription/active | List Customer Active Subscriptions |
SubscriptionsApi | GetForCustomer | Get /customer/{customerId}/subscription | List Customer Subscriptions |
SubscriptionsApi | ListSubscriptionPlans | Get /subscription/plans | List Subscription Plans |
SubscriptionsApi | ListSubscriptions | Get /subscription | List |
SubscriptionsApi | RemoveSeatsSubscriptions | Post /subscription/{subscriptionId}/seats/remove | Remove Seats |
SubscriptionsApi | ShowSubscriptionById | Get /subscription/{subscriptionId} | Detail |
SubscriptionsApi | StartTrial | Post /customer/{customerId}/subscription/trial | Start Trial Subscription For Customer |
UsageApi | CreateCustomerUsageLimit | Post /customer/{customerId}/uasge-limit | Create Usage Limit |
UsageApi | CreateEvent | Post /events | Create Event |
UsageApi | CustomerCustomerIdUasgeLimitLimitIdDelete | Delete /customer/{customerId}/uasge-limit/{limitId} | Delete Usage Limit |
UsageApi | GetCustomerCosts | Get /customer/{customerId}/costs | Usage Cost Estimate |
UsageApi | GetCustomerUsageLimitsById | Get /customer/{customerId}/uasge-limit | Fetch Customer Usage Limits |
Documentation For Models
- Address
- BillingAdmin
- CheckoutBody
- CheckoutItems
- CheckoutSubscriptions
- Cost
- Customer
- CustomerIdUasgelimitBody
- Event
- Feature
- FrontendToken
- InlineResponse200
- InlineResponse2001
- InlineResponse20010
- InlineResponse20011
- InlineResponse20012
- InlineResponse20013
- InlineResponse20014
- InlineResponse2002
- InlineResponse2003
- InlineResponse2004
- InlineResponse2005
- InlineResponse2006
- InlineResponse2007
- InlineResponse2008
- InlineResponse2009
- InlineResponse2009Data
- InlineResponse2009Receipts
- InlineResponse201
- InlineResponse201Lines
- InlineResponse400
- Invoice
- InvoiceLines
- IssueRefundPayment
- Limit
- Metric
- MetricCost
- MetricFilter
- ModelError
- PaymentDetails
- Price
- Product
- ProductTaxType
- Refund
- SeatsAddBody
- SeatsRemoveBody
- Subscription
- SubscriptionIdCancelBody
- SubscriptionIdExtendBody
- SubscriptionIdPlanBody
- SubscriptionIdPriceBody
- SubscriptionPlan
- SubscriptionStartBody
- SubscriptionTrialBody
- UsageLimit
- VoucherCode
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
# 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