Welcome to the Python client for the Planship API. Planship enables developers to build subscription logic for product pricing based on any combination of features, seats, and usage.
Install planship with pip, or another package manager of your choice like Poetry
pip install planship
# or
poetry add planshipImport and instantiate the Planship class, and start making calls to the Planship API
from planship import Planship
planship = Planship(
"clicker-demo", # Planship product slug
"273N1SQ3GQFZ8JSFKIOK", # Planship API client ID
"GDSfzPD2NEM5PEzIl1JoXFRJNZm3uAhX" # Planship API client secret
)
# List product plans
plans = planship.list_plans()
# Create a customer with a name and email
customer = planship.create_customer({
"name": "Darth Vader",
"email:": "[email protected]"
})
# Subscribe the customer to a plan with the slug "medium"
subscription = planship.create_subscription(customer.id, "medium")
# Retrieve entitlements for the customer
entitlements = planship.get_entitlements(customer.id)
# Report 11 units of usage for the "api-call" metering ID for the customer
planship.report_usage(customer.id, "api-call", 11)The complete reference for the Planship class can be found here.