The REST API provided by BillaBear
This Python package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit http://www.billabear.com/support
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/billabear/php-sdk.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/billabear/php-sdk.git
)
Then import the package:
import billabear
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import billabear
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import billabear
from billabear.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyAuth
configuration = billabear.Configuration()
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'
# create an instance of the API class
api_instance = billabear.CheckoutApi(billabear.ApiClient(configuration))
body = billabear.CheckoutBody() # CheckoutBody |
try:
# Create Checkout
api_response = api_instance.create_checkout(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CheckoutApi->create_checkout: %s\n" % e)
All URIs are relative to https://{customerId}.billabear.cloud/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
CheckoutApi | create_checkout | POST /checkout | Create Checkout |
CustomersApi | add_seats_subscriptions | POST /subscription/{subscriptionId}/seats/add | Add Seats |
CustomersApi | apply_voucher_to_customer | POST /customer/{customerId}/voucher | Apply voucher |
CustomersApi | create_customer | POST /customer | Create |
CustomersApi | create_customer_usage_limit | POST /customer/{customerId}/uasge-limit | Create Usage Limit |
CustomersApi | customer_customer_id_uasge_limit_limit_id_delete | DELETE /customer/{customerId}/uasge-limit/{limitId} | Delete Usage Limit |
CustomersApi | disable_customer | POST /customer/{customerId}/disable | Disable Customer |
CustomersApi | enable_customer | POST /customer/{customerId}/enable | Enable Customer |
CustomersApi | get_active_for_customer | GET /customer/{customerId}/subscription/active | List Customer Active Subscriptions |
CustomersApi | get_all_customers | GET /customer | List |
CustomersApi | get_customer_by_id | GET /customer/{customerId} | Detail |
CustomersApi | get_customer_costs | GET /customer/{customerId}/costs | Usage Cost Estimate |
CustomersApi | get_customer_limits_by_id | GET /customer/{customerId}/limits | Fetch Customer Limits |
CustomersApi | get_customer_usage_limits_by_id | GET /customer/{customerId}/uasge-limit | Fetch Customer Usage Limits |
CustomersApi | get_for_customer | GET /customer/{customerId}/subscription | List Customer Subscriptions |
CustomersApi | get_invoices_for_customer | GET /customer/{customerId}/invoices | List Customer Invoices |
CustomersApi | get_payments_for_customer | GET /customer/{customerId}/payment | List Customer Payments |
CustomersApi | get_refunds_for_customer | GET /customer/{customerId}/refund | List Customer Refunds |
CustomersApi | list_payment_details | GET /customer/{customerId}/payment-methods | List Customer's Payment Details |
CustomersApi | remove_seats_subscriptions | POST /subscription/{subscriptionId}/seats/remove | Remove Seats |
CustomersApi | update_customer | PUT /customer/{customerId} | Update |
InvoicesApi | charge_invoice | POST /invoice/{invoiceId}/charge | Charge Invoice |
InvoicesApi | download_invoice | GET /invoice/{invoiceId}/download | Download Invoice |
InvoicesApi | get_invoices_for_customer | GET /customer/{customerId}/invoices | List Customer Invoices |
PaymentDetailsApi | complete_frontend_payment_details | POST /customer/{customerId}/payment-methods/frontend-payment-token | Complete Frontend Detail Collection |
PaymentDetailsApi | delete_payment_details | DELETE /payment-methods/{paymentDetailsId} | Delete |
PaymentDetailsApi | delete_payment_details_customer | DELETE /customer/{customerId}/payment-methods/{paymentDetailsId} | Delete With Customer |
PaymentDetailsApi | get_payment_details | GET /payment-methods/{paymentDetailsId} | Fetch |
PaymentDetailsApi | list_payment_details | GET /customer/{customerId}/payment-methods | List Customer's Payment Details |
PaymentDetailsApi | make_default_payment_details | POST /payment-methods/{paymentDetailsId}/default | Make Default |
PaymentDetailsApi | make_default_payment_details_customer | POST /customer/{customerId}/payment-methods/{paymentDetailsId}/default | Make Default With Customer |
PaymentDetailsApi | start_frontend_payment_details | GET /customer/{customerId}/payment-methods/frontend-payment-token | Start Frontend Detail Collection |
PaymentsApi | charge_invoice | POST /invoice/{invoiceId}/charge | Charge Invoice |
PaymentsApi | download_invoice | GET /invoice/{invoiceId}/download | Download Invoice |
PaymentsApi | download_receipt | GET /receipt/{receiptId}/download | Download Receipt |
PaymentsApi | get_invoices_for_customer | GET /customer/{customerId}/invoices | List Customer Invoices |
PaymentsApi | get_payments_for_customer | GET /customer/{customerId}/payment | List Customer Payments |
PaymentsApi | list_payment | GET /payment | List |
PaymentsApi | refund_payment | POST /payment/{paymentId}/refund | Refund Payment |
PricesApi | create_price | POST /product/{productId}/price | Create |
PricesApi | list_price | GET /product/{productId}/price | List |
ProductsApi | create_product | POST /product | Create |
ProductsApi | list_product | GET /product | List |
ProductsApi | show_product_by_id | GET /product/{productId} | Detail |
ProductsApi | update_product | PUT /product/{productId} | Update |
ReceiptApi | download_receipt | GET /receipt/{receiptId}/download | Download Receipt |
RefundsApi | get_refunds_for_customer | GET /customer/{customerId}/refund | List Customer Refunds |
RefundsApi | list_refund | GET /refund | List |
RefundsApi | show_refund_by_id | GET /refund/{refundId} | Detail |
SubscriptionsApi | add_seats_subscriptions | POST /subscription/{subscriptionId}/seats/add | Add Seats |
SubscriptionsApi | cancel_subscription | POST /subscription/{subscriptionId}/cancel | Cancel Subscription |
SubscriptionsApi | change_subscription_price | POST /subscription/{subscriptionId}/price | Change Price |
SubscriptionsApi | create_subscription | POST /customer/{customerId}/subscription/start | Create Subscription |
SubscriptionsApi | customer_change_subscription_plan | POST /subscription/{subscriptionId}/plan | Change Subscription Plan |
SubscriptionsApi | extend_trial | POST /subscription/{subscriptionId}/extend | Extend Trial Subscription |
SubscriptionsApi | get_active_for_customer | GET /customer/{customerId}/subscription/active | List Customer Active Subscriptions |
SubscriptionsApi | get_for_customer | GET /customer/{customerId}/subscription | List Customer Subscriptions |
SubscriptionsApi | list_subscription_plans | GET /subscription/plans | List Subscription Plans |
SubscriptionsApi | list_subscriptions | GET /subscription | List |
SubscriptionsApi | remove_seats_subscriptions | POST /subscription/{subscriptionId}/seats/remove | Remove Seats |
SubscriptionsApi | show_subscription_by_id | GET /subscription/{subscriptionId} | Detail |
SubscriptionsApi | start_trial | POST /customer/{customerId}/subscription/trial | Start Trial Subscription For Customer |
UsageApi | create_customer_usage_limit | POST /customer/{customerId}/uasge-limit | Create Usage Limit |
UsageApi | create_event | POST /events | Create Event |
UsageApi | customer_customer_id_uasge_limit_limit_id_delete | DELETE /customer/{customerId}/uasge-limit/{limitId} | Delete Usage Limit |
UsageApi | get_customer_costs | GET /customer/{customerId}/costs | Usage Cost Estimate |
UsageApi | get_customer_usage_limits_by_id | GET /customer/{customerId}/uasge-limit | Fetch Customer Usage Limits |
- Address
- BillingAdmin
- CheckoutBody
- CheckoutItems
- CheckoutSubscriptions
- Cost
- Customer
- CustomerIdUasgelimitBody
- Error
- 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
- PaymentDetails
- Price
- Product
- ProductTaxType
- Refund
- SeatsAddBody
- SeatsRemoveBody
- Subscription
- SubscriptionIdCancelBody
- SubscriptionIdExtendBody
- SubscriptionIdPlanBody
- SubscriptionIdPriceBody
- SubscriptionPlan
- SubscriptionStartBody
- SubscriptionTrialBody
- UsageLimit
- VoucherCode
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header