Skip to content

Latest commit

 

History

History
147 lines (129 loc) · 10.6 KB

README.md

File metadata and controls

147 lines (129 loc) · 10.6 KB
Raw

BillaBear PHP SDK

Installation & Usage

composer require billabear/php-sdk

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()
        ->setHost('YOUR_API_URL')
        ->setApiKey('X-API-Key', 'YOUR_API_KEY');


$apiInstance = new BillaBear\Api\CheckoutApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \BillaBear\Model\CheckoutBody();

try {
    $result = $apiInstance->createCheckout($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckoutApi->createCheckout: ', $e->getMessage(), PHP_EOL;
}
?>

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 disableCustomer POST /customer/{customerId}/disable Disable Customer
CustomersApi enableCustomer POST /customer/{customerId}/enable Enable Customer
CustomersApi fetchCustomerById GET /customer/{customerId} Detail
CustomersApi listCustomerInvoices GET /customer/{customerId}/invoices List Customer Invoices
CustomersApi listCustomerPayment GET /customer/{customerId}/payment List Customer Payments
CustomersApi listCustomerRefund GET /customer/{customerId}/refund List Customer Refunds
CustomersApi listCustomers GET /customer List
CustomersApi listCustomnerSubscriptions GET /customer/{customerId}/subscription List Customer Subscriptions
CustomersApi listPaymentDetails GET /customer/{customerId}/payment-methods List Customer's Payment Details
CustomersApi removeSeatsSubscriptions POST /subscription/{subscriptionId}/seats/remove Remove Seats
CustomersApi showCustomerLimitsById GET /customer/{customerId}/limits Fetch Customer Limits
CustomersApi updateCustomer PUT /customer/{customerId} Update
InvoicesApi chargeInvoice POST /invoice/{invoiceId}/charge Charge Invoice
InvoicesApi downloadInvoice POST /invoice/{invoiceId}/download Download Invoice
InvoicesApi listCustomerInvoices GET /customer/{customerId}/invoices List Customer Invoices
PaymentDetailsApi completeFrontendPaymentDetails POST /customer/{customerId}/payment-methods/frontend-payment-token Complete Frontend Detail Collection
PaymentDetailsApi deletePaymentDetails DELETE /customer/{customerId}/payment-methods/{paymentDetailsId} Delete
PaymentDetailsApi listPaymentDetails GET /customer/{customerId}/payment-methods List Customer's Payment Details
PaymentDetailsApi makeDefaultPaymentDetails POST /customer/{customerId}/payment-methods/{paymentDetailsId}/default Make Default
PaymentDetailsApi startFrontendPaymentDetails GET /customer/{customerId}/payment-methods/frontend-payment-token Start Frontend Detail Collection
PaymentsApi chargeInvoice POST /invoice/{invoiceId}/charge Charge Invoice
PaymentsApi downloadInvoice POST /invoice/{invoiceId}/download Download Invoice
PaymentsApi downloadReceipt POST /receipt/{receiptId}/download Download Receipt
PaymentsApi listCustomerInvoices GET /customer/{customerId}/invoices List Customer Invoices
PaymentsApi listCustomerPayment 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 POST /receipt/{receiptId}/download Download Receipt
RefundsApi listCustomerRefund 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 customerChangeSubscriptionPlan POST /subscription/{subscriptionId}/plan Change Subscription Plan
SubscriptionsApi customerStartSubscription POST /customer/{customerId}/subscription/start Start Subscription For Customer
SubscriptionsApi listCustomnerSubscriptions GET /customer/{customerId}/subscription List Customer Subscriptions
SubscriptionsApi listSubscriptions GET /subscription List
SubscriptionsApi removeSeatsSubscriptions POST /subscription/{subscriptionId}/seats/remove Remove Seats
SubscriptionsApi showSubscriptionById GET /subscription/{subscriptionId} Detail

Documentation For Models

Author

support@billabear.com