Struct LagoClient

Source

pub struct LagoClient { /* private fields */ }

Expand description

The main client for interacting with the Lago API

This client handles HTTP requests, authentication, retries, and error handling when communicating with the Lago billing API.

Implementations§

Source §

impl LagoClient

Source

pub fn new(config: Config) -> Self

Creates a new Lago client with the provided configuration

§Arguments

config - The configuration settings for the client

§Returns

A new instance of LagoClient

Source

pub fn from_env() -> Result<Self>

Creates a new Lago client using default configuration from environment variables

This method will use default settings and attempt to load credentials from environment variables.

§Returns

A Result containing a new LagoClient instance or an error

Source §

impl LagoClient

Activity log-related operations for the Lago client

Source

pub async fn list_activity_logs( &self, request: Option<ListActivityLogsRequest>, ) -> Result<ListActivityLogsResponse>

Retrieves a list of activity logs with optional filtering parameters

§Arguments

request - Optional filtering parameters for the activity log list

§Returns

A Result containing the list of activity logs or an error

Source

pub async fn get_activity_log( &self, request: GetActivityLogRequest, ) -> Result<GetActivityLogResponse>

Retrieves a specific activity log by its activity ID

§Arguments

request - The request containing the activity log ID to retrieve

§Returns

A Result containing the activity log data or an error

Source §

impl LagoClient

API log-related operations for the Lago client

Source

pub async fn list_api_logs( &self, request: Option<ListApiLogsRequest>, ) -> Result<ListApiLogsResponse>

Retrieves a list of API logs with optional filtering parameters

§Arguments

request - Optional filtering parameters for the API log list

§Returns

A Result containing the list of API logs or an error

Source

pub async fn get_api_log( &self, request: GetApiLogRequest, ) -> Result<GetApiLogResponse>

Retrieves a specific API log by its request ID

§Arguments

request - The request containing the API log request ID to retrieve

§Returns

A Result containing the API log data or an error

Source §

impl LagoClient

Source

pub async fn list_applied_coupons( &self, request: Option<ListAppliedCouponsRequest>, ) -> Result<ListAppliedCouponsResponse>

Retrieves a list of applied coupons with optional filtering parameters

§Arguments

request - Optional filtering parameters for the applied coupon list

§Returns

A Result containing the list of applied coupons or an error

Source

pub async fn apply_coupon( &self, request: ApplyCouponRequest, ) -> Result<ApplyCouponResponse>

Applies a coupon to a customer

§Arguments

request - The request containing the coupon application data

§Returns

A Result containing the applied coupon data or an error

Source §

impl LagoClient

Source

pub async fn list_billable_metrics( &self, request: Option<ListBillableMetricsRequest>, ) -> Result<ListBillableMetricsResponse>

Retrieves a list of billable metrics with optional filtering parameters

§Arguments

request - Optional filtering parameters for the billable metric list

§Returns

A Result containing the list of billable metrics or an error

Source

pub async fn get_billable_metric( &self, request: GetBillableMetricRequest, ) -> Result<GetBillableMetricResponse>

Retrieves a specific billable metric by its code

§Arguments

request - The request containing the billable metric code to retrieve

§Returns

A Result containing the billable metric data or an error

Source

pub async fn create_billable_metric( &self, request: CreateBillableMetricRequest, ) -> Result<CreateBillableMetricResponse>

Creates a new billable metric

§Arguments

request - The request containing the billable metric data to create

§Returns

A Result containing the created billable metric data or an error

Source §

impl LagoClient

Source

pub async fn list_coupons( &self, request: Option<ListCouponsRequest>, ) -> Result<ListCouponsResponse>

Retrieves a list of coupons with optional filtering parameters

§Arguments

request - Optional filtering parameters for the coupon list

§Returns

A Result containing the list of coupons or an error

Source

pub async fn get_coupon( &self, request: GetCouponRequest, ) -> Result<GetCouponResponse>

Retrieves a coupon by its code

§Arguments

request - The request containing the coupon code to retrieve

§Returns

A Result containing the coupon data or an error

Source

pub async fn create_coupon( &self, request: CreateCouponRequest, ) -> Result<CreateCouponResponse>

Creates a new coupon

§Arguments

request - The request containing the coupon data to create

§Returns

A Result containing the created coupon data or an error

Source

pub async fn update_coupon( &self, request: UpdateCouponRequest, ) -> Result<UpdateCouponResponse>

Updates an existing coupon

§Arguments

request - The request containing the coupon code and update data

§Returns

A Result containing the updated coupon data or an error

Source

pub async fn delete_coupon( &self, request: DeleteCouponRequest, ) -> Result<DeleteCouponResponse>

Deletes a coupon by its code

§Arguments

request - The request containing the coupon code to delete

§Returns

A Result containing the deleted coupon data or an error

Source §

impl LagoClient

Credit note-related operations for the Lago client

Source

pub async fn list_credit_notes( &self, request: Option<ListCreditNotesRequest>, ) -> Result<ListCreditNotesResponse>

Retrieves a list of credit notes with optional filtering parameters

§Arguments

request - Optional filtering parameters for the credit note list

§Returns

A Result containing the list of credit notes or an error

§Example

use lago_client::LagoClient;
use lago_types::requests::credit_note::ListCreditNotesRequest;
use lago_types::filters::credit_note::CreditNoteFilter;

let client = LagoClient::from_env()?;
let request = ListCreditNotesRequest::new()
    .with_filters(CreditNoteFilter::new().with_external_customer_id("customer_123".to_string()));
let response = client.list_credit_notes(Some(request)).await?;
println!("Found {} credit notes", response.credit_notes.len());

Source

pub async fn get_credit_note( &self, request: GetCreditNoteRequest, ) -> Result<GetCreditNoteResponse>

Retrieves a specific credit note by its Lago ID

§Arguments

request - The request containing the Lago ID to retrieve

§Returns

A Result containing the credit note data or an error

§Example

use lago_client::LagoClient;
use lago_types::requests::credit_note::GetCreditNoteRequest;

let client = LagoClient::from_env()?;
let request = GetCreditNoteRequest::new("1a901a90-1a90-1a90-1a90-1a901a901a90".to_string());
let response = client.get_credit_note(request).await?;
println!("Credit note number: {}", response.credit_note.number);

Source

pub async fn create_credit_note( &self, request: CreateCreditNoteRequest, ) -> Result<CreateCreditNoteResponse>

Creates a new credit note

Credit notes are issued to refund or credit customers for invoices, either partially or in full.

§Arguments

request - The request containing the credit note data to create

§Returns

A Result containing the created credit note or an error

§Example

use lago_client::LagoClient;
use lago_types::requests::credit_note::{
    CreateCreditNoteInput, CreateCreditNoteItemInput, CreateCreditNoteRequest,
};
use lago_types::models::CreditNoteReason;

let client = LagoClient::from_env()?;
let items = vec![
    CreateCreditNoteItemInput::new("fee_lago_id".to_string(), 1000),
];
let input = CreateCreditNoteInput::new(
    "invoice_lago_id".to_string(),
    CreditNoteReason::Other,
    1000,
    0,
    items,
)
.with_description("Credit for billing error".to_string());

let request = CreateCreditNoteRequest::new(input);
let response = client.create_credit_note(request).await?;
println!("Created credit note: {}", response.credit_note.number);

Source

pub async fn update_credit_note( &self, request: UpdateCreditNoteRequest, ) -> Result<UpdateCreditNoteResponse>

Updates an existing credit note

Currently, only the refund_status can be updated on a credit note.

§Arguments

request - The request containing the Lago ID and update data

§Returns

A Result containing the updated credit note or an error

§Example

use lago_client::LagoClient;
use lago_types::requests::credit_note::{UpdateCreditNoteInput, UpdateCreditNoteRequest};
use lago_types::models::CreditNoteRefundStatus;

let client = LagoClient::from_env()?;
let input = UpdateCreditNoteInput::new()
    .with_refund_status(CreditNoteRefundStatus::Succeeded);

let request = UpdateCreditNoteRequest::new(
    "1a901a90-1a90-1a90-1a90-1a901a901a90".to_string(),
    input,
);
let response = client.update_credit_note(request).await?;
println!("Updated credit note: {}", response.credit_note.number);

Source §

impl LagoClient

Source

pub async fn list_customers( &self, request: Option<ListCustomersRequest>, ) -> Result<ListCustomersResponse>

Retrieves a list of customers with optional filtering parameters

§Arguments

request - Optional filtering parameters for the customer list

§Returns

A Result containing the list of customers or an error

Source

pub async fn get_customer( &self, request: GetCustomerRequest, ) -> Result<GetCustomerResponse>

Retrieves a specific customer by their external ID

§Arguments

request - The request containing the customer external ID to retrieve

§Returns

A Result containing the customer data or an error

Source

pub async fn create_customer( &self, request: CreateCustomerRequest, ) -> Result<CreateCustomerResponse>

Creates a new customer

§Arguments

request - The request containing the customer data to create

§Returns

A Result containing the created customer data or an error

Source §

impl LagoClient

Source

pub async fn get_customer_current_usage( &self, request: GetCustomerCurrentUsageRequest, ) -> Result<GetCustomerCurrentUsageResponse>

Retrieves the current usage for a customer’s subscription

This endpoint enables the retrieval of usage-based billing data for a customer within the current billing period.

§Arguments

request - The request containing the customer and subscription IDs

§Returns

A Result containing the customer usage data or an error

Source §

impl LagoClient

Source

pub async fn get_event( &self, request: GetEventRequest, ) -> Result<GetEventResponse>

Retrieves a specific event by its transaction ID

§Arguments

request - The request containing the transaction ID to retrieve

§Returns

A Result containing the event data or an error

§Example

use lago_client::LagoClient;
use lago_types::requests::event::GetEventRequest;

let client = LagoClient::from_env()?;
let request = GetEventRequest::new("transaction_123".to_string());
let response = client.get_event(request).await?;
println!("Event code: {}", response.event.code);

Source

pub async fn create_event( &self, request: CreateEventRequest, ) -> Result<CreateEventResponse>

Creates a new usage event

This endpoint is used for transmitting usage measurement events to either a designated customer or a specific subscription.

§Arguments

request - The request containing the event data to create

§Returns

A Result containing the created event acknowledgment or an error

§Example

use lago_client::LagoClient;
use lago_types::requests::event::{CreateEventInput, CreateEventRequest};
use serde_json::json;

let client = LagoClient::from_env()?;
let event_input = CreateEventInput::for_customer(
    "transaction_456".to_string(),
    "customer_123".to_string(),
    "api_calls".to_string(),
)
.with_properties(json!({"calls": 150}));

let request = CreateEventRequest::new(event_input);
let response = client.create_event(request).await?;
println!("Event created: {}", response.event.transaction_id);

Source

pub async fn list_events( &self, request: Option<ListEventsRequest>, ) -> Result<ListEventsResponse>

Retrieves a list of events with optional filtering parameters

This endpoint is used for retrieving all events, with support for filtering by subscription, billable metric code, and timestamp range.

§Arguments

request - Optional request containing filter and pagination parameters. If None, returns all events with default pagination.

§Returns

A Result containing the list of events with pagination metadata or an error

§Example

use lago_client::LagoClient;
use lago_types::requests::event::ListEventsRequest;
use lago_types::models::PaginationParams;

let client = LagoClient::from_env()?;

// List all events
let events = client.list_events(None).await?;
println!("Found {} events", events.events.len());

// List events with filters
let request = ListEventsRequest::new()
    .with_pagination(PaginationParams::new().with_per_page(50))
    .with_external_subscription_id("sub_123".to_string())
    .with_code("api_calls".to_string())
    .with_timestamp_range(
        "2024-01-01T00:00:00Z".to_string(),
        "2024-01-31T23:59:59Z".to_string(),
    );
let filtered_events = client.list_events(Some(request)).await?;

Source §

impl LagoClient

Invoice-related operations for the Lago client

Source

pub async fn list_invoices( &self, request: Option<ListInvoicesRequest>, ) -> Result<ListInvoicesResponse>

Retrieves a list of invoices with optional filtering parameters

§Arguments

request - Optional filtering parameters for the invoice list

§Returns

A Result containing the list of invoices or an error

Source

pub async fn get_invoice( &self, request: GetInvoiceRequest, ) -> Result<GetInvoiceResponse>

Retrieves a specific invoice by its ID

§Arguments

request - The request containing the invoice ID to retrieve

§Returns

A Result containing the invoice data or an error

Source

pub async fn preview_invoice( &self, request: InvoicePreviewRequest, ) -> Result<InvoicePreviewResponse>

Previews an invoice without creating it

This endpoint allows you to retrieve an estimated invoice before finalization. It can be used to preview invoices for new subscriptions or existing customers.

§Arguments

request - The invoice preview request containing customer and subscription details

§Returns

A Result containing the previewed invoice or an error

Source

pub async fn create_invoice( &self, request: CreateInvoiceRequest, ) -> Result<CreateInvoiceResponse>

Creates a one-off invoice for a customer

This endpoint allows you to create a one-off invoice with add-on charges for a specific customer.

§Arguments

request - The request containing the invoice details and fees

§Returns

A Result containing the created invoice or an error

Source

pub async fn update_invoice( &self, request: UpdateInvoiceRequest, ) -> Result<UpdateInvoiceResponse>

Updates an existing invoice

This endpoint allows you to update the payment status or metadata of an existing invoice.

§Arguments

request - The request containing the invoice ID and update data

§Returns

A Result containing the updated invoice or an error

Source

pub async fn list_customer_invoices( &self, request: ListCustomerInvoicesRequest, ) -> Result<ListInvoicesResponse>

Retrieves a list of invoices for a specific customer

§Arguments

request - The request containing the customer ID and optional filters

§Returns

A Result containing the list of invoices or an error

Source

pub async fn refresh_invoice( &self, request: RefreshInvoiceRequest, ) -> Result<RefreshInvoiceResponse>

Refreshes a draft invoice

This endpoint re-fetches the customer information and recomputes the taxes for a draft invoice. Only draft invoices can be refreshed.

§Arguments

request - The request containing the invoice ID to refresh

§Returns

A Result containing the refreshed invoice or an error

Source

pub async fn download_invoice( &self, request: DownloadInvoiceRequest, ) -> Result<DownloadInvoiceResponse>

Downloads an invoice PDF

This endpoint triggers the generation of the invoice PDF if not already generated, and returns the invoice with a file_url field containing the URL to download the PDF.

§Arguments

request - The request containing the invoice ID to download

§Returns

A Result containing the invoice with file_url or an error

Source

pub async fn retry_invoice( &self, request: RetryInvoiceRequest, ) -> Result<RetryInvoiceResponse>

Retries a failed invoice finalization

This endpoint retries the finalization process for invoices that failed during generation. Only failed invoices can be retried.

§Arguments

request - The request containing the invoice ID to retry

§Returns

A Result containing the retried invoice or an error

Source

pub async fn retry_invoice_payment( &self, request: RetryInvoicePaymentRequest, ) -> Result<RetryInvoicePaymentResponse>

Retries a failed invoice payment

This endpoint resends the invoice for collection and retries the payment with the payment provider. Only invoices with failed payment status can be retried.