Expand description
§Polar client library for Rust
[!WARNING] THIS LIBRARY IS IN A VERY EARLY STAGE, PLEASE BE CAREFUL.
§Features
§Checkouts
| Description | Status |
|---|---|
| Create checkout session | ✅ |
| Get checkout session | ✅ |
| List checkout sessions | ✅ |
| Update checkout session | ⏳ |
| Get checkout session from client | ⏳ |
| Update checkout session from client | ⏳ |
| Confirm checkout session from client | ⏳ |
§Subscriptions
| Description | Status |
|---|---|
| Get subscription | ✅ |
| List subscriptions | ✅ |
| Update subscription | ✅ |
| Revoke subscription | ✅ |
§Products
| Description | Status |
|---|---|
| Get product | ✅ |
| List products | ✅ |
| Create product | ✅ |
| Update product | ✅ |
| Update product benefits | ✅ |
§Events
| Description | Status |
|---|---|
| Ingest events | ✅ |
| Get event | ✅ |
| List events | ⏳ |
§Meters
| Description | Status |
|---|---|
| Create meter | ✅ |
| Get meter | ✅ |
| List meters | ✅ |
| Update meter | ✅ |
| Get meter quantities | ✅ |
§Getting started
- Installation
cargo add polar-rs- Example usage
use polar_rs::Polar;
let polar = Polar::new("https://sandbox-api.polar.sh/v1/", "<YOUR ACCESS TOKEN>");Structs§
- Attached
Custom Field - Attached
Custom Field Params - Benefit
- Billing
Address Fields - Checkout
Product - Checkout
Session - Checkout
Session Params - Custom
Field - Custom
Field Option - Custom
Field Properties - Customer
- Customer
Billing Address - Discount
- Event
- Event
Params - List
Checkout Sessions Params - List
Meters Params - List
Products Params - List
Subscriptions Params - Media
- Meter
- Meter
Aggregation - Meter
Filter - Meter
Filter Clause - Meter
Params - Meter
Quantities - Meter
Quantities Params - Meter
Quantity - Page
- Pagination
- Polar
- Price
- Price
Meter - Price
Params - Product
- Product
Params - Subscription
- Subscription
Meter - Subscription
Params - Update
Meter Params - Update
Price Params - Update
Product Params
Enums§
- Amount
Type - Benefit
Type - Billing
Address Field - Checkout
Session Status - Checkout
Sessions Sorting - Custom
Field Type - Customer
Cancellation Reason - Discount
Duration - Discount
Type - Interval
- Meter
Aggregation Func - Meter
Filter Conjunction - Meter
Filter Operator - Meters
Sorting - Payment
Processor - Polar
Error - Price
Type - Products
Sorting - Proration
Behavior - Recurring
Interval - Subscription
Status - Subscriptions
Sorting