Paddle Rust SDK

https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/
Admin
An async and ergonomic Rust client library for interacting with the Paddle API, providing builders...
Tokens:55,911
Snippets:476
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Business Information with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Demonstrates how to retrieve business information for a specific customer using the Paddle Rust SDK. It initializes the Paddle client and sends a request to get business details.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let customers = client.business_get("ctm_01jqztc78e1xfdgwhcgjzdrvgd", "biz_01jr85bypq4d3w139m53zw2559").send().await.unwrap();
```

--------------------------------

### List Transactions with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Shows how to retrieve a list of transactions. This example initializes the Paddle client and calls `transactions_list` to get a request builder for querying transactions. The `send().await.unwrap()` part executes the request.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let transactions = client.transactions_list().send().await.unwrap();
```

--------------------------------

### Get a Specific Payment Method with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Demonstrates how to fetch details of a specific saved payment method for a customer. The example initializes the Paddle client and uses `payment_method_get` with customer and payment method IDs.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let customers = client.payment_method_get("ctm_01jqztc78e1xfdgwhcgjzdrvgd", "paymtd_01j2jff1m3es31sdkejpaym164").send().await.unwrap();
```

--------------------------------

### GET /discounts

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves a list of available discounts. Supports pagination through the `send` method.

```APIDOC
## GET /discounts

### Description
Retrieves a list of available discounts. Supports pagination through the `send` method.

### Method
GET

### Endpoint
/discounts

### Parameters
None

### Request Example
```rust
use paddle_rust_sdk::Paddle;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let list = client.discounts_list();
let mut discounts = list.send();

while let Some(res) = discounts.next().await.unwrap() {
    dbg!(res.data);
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of discount objects.
- **id** (string) - The ID of the discount.
- **amount** (string) - The amount of the discount.
- **description** (string) - The description of the discount.

#### Response Example
```json
[
  {
    "id": "dsc_01jqzpbmnq...",
    "amount": "10",
    "description": "Summer Sale"
  }
]
```
```

--------------------------------

### Initialize and Use Paddle API Client (Rust)

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/index

Demonstrates how to initialize the Paddle API client with a key and the sandbox environment. It then shows how to list customers with pagination and retrieve all results. This example requires the PADDLE_API_KEY environment variable to be set.

```rust
use paddle_rust_sdk::Paddle;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Paddle::new(std::env::var("PADDLE_API_KEY")?, Paddle::SANDBOX)?;

    let mut list = client.customers_list();
    let mut paginated = list.per_page(2).send();
    let customers = paginated.all().await?;

    dbg!(customers);

    Ok(())
}
```

--------------------------------

### List Products Request (Rust)

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Shows how to build and send a request to list products from Paddle. Supports ordering, pagination, and filtering by status. The example iterates through paginated results.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();

let mut products_list = client.products_list();
let mut products = products_list.order_by_asc("id").per_page(20).send();

while let Some(res) = products.next().await.unwrap() {
    dbg!(res.data);
}
```

--------------------------------

### PricingPreview: new() - Initialize Pricing Preview

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/pricing_preview/struct

Initializes a new PricingPreview builder. Requires a Paddle client instance and an iterator of PricePreviewItem. This is the starting point for constructing a pricing preview request.

```rust
pub fn new( client: &'a Paddle, items: impl IntoIterator<Item = PricePreviewItem>, ) -> Self
```

--------------------------------

### Create Price Request (Rust)

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Provides an example of creating a new price for a product in Paddle. It requires the product ID, a description, the amount, and the currency code.

```rust
pub fn price_create(
    &self,
    product_id: impl Into<ProductID>,
    description: impl Into<String>,
    amount: u64,
    currency: CurrencyCode,
) -> PricesCreate<'_>
```

--------------------------------

### Create Customer Portal Session with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Illustrates how to create a customer portal session for a customer, enabling them to access the portal. The example initializes the client and uses `create_portal_session`, then prints overview and subscription URLs.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let session = client.create_portal_session("ctm_01jqztc78e1xfdgwhcgjzdrvgd").send().await.unwrap();
dbg!(session.data.urls.general.overview);
dbg!(session.data.urls.subscriptions);
```

--------------------------------

### Update a Transaction with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Shows how to initiate an update for a transaction. This example initializes the Paddle client and uses the `transaction_update` method with a transaction ID to get a request builder. Further modifications would be chained to this builder.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let res = client.transaction_update("txn_01hv8wptq8987qeep44cyrewp9").send().await.unwrap();

// Further updates would be chained here
```

--------------------------------

### Report Creation API

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Get a request builder for creating reports in Paddle. Reports are created as `pending` initially while Paddle generates your report. They move to `ready` when they’re ready to download. You can download a report when it’s ready using the get a CSV file for a report operation. If successful, your response includes a copy of the new report entity.

```APIDOC
## POST /reports

### Description
Creates a new report in Paddle. Reports are initially set to a 'pending' state and will transition to 'ready' once generated.

### Method
POST

### Endpoint
/reports

### Parameters
#### Query Parameters
- **report_type** (T) - Required - The type of report to create. Must implement `ReportType` and `DeserializeOwned`.

### Request Body
(Not explicitly defined, inferred from `report_type` parameter)

### Response
#### Success Response (200)
- **ReportCreate<'a, T>** (object) - A builder object for creating the report.
```

--------------------------------

### Get a Specific Transaction with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Provides an example of how to fetch a specific transaction using its ID. The code initializes the Paddle client and calls `transaction_get` with the transaction ID, then prints the transaction data.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let res = client.transaction_get("txn_01hv8wptq8987qeep44cyrewp9").send().await.unwrap();
dbg!(res.data);
```

--------------------------------

### List Prices Request (Rust)

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Demonstrates how to build and send a request to list prices associated with products in Paddle. Supports ordering and pagination, with an example of iterating through results.

```rust
use paddle_rust_sdk::Paddle;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();

let mut prices_list = client.prices_list();
let mut prices = prices_list.order_by_asc("id").per_page(20).send();

while let Some(res) = prices.next().await.unwrap() {
    dbg!(res.data);
}
```

--------------------------------

### GET /customers

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves a list of customers. Supports pagination using the `after` method and filtering by status (active/archived).

```APIDOC
## GET /customers

### Description
Retrieves a list of customers. Supports pagination using the `after` method and filtering by status (active/archived).

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filters customers by status ('active' or 'archived'). Defaults to 'active'.

### Request Example
```rust
use paddle_rust_sdk::Paddle;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let customers = client.customers_list().send().await.unwrap();
```

### Response
#### Success Response (200)
- **data** (array) - A list of customer objects.
- **id** (string) - The ID of the customer.
- **email** (string) - The email address of the customer.

#### Response Example
```json
[
  {
    "id": "ctm_01jqztc78e1xfdgwhcgjzdrvgd",
    "email": "user@example.com"
  }
]
```
```

--------------------------------

### Subscription Update Preview API

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/subscriptions/index

Provides a request builder for getting a preview of changes to a subscription.

```APIDOC
## Subscription Update Preview API

### Description
Request builder for getting a preview of changes to a subscription without actually applying them.

### Method
POST

### Endpoint
/subscriptions/{subscription_id}/preview_update

### Parameters
#### Path Parameters
- **subscription_id** (string) - Required - The ID of the subscription to preview updates for.

#### Request Body
- **changes** (object) - Required - Object containing the changes to preview.

### Response
#### Success Response (200)
- **data** (object) - Details of the subscription update preview.

#### Response Example
{
  "data": {
    "preview_id": "prev_update_klmno",
    "new_price": "20.00"
  }
}
```

--------------------------------

### Subscription Get API

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/subscriptions/index

Provides a request builder for fetching a specific subscription.

```APIDOC
## Subscription Get API

### Description
Request builder for fetching a specific subscription.

### Method
GET

### Endpoint
/subscriptions/{subscription_id}

### Parameters
#### Path Parameters
- **subscription_id** (string) - Required - The ID of the subscription to retrieve.

### Response
#### Success Response (200)
- **data** (object) - Details of the requested subscription.

#### Response Example
{
  "data": {
    "id": "sub_12345",
    "status": "active"
  }
}
```

--------------------------------

### Get Product

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves details for a specific product using its Paddle ID.

```APIDOC
## Get Product

### Description
Get a request builder for fetching a specific product.

### Method
`product_get`

### Parameters
#### Path Parameters
- **product_id** (impl Into<ProductID>) - Required - The Paddle ID of the product to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let product = client.product_get("pro_01jqx9rd...").send().await.unwrap();
```

### Response
#### Success Response (200)
- **product** (object) - The requested product object.

#### Response Example
(Response structure depends on the actual product data returned.)
```

--------------------------------

### Update Business Information with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Shows how to update business information for a customer. This example initializes the Paddle client and uses the `business_update` method to set the first line of the business address.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let customers = client.business_update("ctm_01jqztc78e1xfdgwhcgjzdrvgd", "biz_01jr85bypq4d3w139m53zw2559").first_line("Test").send().await.unwrap();
```

--------------------------------

### Create ReportsList Builder - paddle-rust-sdk

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/reports/struct

Initializes a new ReportsList builder. This is the starting point for constructing a report query.

```Rust
pub fn new(client: &'a Paddle) -> Self
```

--------------------------------

### List Payment Methods for a Customer with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Provides an example of how to retrieve a list of saved payment methods for a given customer. It initializes the Paddle client and calls `payment_methods_list`.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let customers = client.payment_methods_list("ctm_01jqztc78e1xfdgwhcgjzdrvgd").send().await.unwrap();
```

--------------------------------

### List Reports

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Get a request builder for fetching a list of available reports in Paddle.

```APIDOC
## GET /api/reports

### Description
Retrieves a list of available reports from Paddle.

### Method
GET

### Endpoint
/api/reports

### Parameters
None

### Request Example
```rust
use paddle_rust_sdk::Paddle;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();

let reports_builder = client.reports_list();
// Further operations on the builder to fetch or filter reports
```

### Response
#### Success Response (200)
- **data** (ReportsListResponse) - A list of report identifiers and metadata.

#### Response Example
```json
{
  "data": [
    {
      "id": "rep_example_id_1",
      "name": "Sales Report",
      "created_at": "2023-10-27T09:00:00Z"
    },
    {
      "id": "rep_example_id_2",
      "name": "Revenue Report",
      "created_at": "2023-10-26T09:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Preview Pricing

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Get a request builder for fetching pricing previews for one or more prices, often used for building pricing pages. Location information can be provided to calculate tax and localize prices.

```APIDOC
## POST /api/prices/preview

### Description
Fetches pricing previews for specified items, allowing for tax calculation and price localization based on provided location data.

### Method
POST

### Endpoint
/api/prices/preview

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **items** (Array<PricePreviewItem>) - Required - A list of items for which to preview pricing. Each item should include `price_id` and `quantity`.
- **customer_ip_address** (String) - Optional - The IP address of the customer for location-based calculations.
- **address** (Address) - Optional - The customer's address, including country and ZIP code.
- **customer_id** (CustomerID) - Optional - The ID of an existing customer.
- **address_id** (AddressID) - Optional - The ID of an existing address.
- **business_id** (BusinessID) - Optional - The ID of an existing business.

### Request Example
```rust
use paddle_rust_sdk::{
    enums::Disposition, // Note: Disposition is not directly used in pricing_preview parameters but shown in example
    Paddle,
    PricePreviewItem,
};

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();

let res = client.pricing_preview()
    .send([
        PricePreviewItem { price_id: "pri_01jqxvdyjkp961jzv4me7ezg4d".into(), quantity: 1, },
    ])
    .await
    .unwrap();

dbg!(res.data)
```

### Response
#### Success Response (200)
- **data** (PricingPreviewResponse) - Contains the pricing details, including totals formatted for the specified region and currency.

#### Response Example
```json
{
  "data": {
    "currency": "USD",
    "net_total": "10.00",
    "tax_total": "1.00",
    "gross_total": "11.00",
    "line_items": [
      {
        "price_id": "pri_01jqxvdyjkp961jzv4me7ezg4d",
        "quantity": 1,
        "unit_price": {
          "gross": "10.00",
          "net": "10.00",
          "currency_code": "USD"
        },
        "formatted_unit_total": {
          "gross": "$10.00",
          "net": "$10.00",
          "currency_code": "USD"
        },
        "formatted_total": {
          "gross": "$10.00",
          "net": "$10.00",
          "currency_code": "USD"
        }
      }
    ]
  }
}
```
```

--------------------------------

### GET /customers/{customer_id}

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves a specific customer by their ID.

```APIDOC
## GET /customers/{customer_id}

### Description
Retrieves a specific customer by their ID.

### Method
GET

### Endpoint
/customers/{customer_id}

### Parameters
#### Path Parameters
- **customer_id** (string) - Required - The unique identifier of the customer to retrieve.

### Request Example
```rust
use paddle_rust_sdk::Paddle;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let discount = client.customer_get("ctm_01jqztc78e1xfdgwhcgjzdrvgd").send().await.unwrap();
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the customer.
- **email** (string) - The email address of the customer.

#### Response Example
```json
{
  "id": "ctm_01jqztc78e1xfdgwhcgjzdrvgd",
  "email": "user@example.com"
}
```
```

--------------------------------

### GET /customers/{customer_id}/credit_balances

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves a list of credit balances for each currency for a given customer. Includes available, reserved, and used credit totals.

```APIDOC
## GET /customers/{customer_id}/credit_balances

### Description
Fetches a list of credit balances for each currency for a customer. The balances detail available, reserved, and used credit amounts. Credit is automatically created by Paddle for actions like prorated subscription changes. Returns an empty array if no credit balances exist. The response is not paginated.

### Method
GET

### Endpoint
`/customers/{customer_id}/credit_balances`

### Parameters
#### Path Parameters
- **customer_id** (CustomerID) - Required - The unique identifier of the customer.

### Request Example
```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let credit_balances = client.customer_credit_balances("ctm_01jqztc78e1xfdgwhcgjzdrvgd").send().await.unwrap();
```

### Response
#### Success Response (200)
- **data** (array) - An array of credit balance objects, each containing 'currency', 'available', 'reserved', and 'used' fields.
- **meta** (object) - Metadata about the response.

#### Response Example
```json
{
  "data": [
    {
      "currency": "USD",
      "available": "100.00",
      "reserved": "20.00",
      "used": "50.00"
    }
  ],
  "meta": {
    "request_id": "req_abc123"
  }
}
```
```

--------------------------------

### Get Specific Product Request (Rust)

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Illustrates how to retrieve details for a specific product using its Paddle ID. An API client instance is needed to make the request.

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let product = client.product_get("pro_01jqx9rd...").send().await.unwrap();
```

--------------------------------

### Subscription Preview One-Time Charge API

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Get a request builder for previewing the creation of a one-time charge for a subscription without billing it. Useful for previewing calculations before applying changes. The response includes details on immediate, next, and recurring transactions.

```APIDOC
## POST /subscription/preview_one_time_charge

### Description
Get a request builder for previewing creating a one-time charge for a subscription without billing that charge. Typically used for previewing calculations before making changes to a subscription.
One-time charges are non-recurring items. These are price entities where the `billing_cycle` is `null`.
If successful, your response includes `immediate_transaction`, `next_transaction`, and `recurring_transaction_details` so you can see expected transactions for the changes.

### Method
POST

### Endpoint
/subscription/preview_one_time_charge

### Parameters
#### Path Parameters
- **subscription_id** (SubscriptionID) - Required - The ID of the subscription to preview a one-time charge for.

#### Request Body
- **price_id** (PriceID) - Required - The ID of the price for the one-time charge.
- **quantity** (integer) - Optional - The quantity of the item for the one-time charge. Defaults to 1 if not provided.
- **effective_from** (EffectiveFrom) - Optional - Specifies when the one-time charge should become effective. Can be `immediately` or `next_billing_period`.

### Response
#### Success Response (200)
- **data** (SubscriptionOneTimeChargePreviewResponse) - Contains details about the previewed one-time charge.

#### Response Example
```json
{
  "data": {
    "immediate_transaction": null,
    "next_transaction": {
      "total_excluding_tax": "5000",
      "tax": "0",
      "total_including_tax": "5000",
      "currency": "USD",
      "items": [
        {
          "name": "One-Time Addon",
          "quantity": 1,
          "price": {
            "unit_price": "5000",
            "max_units": null,
            "currency": "USD",
            "id": "pri_onetime"
          },
          "price_id": "pri_onetime"
        }
      ]
    },
    "recurring_transaction_details": null
  }
}
```
```

--------------------------------

### Get Report Download URL

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Returns a link to download a CSV file for a report. This link is only available for reports that have been processed and are ready for download, and it expires after 3 minutes.

```APIDOC
## GET /api/reports/{report_id}/download

### Description
Provides a temporary URL to download the CSV file for a specific report. The report must be ready for download, and the URL is valid for 3 minutes.

### Method
GET

### Endpoint
/api/reports/{report_id}/download

### Parameters
#### Path Parameters
- **report_id** (PaddleID) - Required - The Paddle ID of the report.

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
use paddle_rust_sdk::Paddle;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();

let res = client.report_download_url("rep_example_id_1").await.unwrap();

dbg!(res.data.url);
```

### Response
#### Success Response (200)
- **data** (TransactionInvoice) - Contains the download URL for the report CSV file.

#### Response Example
```json
{
  "data": {
    "url": "https://paddle.com/reports/rep_example_id_1/download?token=example_token"
  }
}
```
```

--------------------------------

### Update Product Request (Rust)

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Shows how to update an existing product in Paddle by its ID. The example modifies the product's name. Requires an API client instance.

```rust
use paddle_rust_sdk::Paddle;
use paddle_rust_sdk::enums::TaxCategory;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let product = client.product_update("pro_01jqx9rd...").name("My New Name").send().await.unwrap();
```

--------------------------------

### Subscription Get API

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves a specific subscription using its ID. Allows fetching detailed information about a single subscription.

```APIDOC
## GET /subscriptions/{subscription_id}

### Description
Fetches a specific subscription using its ID. Provides detailed information about a single subscription.

### Method
GET

### Endpoint
/subscriptions/{subscription_id}

### Parameters
#### Path Parameters
- **subscription_id** (string) - Required - The ID of the subscription to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let res = client.subscription_get("sub_01hv8y5ehszzq0yv20ttx3166y").send().await.unwrap();
dbg!(res.data);
```

### Response
#### Success Response (200)
- **data** (object) - The subscription object with detailed information.

#### Response Example
```json
{
  "data": {
    "id": "sub_01hv8y5ehszzq0yv20ttx3166y",
    "status": "active",
    "plan_id": "plan_xyz789",
    "customer_id": "ctm_abc123",
    "created_at": "2023-01-01T12:00:00Z"
    // ... other subscription details
  }
}
```
```

--------------------------------

### Get Business Information

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves business information for a given customer and business ID. This is useful for fetching details about a specific business associated with a customer.

```APIDOC
## GET /customers/{customer_id}/businesses/{business_id}

### Description
Retrieves business information for a given customer and business ID.

### Method
GET

### Endpoint
`/customers/{customer_id}/businesses/{business_id}`

### Parameters
#### Path Parameters
- **customer_id** (CustomerID) - Required - The unique identifier for the customer.
- **business_id** (BusinessID) - Required - The unique identifier for the business.

### Request Example
```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let customers = client.business_get("ctm_01jqztc78e1xfdgwhcgjzdrvgd", "biz_01jr85bypq4d3w139m53zw2559").send().await.unwrap();
```

### Response
#### Success Response (200)
- **business_data** (object) - Contains the business details.

#### Response Example
(Example response structure would be detailed here based on the actual API response)
```

--------------------------------

### GET /customers/{customer_id}/businesses/{business_id}

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves a specific business associated with a customer, identified by both customer and business IDs.

```APIDOC
## GET /customers/{customer_id}/businesses/{business_id}

### Description
Fetches a specific business entity associated with a customer, identified by both the customer's unique ID and the business's unique ID.

### Method
GET

### Endpoint
`/customers/{customer_id}/businesses/{business_id}`

### Parameters
#### Path Parameters
- **customer_id** (CustomerID) - Required - The unique identifier of the customer.
- **business_id** (BusinessID) - Required - The unique identifier of the business.

### Request Example
```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let business = client.business_get("ctm_01jqztc78e1xfdgwhcgjzdrvgd", "biz_abcdefg").send().await.unwrap();
```

### Response
#### Success Response (200)
- **data** (object) - The requested business object.
- **meta** (object) - Metadata about the response.

#### Response Example
```json
{
  "data": {
    "id": "biz_abcdefg",
    "customer_id": "ctm_01jqztc78e1xfdgwhcgjzdrvgd",
    "name": "Example Corp",
    "registration_location": "USA",
    "tax_id": "12-3456789",
    "created_at": "2023-01-01T10:00:00Z",
    "status": "active"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
```
```

--------------------------------

### Subscription Preview Update API

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Get a request builder for previewing changes to a subscription without applying them. Useful for understanding proration before making modifications. The response provides details on immediate, next, and recurring transactions, along with an update summary.

```APIDOC
## POST /subscription/preview_update

### Description
Get a request builder for getting a preview of changes to a subscription without actually applying them. Typically used for previewing proration before making changes to a subscription.
If successful, your response includes `immediate_transaction`, `next_transaction`, and `recurring_transaction_details` so you can see expected transactions for the changes.
The `update_summary` object contains details of prorated credits and charges created, along with the overall result of the update.

### Method
POST

### Endpoint
/subscription/preview_update

### Parameters
#### Path Parameters
- **subscription_id** (SubscriptionID) - Required - The ID of the subscription to preview updates for.

#### Query Parameters
- **next_billed_at** (DateTime) - Optional - The next billing date for the subscription.
- **proration_billing_mode** (ProrationBillingMode) - Optional - The billing mode for proration.

### Request Example
```rust
use paddle_rust_sdk::Paddle;
use paddle_rust_sdk::models::proration_billing_mode::ProrationBillingMode;
use chrono::Utc;
use chrono_humanize::Tz;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();

let res = client.subscription_preview_update("sub_01hv8y5ehszzq0yv20ttx3166y")
    .next_billed_at(Utc::now())
    .proration_billing_mode(ProrationBillingMode::ProratedImmediately)
    .send()
    .await
    .unwrap();

dbg!(res.data);
```

### Response
#### Success Response (200)
- **data** (SubscriptionPreviewUpdateResponse) - Contains details about the previewed subscription update.

#### Response Example
```json
{
  "data": {
    "immediate_transaction": null,
    "next_transaction": {
      "total_excluding_tax": "1000",
      "tax": "0",
      "total_including_tax": "1000",
      "currency": "USD",
      "items": [
        {
          "name": "Example Item",
          "quantity": 1,
          "price": {
            "unit_price": "1000",
            "max_units": null,
            "currency": "USD",
            "id": "pri_example"
          },
          "price_id": "pri_example"
        }
      ]
    },
    "recurring_transaction_details": null,
    "update_summary": {
      "original_total": "1000",
      "new_total": "1000",
      "change": "0",
      "credits": "0",
      "charges": "0",
      "proration": "0"
    }
  }
}
```
```

--------------------------------

### Create Adjustment

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Get a request builder for creating an adjustment (refund or credit) for transaction items. Adjustments can be applied to all or part of a transaction's items.

```APIDOC
## POST /api/adjustments

### Description
Creates an adjustment (refund or credit) for one or more transaction items. Refunds return amounts to the customer's original payment method for completed transactions. Credits reduce the amount a customer has to pay for manually-collected transactions that are billed or past due.

### Method
POST

### Endpoint
/api/adjustments

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **transaction_id** (TransactionID) - Required - The Paddle ID of the transaction.
- **action** (AdjustmentAction) - Required - The action to perform (Refund or Credit).
- **reason** (String) - Required - The reason for the adjustment.
- **type** (AdjustmentType) - Optional - The type of adjustment (e.g., Full, Partial).
- **items** (Array<AdjustmentItem>) - Optional - Details of the transaction items to adjust.

### Request Example
```rust
use paddle_rust_sdk::{
    enums::{AdjustmentAction, AdjustmentType},
    Paddle,
};

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();

let res = client.adjustment_create("txn_01jkfx8v9z4pee0p5bd35x95bp", AdjustmentAction::Refund, "Refund reason")
    .r#type(AdjustmentType::Full)
    .send()
    .await
    .unwrap();

dbg!(res.data);
```

### Response
#### Success Response (200)
- **data** (AdjustmentCreateResponse) - Details of the created adjustment request.

#### Response Example
```json
{
  "data": {
    "id": "adj_example_id",
    "transaction_id": "txn_01jkfx8v9z4pee0p5bd35x95bp",
    "action": "refund",
    "amount": "10.00",
    "currency": "USD",
    "status": "pending_approval",
    "reason": "Refund reason",
    "created_at": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### GET /customers/{customer_id}/businesses

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves a list of businesses associated with a customer. Similar to addresses, it defaults to active businesses.

```APIDOC
## GET /customers/{customer_id}/businesses

### Description
Fetches a list of businesses associated with a customer. By default, active businesses are returned. Use the `status` query parameter to retrieve archived businesses.

### Method
GET

### Endpoint
`/customers/{customer_id}/businesses`

### Parameters
#### Path Parameters
- **customer_id** (CustomerID) - Required - The unique identifier of the customer.

#### Query Parameters
- **status** (string) - Optional - Filter businesses by status (e.g., 'active', 'archived').

### Request Example
```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let businesses = client.businesses_list("ctm_01jqztc78e1xfdgwhcgjzdrvgd").send().await.unwrap();
```

### Response
#### Success Response (200)
- **data** (array) - An array of business objects.
- **meta** (object) - Metadata about the response.

#### Response Example
```json
{
  "data": [
    {
      "id": "biz_abcdefg",
      "customer_id": "ctm_01jqztc78e1xfdgwhcgjzdrvgd",
      "name": "Example Corp",
      "created_at": "2023-01-01T10:00:00Z",
      "status": "active"
    }
  ],
  "meta": {
    "request_id": "req_abc123"
  }
}
```
```

--------------------------------

### GET /customers/{customer_id}/addresses/{address_id}

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves a specific address for a customer using both the customer ID and the address ID.

```APIDOC
## GET /customers/{customer_id}/addresses/{address_id}

### Description
Fetches a specific address for a customer, identified by both the customer's unique ID and the address's unique ID.

### Method
GET

### Endpoint
`/customers/{customer_id}/addresses/{address_id}`

### Parameters
#### Path Parameters
- **customer_id** (CustomerID) - Required - The unique identifier of the customer.
- **address_id** (AddressID) - Required - The unique identifier of the address.

### Request Example
```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let address = client.address_get("ctm_01jqztc78e1xfdgwhcgjzdrvgd", "add_01hv8gwdfkw5z6d1yy6pa3xyrz").send().await.unwrap();
```

### Response
#### Success Response (200)
- **data** (object) - The requested address object.
- **meta** (object) - Metadata about the response.

#### Response Example
```json
{
  "data": {
    "id": "add_01hv8gwdfkw5z6d1yy6pa3xyrz",
    "customer_id": "ctm_01jqztc78e1xfdgwhcgjzdrvgd",
    "first_line": "123 Main St",
    "city": "Anytown",
    "postal_code": "12345",
    "country_code": "US",
    "status": "active"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
```
```

--------------------------------

### Get Report Download URL - Rust

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Provides a temporary link to download a CSV file for a report. The link is only available for reports that have been fully processed by Paddle and is valid for 3 minutes.

```rust
pub async fn report_download_url( &self, report_id: impl Into<PaddleID>, ) -> Result<SuccessResponse<TransactionInvoice>, Error>
```

--------------------------------

### Get Report List Builder - Rust

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Obtains a request builder for fetching a single report from Paddle. This function initializes the process of retrieving report data.

```rust
pub fn reports_list<'a>(&'a self) -> ReportsList<'a>
```

--------------------------------

### Rust: Send ProductsList Request and Get Paginator

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/products/struct

Executes the configured ProductsList request and returns a paginator object. This paginator can be used to fetch entities page by page from the Paddle API.

```rust
pub fn send(&self) -> Paginated<'_, Vec<Product>>
```

--------------------------------

### Paddle API Client Initialization and Usage

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/index

Demonstrates how to initialize the Paddle API client and make a basic request to list customers, showcasing pagination.

```APIDOC
## Paddle API Client Initialization and Usage

### Description
Initializes the Paddle API client with an API key and environment (e.g., SANDBOX). Shows an example of listing customers with pagination.

### Method
GET (for listing customers)

### Endpoint
`/customers` (illustrative, actual endpoint depends on SDK implementation)

### Parameters
None directly shown in the example, but API key is required for initialization.

### Request Example
```rust
use paddle_rust_sdk::Paddle;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Paddle::new(std::env::var("PADDLE_API_KEY")?, Paddle::SANDBOX)?;

    let mut list = client.customers_list();
    let mut paginated = list.per_page(2).send();
    let customers = paginated.all().await?;

    dbg!(customers);

    Ok(())
}
```

### Response
#### Success Response (200)
Returns a paginated list of customer objects.

#### Response Example
```json
{
  "data": [
    {
      "id": "cust_123",
      "name": "Example Customer",
      "email": "customer@example.com"
    }
  ],
  "meta": {
    "count": 2,
    "next_cursor": "cursor_abc"
  }
}
```
```

--------------------------------

### Paddle Client Initialization

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Demonstrates how to create a new Paddle client instance for either production or sandbox environments.

```APIDOC
## Paddle Client Initialization

### Description
Creates a new Paddle client instance.

### Method
`new`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
```

### Response
#### Success Response (200)
- `Paddle` - A new Paddle client instance.

#### Response Example
(No explicit response example, returns `Self` on success or `Error` on failure.)
```

--------------------------------

### Get a Customer by ID with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Illustrates how to retrieve a specific customer's details using their ID with the Paddle Rust SDK. Useful for accessing individual customer information.

```rust
use paddle_rust_sdk::Paddle;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let discount = client.customer_get("ctm_01jqztc78e1xfdgwhcgjzdrvgd").send().await.unwrap();
```

--------------------------------

### Create Product Request (Rust)

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Demonstrates how to create a new product in Paddle, specifying its name and tax category. Requires an API client instance.

```rust
use paddle_rust_sdk::Paddle;
use paddle_rust_sdk::enums::TaxCategory;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let product = client.products_create("My Product", TaxCategory::Standard).send().await.unwrap();
```

--------------------------------

### Get Credit Note PDF Link

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Returns a link to a credit note PDF for a given adjustment. Credit note PDFs serve as a record of refunds and credits and expire after one hour.

```APIDOC
## GET /api/adjustments/{adjustment_id}/credit-note

### Description
Retrieves a URL for downloading the credit note PDF associated with a specific adjustment. This PDF acts as a record for refunds or credits issued.

### Method
GET

### Endpoint
/api/adjustments/{adjustment_id}/credit-note

### Parameters
#### Path Parameters
- **adjustment_id** (AdjustmentID) - Required - The Paddle ID of the adjustment.

#### Query Parameters
- **disposition** (Disposition) - Required - How the credit note should be presented (e.g., Inline, Attachment).

#### Request Body
None

### Request Example
```rust
use paddle_rust_sdk::{enums::Disposition, Paddle};

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();

let res = client.adjustment_credit_note("txn_01hv8wptq8987qeep44cyrewp9", Disposition::Inline).await.unwrap();

dbg!(res.data.url)
```

### Response
#### Success Response (200)
- **data** (TransactionInvoice) - Contains the URL to the credit note PDF.

#### Response Example
```json
{
  "data": {
    "url": "https://paddle.com/credit-notes/cn_example_url"
  }
}
```
```

--------------------------------

### Any Trait Implementation

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/enums/enum

Provides functionality to get the TypeId of an object.

```APIDOC
## GET /any

### Description
Gets the `TypeId` of `self`.

### Method
GET

### Endpoint
/any

### Response
#### Success Response (200)
- **TypeId** (object) - The unique identifier for the type of the object.
```

--------------------------------

### Get a Price by ID with Paddle Rust SDK

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Shows how to retrieve a specific price by its ID using the Paddle Rust SDK. This function is useful for fetching existing price configurations.

```rust
use paddle_rust_sdk::Paddle;

let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let price = client.price_get("price_01jqx9rd...").send().await.unwrap();
```

--------------------------------

### List Adjustments (Rust)

Source: https://docs.rs/paddle-rust-sdk/latest/paddle_rust_sdk/struct

Retrieves adjustments from Paddle using a request builder. The builder allows for filtering and pagination of results. An example demonstrates its usage with a new client and sending the request.

```rust
pub fn adjustments_list(&self) -> AdjustmentsList<'_>
```

```rust
use paddle_rust_sdk::Paddle;
let client = Paddle::new("your_api_key", Paddle::SANDBOX).unwrap();
let res = client.adjustments_list().send().await.unwrap();
dbg!(res.data);
```
Tokens:
Raw