)
The Checkout Intents Python library provides convenient access to the Checkout Intents REST API from any Python 3.9+ application. The library includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by httpx.
It is generated with Stainless.
The REST API documentation can be found on docs.rye.com. The full API of this library can be found in api.md.
# install from PyPI
pip install checkout-intentsThe full API of this library can be found in api.md.
import os
from checkout_intents import CheckoutIntents
client = CheckoutIntents(
api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"), # This is the default and can be omitted
# defaults to "staging".
environment="production",
)
checkout_intent = client.checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://rye-protocol.myshopify.com/products/rye-sticker",
quantity=1,
)While you can provide an api_key keyword argument,
we recommend using python-dotenv
to add CHECKOUT_INTENTS_API_KEY="My API Key" to your .env file
so that your API Key is not stored in source control.
This SDK includes helper methods for the asynchronous checkout flow. The recommended pattern follows Rye's two-phase checkout:
from checkout_intents import CheckoutIntents
client = CheckoutIntents()
# Phase 1: Create and wait for offer
intent = client.checkout_intents.create_and_poll(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://example.com/product",
quantity=1,
)
# Handle failure during offer retrieval
if intent.state == "failed":
print(f"Failed: {intent.failure_reason}")
else:
# Review pricing with user
print(f"Total: {intent.offer.cost.total}")
# Phase 2: Confirm and wait for completion
completed = client.checkout_intents.confirm_and_poll(
intent.id,
payment_method={
"type": "stripe_token",
"stripe_token": "tok_visa",
},
)
print(f"Status: {completed.state}")For more examples, see the examples/ directory:
complete-checkout-intent.py- Recommended two-phase flowerror-handling.py- Timeout and error handling withPollTimeoutError
Available polling methods:
create_and_poll()- Create and poll until offer is ready (awaiting_confirmation or failed)confirm_and_poll()- Confirm and poll until completion (completed or failed)poll_until_completed()- Poll until completed or failedpoll_until_awaiting_confirmation()- Poll until offer is ready or failed
All polling methods support customizable timeouts:
# Configure polling behavior
intent = client.checkout_intents.poll_until_completed(
intent_id,
poll_interval=5.0, # Poll every 5 seconds (default)
max_attempts=120, # Try up to 120 times, ~10 minutes (default)
)When polling operations exceed max_attempts, a PollTimeoutError is raised with helpful context:
from checkout_intents import CheckoutIntents, PollTimeoutError
client = CheckoutIntents()
try:
intent = client.checkout_intents.poll_until_completed(
intent_id,
poll_interval=5.0,
max_attempts=60,
)
except PollTimeoutError as e:
print(f"Polling timed out for intent: {e.intent_id}")
print(f"Attempted {e.attempts} times over {(e.attempts * e.poll_interval) / 1000}s")
# You can retrieve the current state manually
current_intent = client.checkout_intents.retrieve(e.intent_id)
print(f"Current state: {current_intent.state}")Simply import AsyncCheckoutIntents instead of CheckoutIntents and use await with each API call:
import os
import asyncio
from checkout_intents import AsyncCheckoutIntents
client = AsyncCheckoutIntents(
api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"), # This is the default and can be omitted
# defaults to "staging".
environment="production",
)
async def main() -> None:
checkout_intent = await client.checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://rye-protocol.myshopify.com/products/rye-sticker",
quantity=1,
)
asyncio.run(main())Functionality between the synchronous and asynchronous clients is otherwise identical.
By default, the async client uses httpx for HTTP requests. However, for improved concurrency performance you may also use aiohttp as the HTTP backend.
You can enable this by installing aiohttp:
# install from PyPI
pip install checkout-intents[aiohttp]Then you can enable it by instantiating the client with http_client=DefaultAioHttpClient():
import asyncio
from checkout_intents import DefaultAioHttpClient
from checkout_intents import AsyncCheckoutIntents
async def main() -> None:
async with AsyncCheckoutIntents(
api_key="My API Key",
http_client=DefaultAioHttpClient(),
) as client:
checkout_intent = await client.checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://rye-protocol.myshopify.com/products/rye-sticker",
quantity=1,
)
asyncio.run(main())Nested request parameters are TypedDicts. Responses are Pydantic models which also provide helper methods for things like:
- Serializing back into JSON,
model.to_json() - Converting to a dictionary,
model.to_dict()
Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set python.analysis.typeCheckingMode to basic.
List methods in the Checkout Intents API are paginated.
This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
from checkout_intents import CheckoutIntents
client = CheckoutIntents()
all_checkout_intents = []
# Automatically fetches more pages as needed.
for checkout_intent in client.checkout_intents.list(
limit=20,
):
# Do something with checkout_intent here
all_checkout_intents.append(checkout_intent)
print(all_checkout_intents)Or, asynchronously:
import asyncio
from checkout_intents import AsyncCheckoutIntents
client = AsyncCheckoutIntents()
async def main() -> None:
all_checkout_intents = []
# Iterate through items across all pages, issuing requests as needed.
async for checkout_intent in client.checkout_intents.list(
limit=20,
):
all_checkout_intents.append(checkout_intent)
print(all_checkout_intents)
asyncio.run(main())Alternatively, you can use the .has_next_page(), .next_page_info(), or .get_next_page() methods for more granular control working with pages:
first_page = await client.checkout_intents.list(
limit=20,
)
if first_page.has_next_page():
print(f"will fetch next page using these details: {first_page.next_page_info()}")
next_page = await first_page.get_next_page()
print(f"number of items we just fetched: {len(next_page.data)}")
# Remove `await` for non-async usage.Or just work directly with the returned data:
first_page = await client.checkout_intents.list(
limit=20,
)
print(f"next page cursor: {first_page.page_info.end_cursor}") # => "next page cursor: ..."
for checkout_intent in first_page.data:
print(checkout_intent)
# Remove `await` for non-async usage.Nested parameters are dictionaries, typed using TypedDict, for example:
from checkout_intents import CheckoutIntents
client = CheckoutIntents()
checkout_intent = client.checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="productUrl",
quantity=1,
)
print(checkout_intent.buyer)When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of checkout_intents.APIConnectionError is raised.
When the API returns a non-success status code (that is, 4xx or 5xx
response), a subclass of checkout_intents.APIStatusError is raised, containing status_code and response properties.
All errors inherit from checkout_intents.APIError.
import checkout_intents
from checkout_intents import CheckoutIntents
client = CheckoutIntents()
try:
client.checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://rye-protocol.myshopify.com/products/rye-sticker",
quantity=1,
)
except checkout_intents.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
except checkout_intents.RateLimitError as e:
print("A 429 status code was received; we should back off a bit.")
except checkout_intents.APIStatusError as e:
print("Another non-200-range status code was received")
print(e.status_code)
print(e.response)Error codes are as follows:
| Status Code | Error Type |
|---|---|
| 400 | BadRequestError |
| 401 | AuthenticationError |
| 403 | PermissionDeniedError |
| 404 | NotFoundError |
| 422 | UnprocessableEntityError |
| 429 | RateLimitError |
| >=500 | InternalServerError |
| N/A | APIConnectionError |
| N/A | PollTimeoutError |
When using polling helper methods, if the operation exceeds the configured max_attempts, a PollTimeoutError is raised. This error includes detailed context about the timeout:
from checkout_intents import CheckoutIntents, PollTimeoutError
try:
intent = client.checkout_intents.poll_until_completed("intent_id")
except PollTimeoutError as e:
# Access timeout details
print(f"Intent ID: {e.intent_id}")
print(f"Attempts: {e.attempts}")
print(f"Poll interval: {e.poll_interval}s")
print(f"Max attempts: {e.max_attempts}")See the error-handling.py example for more detailed timeout handling patterns.
Certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors are all retried by default.
You can use the max_retries option to configure or disable retry settings:
from checkout_intents import CheckoutIntents
# Configure the default for all requests:
client = CheckoutIntents(
# default is 2
max_retries=0,
)
# Or, configure per-request:
client.with_options(max_retries=5).checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://rye-protocol.myshopify.com/products/rye-sticker",
quantity=1,
)By default requests time out after 1 minute. You can configure this with a timeout option,
which accepts a float or an httpx.Timeout object:
from checkout_intents import CheckoutIntents
# Configure the default for all requests:
client = CheckoutIntents(
# 20 seconds (default is 1 minute)
timeout=20.0,
)
# More granular control:
client = CheckoutIntents(
timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)
# Override per-request:
client.with_options(timeout=5.0).checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://rye-protocol.myshopify.com/products/rye-sticker",
quantity=1,
)On timeout, an APITimeoutError is thrown.
Note that requests that time out are retried twice by default.
We use the standard library logging module.
You can enable logging by setting the environment variable CHECKOUT_INTENTS_LOG to info.
$ export CHECKOUT_INTENTS_LOG=infoOr to debug for more verbose logging.
In an API response, a field may be explicitly null, or missing entirely; in either case, its value is None in this library. You can differentiate the two cases with .model_fields_set:
if response.my_field is None:
if 'my_field' not in response.model_fields_set:
print('Got json like {}, without a "my_field" key present at all.')
else:
print('Got json like {"my_field": null}.')The "raw" Response object can be accessed by prefixing .with_raw_response. to any HTTP method call, e.g.,
from checkout_intents import CheckoutIntents
client = CheckoutIntents()
response = client.checkout_intents.with_raw_response.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://rye-protocol.myshopify.com/products/rye-sticker",
quantity=1,
)
print(response.headers.get('X-My-Header'))
checkout_intent = response.parse() # get the object that `checkout_intents.create()` would have returned
print(checkout_intent)These methods return an APIResponse object.
The async client returns an AsyncAPIResponse with the same structure, the only difference being awaitable methods for reading the response content.
The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
To stream the response body, use .with_streaming_response instead, which requires a context manager and only reads the response body once you call .read(), .text(), .json(), .iter_bytes(), .iter_text(), .iter_lines() or .parse(). In the async client, these are async methods.
with client.checkout_intents.with_streaming_response.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://rye-protocol.myshopify.com/products/rye-sticker",
quantity=1,
) as response:
print(response.headers.get("X-My-Header"))
for line in response.iter_lines():
print(line)The context manager is required so that the response will reliably be closed.
This library is typed for convenient access to the documented API.
If you need to access undocumented endpoints, params, or response properties, the library can still be used.
To make requests to undocumented endpoints, you can make requests using client.get, client.post, and other
http verbs. Options on the client will be respected (such as retries) when making this request.
import httpx
response = client.post(
"/foo",
cast_to=httpx.Response,
body={"my_param": True},
)
print(response.headers.get("x-foo"))If you want to explicitly send an extra param, you can do so with the extra_query, extra_body, and extra_headers request
options.
To access undocumented response properties, you can access the extra fields like response.unknown_prop. You
can also get all the extra fields on the Pydantic model as a dict with
response.model_extra.
You can directly override the httpx client to customize it for your use case, including:
- Support for proxies
- Custom transports
- Additional advanced functionality
import httpx
from checkout_intents import CheckoutIntents, DefaultHttpxClient
client = CheckoutIntents(
# Or use the `CHECKOUT_INTENTS_BASE_URL` env var
base_url="http://my.test.server.example.com:8083",
http_client=DefaultHttpxClient(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)You can also customize the client on a per-request basis by using with_options():
client.with_options(http_client=DefaultHttpxClient(...))By default the library closes underlying HTTP connections whenever the client is garbage collected. You can manually close the client using the .close() method if desired, or with a context manager that closes when exiting.
from checkout_intents import CheckoutIntents
with CheckoutIntents() as client:
# make requests here
...
# HTTP client is now closedThis package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes that only affect static types, without breaking runtime behavior.
- Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.
If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
You can determine the version that is being used at runtime with:
import checkout_intents
print(checkout_intents.__version__)Python 3.9 or higher.