Metronome SDK

Common errors

• AttributeError: 'Rate' object has no attribute 'minimum_config'

  cause You are attempting to set or access the `minimum_config` field on a `Rate` object, which was removed in version 4.3.0.
  fix Remove the `minimum_config` attribute from your `Rate` or `Override` object definitions. Update your code to reflect the schema changes.

• TypeError: 'priority' is an unexpected keyword argument for 'create_contract'

  cause The `priority` field was removed as a parameter for contract creation/update in version 4.2.0.
  fix Remove the `priority` keyword argument from your `client.contracts.create()` or `client.contracts.edit()` calls.

• metronome.ApiException: 401 Unauthorized

  cause The API key provided is missing, invalid, or has insufficient permissions.
  fix Ensure the `METRONOME_API_KEY` environment variable is correctly set, or pass a valid `api_key` directly when initializing `metronome.client.Metronome()`.

• TypeError: Missing required argument 'billing_config'

  cause You are trying to create a resource (e.g., a customer) without providing a required configuration object.
  fix Review the Metronome API documentation for the specific endpoint you are using and provide all mandatory fields, such as `billing_config` when creating a customer.

Warnings

• breaking The `minimum_config` field was removed from Rate and Override schemas.
  Fix: Remove `minimum_config` from any Rate or Override objects in your API requests (e.g., when creating/editing contracts, plans, or prices). Review your contract and pricing configurations.
• breaking The `priority` parameter and response field were removed from contract-related API endpoints.
  Fix: Remove `priority` from any parameters sent when creating or updating contracts, and adjust code that expects `priority` in contract responses.
• breaking The `use_list_prices` field was removed from Rate objects.
  Fix: Update your API calls and data models to no longer include or expect the `use_list_prices` field on Rate objects, particularly when defining or updating pricing plans.
• breaking The `customer_id` parameter was removed from preview events requests.
  Fix: When calling the preview events API, ensure you are no longer passing `customer_id` as a request parameter.
• breaking The Preview Events API changed its response structure to return a list of invoices instead of a single invoice object.
  Fix: If your code assumes a single invoice object from the Preview Events API, update it to iterate over the returned list of invoices, even if it expects only one.
• breaking Pagination support was added to many list endpoints (e.g., Customers, Invoices, Commits, Credits, Usage).
  Fix: Update calls to affected list endpoints (e.g., `client.customers.list()`) to correctly handle pagination by checking `response.next_page` and `response.items` for results. Direct access to `.items` will only provide the current page's results.

Install

• pip install metronome-sdk Install stable version

Imports

• Metronome
  wrong:

  import metronome; client = metronome.Metronome()

  correct:

  from metronome.client import Metronome

  The Metronome client class is within the 'client' submodule, not directly under 'metronome'.
• types
  wrong:

  from metronome import types

  correct:

  import metronome.types as types

  It's best practice to import the 'types' module with an alias or specific types directly, rather than the top-level 'types' that might conflict.

Quickstart

This quickstart initializes the Metronome client using an API key from an environment variable and then demonstrates listing existing customers and creating a new one. Ensure you have a `METRONOME_API_KEY` environment variable set with your actual Metronome API key for successful API calls.

import os
from metronome.client import Metronome
import metronome.types as types

METRONOME_API_KEY = os.environ.get('METRONOME_API_KEY', 'YOUR_API_KEY')

if not METRONOME_API_KEY or METRONOME_API_KEY == 'YOUR_API_KEY':
    print("Warning: METRONOME_API_KEY not set. Using placeholder.")
    # Example: run in dry-run mode or with a mocked client for testing
    # For real API calls, ensure API key is set.
    exit(1)

client = Metronome(api_key=METRONOME_API_KEY)

try:
    # Example: List customers
    customers = client.customers.list()
    print(f"Found {len(customers.items)} customers:")
    for customer in customers.items[:3]: # Print first 3 customers
        print(f"  ID: {customer.id}, Name: {customer.name}")

    # Example: Create a new test customer
    new_customer = client.customers.create(
        name="My Test Customer from SDK",
        billing_config=types.BillingConfig(
            currency="USD",
            billing_provider_type=types.BillingProviderType.STRIPE,
            billing_provider_customer_id="cus_test_123",
        ),
        external_id="my-test-customer-123"
    )
    print(f"Created new customer with ID: {new_customer.id}")

except Exception as e:
    print(f"An error occurred: {e}")