Spaire SDK for Python

These details have not been verified by PyPI

Project links

Repository

Project description

spaire-sdk

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add spaire-sdk

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install spaire-sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add spaire-sdk

Shell and script usage with `uv`

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from spaire-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "spaire-sdk",
# ]
# ///

from spaire_sdk import Spaire

sdk = Spaire(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from spaire_sdk import Spaire


with Spaire(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as spaire:

    res = spaire.organizations.list(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from spaire_sdk import Spaire

async def main():

    async with Spaire(
        access_token="<YOUR_BEARER_TOKEN_HERE>",
    ) as spaire:

        res = await spaire.organizations.list_async(page=1, limit=10)

        while res is not None:
            # Handle items

            res = res.next()

asyncio.run(main())

Webhook support

The SDK has built-in support to validate webhook events. Here is an example with Flask:

from flask import Flask, request
from spaire_sdk.webhooks import validate_event, WebhookVerificationError

app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def webhook():
    try:
        event = validate_event(
            payload=request.data,
            headers=request.headers,
            secret='<YOUR_WEBHOOK_SECRET>',
        )

        # Process the event

        return "", 202
    except WebhookVerificationError as e:
        return "", 403

Available Resources and Operations

Available methods

benefits

list - List Benefits
create - Create Benefit
get - Get Benefit
update - Update Benefit
delete - Delete Benefit
grants - List Benefit Grants

checkout_links

list - List Checkout Links
create - Create Checkout Link
get - Get Checkout Link
update - Update Checkout Link
delete - Delete Checkout Link

checkouts

list - List Checkout Sessions
create - Create Checkout Session
get - Get Checkout Session
update - Update Checkout Session
client_get - Get Checkout Session from Client
client_update - Update Checkout Session from Client
client_confirm - Confirm Checkout Session from Client

custom_fields

list - List Custom Fields
create - Create Custom Field
get - Get Custom Field
update - Update Custom Field
delete - Delete Custom Field

customer_meters

list - List Customer Meters
get - Get Customer Meter

customer_portal.benefit_grants

list - List Benefit Grants
get - Get Benefit Grant
update - Update Benefit Grant

customer_portal.customer_meters

list - List Meters
get - Get Customer Meter

customer_portal.customer_session

introspect - Introspect Customer Session
get_authenticated_user - Get Authenticated Portal User

customer_portal.customers

get - Get Customer
update - Update Customer
list_payment_methods - List Customer Payment Methods
add_payment_method - Add Customer Payment Method
confirm_payment_method - Confirm Customer Payment Method
delete_payment_method - Delete Customer Payment Method

customer_portal.license_keys

list - List License Keys
get - Get License Key
validate - Validate License Key
activate - Activate License Key
deactivate - Deactivate License Key

customer_portal.orders

list - List Orders
get - Get Order
update - Update Order
generate_invoice - Generate Order Invoice
invoice - Get Order Invoice
get_payment_status - Get Order Payment Status
confirm_retry_payment - Confirm Retry Payment

customer_portal.seats

list_seats - List Seats
assign_seat - Assign Seat
revoke_seat - Revoke Seat
resend_invitation - Resend Invitation
list_claimed_subscriptions - List Claimed Subscriptions

customer_portal.subscriptions

list - List Subscriptions
get - Get Subscription
update - Update Subscription
cancel - Cancel Subscription

customer_seats

assign_seat - Assign Seat
list_seats - List Seats
revoke_seat - Revoke Seat
resend_invitation - Resend Invitation
get_claim_info - Get Claim Info
claim_seat - Claim Seat

customers

list - List Customers
create - Create Customer
export - Export Customers
get - Get Customer
update - Update Customer
delete - Delete Customer
get_external - Get Customer by External ID
update_external - Update Customer by External ID
delete_external - Delete Customer by External ID
get_state - Get Customer State
get_state_external - Get Customer State by External ID

discounts

list - List Discounts
create - Create Discount
get - Get Discount
update - Update Discount
delete - Delete Discount

event_types

list - List Event Types
update - Update Event Type

events

list - List Events
list_names - List Event Names
get - Get Event
ingest - Ingest Events

files

list - List Files
create - Create File
uploaded - Complete File Upload
update - Update File
delete - Delete File

license_keys

list - List License Keys
get - Get License Key
update - Update License Key
get_activation - Get Activation
validate - Validate License Key
activate - Activate License Key
deactivate - Deactivate License Key

members

list_members - List Members
create_member - Create Member
get_member - Get Member
update_member - Update Member
delete_member - Delete Member

meters

list - List Meters
create - Create Meter
get - Get Meter
update - Update Meter
quantities - Get Meter Quantities

metrics

get - Get Metrics
limits - Get Metrics Limits

oauth2

authorize - Authorize
token - Request Token
revoke - Revoke Token
introspect - Introspect Token
userinfo - Get User Info

oauth2.clients

create - Create Client
get - Get Client
update - Update Client
delete - Delete Client

orders

list - List Orders
export - Export Subscriptions
get - Get Order
update - Update Order
generate_invoice - Generate Order Invoice
invoice - Get Order Invoice

organization_access_tokens

list - List
create - Create
update - Update
delete - Delete

organizations

list - List Organizations
create - Create Organization
get - Get Organization
update - Update Organization

products

list - List Products
create - Create Product
get - Get Product
update - Update Product
update_benefits - Update Product Benefits

refunds

list - List Refunds
create - Create Refund

subscriptions

list - List Subscriptions
create - Create Subscription
export - Export Subscriptions
get - Get Subscription
update - Update Subscription
revoke - Revoke Subscription

webhooks

list_webhook_endpoints - List Webhook Endpoints
create_webhook_endpoint - Create Webhook Endpoint
get_webhook_endpoint - Get Webhook Endpoint
update_webhook_endpoint - Update Webhook Endpoint
delete_webhook_endpoint - Delete Webhook Endpoint
reset_webhook_endpoint_secret - Reset Webhook Endpoint Secret
list_webhook_deliveries - List Webhook Deliveries
redeliver_webhook_event - Redeliver Webhook Event

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from spaire_sdk import Spaire
from spaire_sdk.utils import BackoffStrategy, RetryConfig


with Spaire(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as spaire:

    res = spaire.organizations.list(page=1, limit=10,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    while res is not None:
        # Handle items

        res = res.next()

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from spaire_sdk import Spaire
from spaire_sdk.utils import BackoffStrategy, RetryConfig


with Spaire(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as spaire:

    res = spaire.organizations.list(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Error Handling

SpaireError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
`err.message`	`str`	Error message
`err.status_code`	`int`	HTTP response status code eg `404`
`err.headers`	`httpx.Headers`	HTTP response headers
`err.body`	`str`	HTTP body. Can be empty string if no body is returned.
`err.raw_response`	`httpx.Response`	Raw HTTP response
`err.data`		Optional. Some errors may contain structured data. See Error Classes.

Example

import spaire_sdk
from spaire_sdk import Spaire, models


with Spaire(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as spaire:
    res = None
    try:

        res = spaire.organizations.list(page=1, limit=10)

        while res is not None:
            # Handle items

            res = res.next()


    except models.SpaireError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, models.HTTPValidationError):
            print(e.data.detail)  # Optional[List[spaire_sdk.ValidationError]]

Error Classes

Primary errors:

SpaireError: The base class for HTTP error responses.
- HTTPValidationError: Validation Error. Status code 422. *

Less common errors (23)

Network errors:

httpx.RequestError: Base class for request errors.
- httpx.ConnectError: HTTP client was unable to make a request to a server.
- httpx.TimeoutException: HTTP request timed out.

Inherit from SpaireError:

ResourceNotFound: Status code 404. Applicable to 82 of 166 methods.*
NotPermitted: Status code 403. Applicable to 10 of 166 methods.*
Unauthorized: Not authorized to manage license key. Status code 401. Applicable to 5 of 166 methods.*
AlreadyCanceledSubscription: Status code 403. Applicable to 4 of 166 methods.*
AlreadyActiveSubscriptionError: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 166 methods.*
NotOpenCheckout: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 166 methods.*
PaymentNotReady: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 166 methods.*
TrialAlreadyRedeemed: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 166 methods.*
ExpiredCheckoutError: The checkout session is expired. Status code 410. Applicable to 3 of 166 methods.*
SubscriptionLocked: Subscription is pending an update. Status code 409. Applicable to 2 of 166 methods.*
MissingInvoiceBillingDetails: Order is not paid or is missing billing name or address. Status code 422. Applicable to 2 of 166 methods.*
NotPaidOrder: Order is not paid or is missing billing name or address. Status code 422. Applicable to 2 of 166 methods.*
PaymentError: The payment failed. Status code 400. Applicable to 1 of 166 methods.*
CustomerNotReady: Customer is not ready to confirm a payment method. Status code 400. Applicable to 1 of 166 methods.*
PaymentMethodInUseByActiveSubscription: Payment method is used by active subscription(s). Status code 400. Applicable to 1 of 166 methods.*
RefundedAlready: Order is already fully refunded. Status code 403. Applicable to 1 of 166 methods.*
PaymentAlreadyInProgress: Payment already in progress. Status code 409. Applicable to 1 of 166 methods.*
OrderNotEligibleForRetry: Order not eligible for retry or payment confirmation failed. Status code 422. Applicable to 1 of 166 methods.*
ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: str optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Name	Server	Description
`production`	`https://api.spairehq.com`	Production environment
`sandbox`	`https://sandbox-api.spairehq.com`	Sandbox environment

Example

from spaire_sdk import Spaire


with Spaire(
    server="production",
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as spaire:

    res = spaire.organizations.list(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from spaire_sdk import Spaire


with Spaire(
    server_url="https://api.spairehq.com",
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as spaire:

    res = spaire.organizations.list(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from spaire_sdk import Spaire
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Spaire(client=http_client)

or you could wrap the client with your own custom logic:

from spaire_sdk import Spaire
from spaire_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Spaire(async_client=CustomClient(httpx.AsyncClient()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`access_token`	http	HTTP Bearer

To authenticate with the API the access_token parameter must be set when initializing the SDK client instance. For example:

from spaire_sdk import Spaire


with Spaire(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as spaire:

    res = spaire.organizations.list(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import spaire_sdk
from spaire_sdk import Spaire


with Spaire() as spaire:

    res = spaire.customer_portal.benefit_grants.list(security=spaire_sdk.CustomerPortalBenefitGrantsListSecurity(

    ), page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Resource Management

The Spaire class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from spaire_sdk import Spaire
def main():

    with Spaire(
        access_token="<YOUR_BEARER_TOKEN_HERE>",
    ) as spaire:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Spaire(
        access_token="<YOUR_BEARER_TOKEN_HERE>",
    ) as spaire:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from spaire_sdk import Spaire
import logging

logging.basicConfig(level=logging.DEBUG)
s = Spaire(debug_logger=logging.getLogger("spaire_sdk"))

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

from spaire_sdk import Spaire


with Spaire(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as spaire:

    res = spaire.organizations.list(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Summary

Spaire API: Spaire HTTP and Webhooks API

Read the docs at https://spairehq.com/docs/api-reference

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

Project details

These details have not been verified by PyPI

Project links

Repository

Release history Release notifications | RSS feed

This version

0.28.4

Mar 9, 2026

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spaire_sdk-0.28.4.tar.gz (279.9 kB view details)

Uploaded Mar 9, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

spaire_sdk-0.28.4-py3-none-any.whl (791.8 kB view details)

Uploaded Mar 9, 2026 Python 3

File details

Details for the file spaire_sdk-0.28.4.tar.gz.

File metadata

Download URL: spaire_sdk-0.28.4.tar.gz
Upload date: Mar 9, 2026
Size: 279.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for spaire_sdk-0.28.4.tar.gz
Algorithm	Hash digest
SHA256	`b1b3e9f37e0224a78eee5dbda4cc100f67923c2160bf560e7e7c2825cc0004c3`
MD5	`4b3e6addc0142b6748baef0d4fdd50c0`
BLAKE2b-256	`ceacf662b622aea0ef2aad11e4f39ace43502b857d5e72b7bcdbd7a276d78ab8`

See more details on using hashes here.

File details

Details for the file spaire_sdk-0.28.4-py3-none-any.whl.

File metadata

Download URL: spaire_sdk-0.28.4-py3-none-any.whl
Upload date: Mar 9, 2026
Size: 791.8 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for spaire_sdk-0.28.4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`8773d815217e189eca6c88532a0f39c2ba110c265dbb747e8fdb37ae189de2e0`
MD5	`fa945d72c9a7373c1c48f530e1f1a66b`
BLAKE2b-256	`1bc5f8088423aedae093e3cefe53ade8600c59210a987ab9e2dad7762102fed0`

See more details on using hashes here.

spaire-sdk 0.28.4

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

spaire-sdk

Table of Contents

SDK Installation

uv

PIP

Poetry

Shell and script usage with uv

IDE Support

PyCharm

SDK Example Usage

Example

Webhook support

Available Resources and Operations

Retries

Error Handling

Example

Error Classes

Server Selection

Select Server by Name

Example

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Per-Operation Security Schemes

Resource Management

Debugging

Pagination

Summary

Development

Maturity

Contributions

SDK Created by Speakeasy

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes

Shell and script usage with `uv`