Skip to content

BillingApi.md

Latest commit

 

History

History
104 lines (72 loc) · 3.53 KB

BillingApi.md

File metadata and controls

104 lines (72 loc) · 3.53 KB
Raw

ksapi.BillingApi

All URIs are relative to http://localhost:8000

Method HTTP request Description
list_billing_payments GET /v1/tenants/{tenant_id}/billing/payments List Billing Payments Handler

list_billing_payments

PaginatedResponseBillingPaymentResponse list_billing_payments(tenant_id, limit=limit, offset=offset)

List Billing Payments Handler

Newest-first payment history for the tenant (OWNER/ADMIN only).

Backs the billing page's receipts list. invoice_url links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.

Example

  • Api Key Authentication (cookieAuth):
  • Bearer Authentication (bearerAuth):
import ksapi
from ksapi.models.paginated_response_billing_payment_response import PaginatedResponseBillingPaymentResponse
from ksapi.rest import ApiException
from pprint import pprint

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

# 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: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = ksapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.BillingApi(api_client)
    tenant_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    limit = 20 # int | Number of items per page (optional) (default to 20)
    offset = 0 # int | Number of items to skip (optional) (default to 0)

    try:
        # List Billing Payments Handler
        api_response = api_instance.list_billing_payments(tenant_id, limit=limit, offset=offset)
        print("The response of BillingApi->list_billing_payments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BillingApi->list_billing_payments: %s\n" % e)

Parameters

Name Type Description Notes
tenant_id UUID
limit int Number of items per page [optional] [default to 20]
offset int Number of items to skip [optional] [default to 0]

Return type

PaginatedResponseBillingPaymentResponse

Authorization

cookieAuth, bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -
0 Error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]