Skip to content

Latest commit

 

History

History
executable file
·
34 lines (20 loc) · 844 Bytes

README.md

File metadata and controls

executable file
·
34 lines (20 loc) · 844 Bytes

availability

Overview

The Availability resource represents a customer's availability. Availability is created when a customer's invoice is paid, and is updated when a customer's transaction is refunded.

Available Operations

  • ping - Check availability

ping

This endpoint allows you to test your connection to the Orb API and check the validity of your API key, passed in the Authorization header. This is particularly useful for checking that your environment is set up properly, and is a great choice for connectors and integrations.

This API does not have any side-effects or return any Orb resources.

Example Usage

import orb


s = orb.Orb(
    security=shared.Security(
        api_key_auth="",
    ),
)


res = s.availability.ping()

if res.availability is not None:
    # handle response