enbbox 1.0.1

Notification infrastructure API — open-source alternative to Novu/Courier
Documentation
# \BillingApi

All URIs are relative to *https://api.enbbox.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_checkout_session**]BillingApi.md#create_checkout_session | **POST** /v1/billing/checkout-session/ | Create a Stripe Checkout Session for upgrading a plan.
[**get_billing_limits**]BillingApi.md#get_billing_limits | **GET** /v1/billing/limits/ | Get plan limits and current usage for the project.
[**get_billing_subscription**]BillingApi.md#get_billing_subscription | **GET** /v1/billing/subscription/ | Get the current subscription for the authed project.
[**get_entitlements**]BillingApi.md#get_entitlements | **GET** /v1/billing/entitlements/ | Get active entitlements for the project.
[**get_portal_url**]BillingApi.md#get_portal_url | **GET** /v1/billing/portal/ | Get a Stripe Customer Portal URL for managing the subscription.
[**get_prices**]BillingApi.md#get_prices | **GET** /v1/billing/prices/ | Get available plan prices.
[**get_usage**]BillingApi.md#get_usage | **GET** /v1/billing/usage/ | Get current usage data for the project.
[**stripe_webhook**]BillingApi.md#stripe_webhook | **POST** /v1/billing/webhooks/stripe/ | Handle Stripe webhook events.



## create_checkout_session

> models::CheckoutSession create_checkout_session(create_checkout)
Create a Stripe Checkout Session for upgrading a plan.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_checkout** | [**CreateCheckout**]CreateCheckout.md |  | [required] |

### Return type

[**models::CheckoutSession**](CheckoutSession.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_billing_limits

> models::PlanLimits get_billing_limits()
Get plan limits and current usage for the project.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::PlanLimits**](PlanLimits.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_billing_subscription

> models::Subscription get_billing_subscription()
Get the current subscription for the authed project.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::Subscription**](Subscription.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_entitlements

> models::Entitlements get_entitlements()
Get active entitlements for the project.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::Entitlements**](Entitlements.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_portal_url

> models::PortalUrl get_portal_url()
Get a Stripe Customer Portal URL for managing the subscription.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::PortalUrl**](PortalUrl.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_prices

> models::Prices get_prices()
Get available plan prices.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::Prices**](Prices.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_usage

> models::Usage get_usage()
Get current usage data for the project.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::Usage**](Usage.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## stripe_webhook

> stripe_webhook(body)
Handle Stripe webhook events.

This endpoint is NOT authenticated via JWT — it's verified via Stripe webhook signature (HMAC-SHA256). Stripe expects a 2xx with an empty body.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: text/plain
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)