credoxa-billing-sdk

Public HTTP contract for Credoxa Billing.

Billing owns commercial truth for subscriptions, usage, invoices, payments, refunds, and derived entitlement access.

Tenant and caller identity are established by the trusted Credoxa Gateway boundary. Clients must not treat tenant identity in request bodies as authority.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import credoxa_billing

Setuptools

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 credoxa_billing

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import credoxa_billing
from credoxa_billing.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = credoxa_billing.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: CredoxaGatewayIdentity
configuration.api_key['CredoxaGatewayIdentity'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CredoxaGatewayIdentity'] = 'Bearer'


# Enter a context with an instance of the API client
with credoxa_billing.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = credoxa_billing.CatalogApi(api_client)

    try:
        api_response = api_instance.list_plans()
        print("The response of CatalogApi->list_plans:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CatalogApi->list_plans: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• Entitlement
• IdempotencyReplay
• Invoice
• InvoiceLine
• Money
• PaginatedInvoices
• PaginatedPlans
• PaginatedPrices
• PaginatedProducts
• PaginatedSubscriptions
• Payment
• PaymentCreateRequest
• Plan
• Price
• Product
• ProviderEventReceipt
• Refund
• RefundCreateRequest
• Subscription
• SubscriptionAccess
• SubscriptionCreateRequest
• SubscriptionEntitlements
• UsageEvent
• UsageEventCreateRequest

Documentation For Authorization

Authentication schemes defined for the API:

CredoxaGatewayIdentity

• Type: API key
• API key parameter name: X-Credoxa-Subject
• Location: HTTP header

Author