0.40.0 (2024-09-26)
0.39.2 (2024-09-24)
- erroneous deref clippy lint (1fcbb29)
0.39.1 (2024-09-03)
- correct docs host and path for API references (539836d)
0.39.0 (2024-08-31)
post
->post_form
(bc39260)- Move
promotion_code_ext
toproducts
feature (32435f3) - Re-export (24f1782)
- Create promotion code (0fde9eb)
0.38.1 (2024-08-06)
0.38.0 (2024-07-31)
0.37.3 (2024-07-29)
- linting issue for Rust 1.80 (9232213)
0.37.2 (2024-07-23)
- rtx id prefix (67ea232)
0.37.1 (2024-05-24)
0.37.0 (2024-04-30)
- customer-ext,PM query: type field is optional (362659e)
- setup_intent: add mandate_data for confirm (51e34d6)
- setup_intent: verify microdeposits flow (15b3663)
0.36.0 (2024-04-30)
- Add
retrieve_line_items
function forCheckoutSession
(5c74b3b)
0.35.3 (2024-04-26)
- Clippy append instead of extend (1a85b9b)
- Clippy explicit ToString implementation (15250a9)
- Clippy panic warnings (552aff2)
- Clippys from generated code (89cce5b)
- More clippy warnings (6de23bb)
- Remove useless reference that causes clippy warnings (2fca98b)
0.35.2 (2024-04-26)
- Clippy warnings (842bce6)
- Implement workaround for ace in the verify-codegen action (79c1f6f)
- Semantic release needs minimal rust version (642ea31)
0.35.1 (2024-04-26)
0.35.0 (2024-04-04)
- add products to features list in cargo.toml and export from resourses (d26860f)
- export SearchList (a427943)
- Remove "Some()" from RequestError's display (e609cad)
- rename redirect_url to return_url on ConfirmSetupIntent (9da5a28), closes #504
- webhook_events: support construct_event with timestamp (88fe501)
0.34.2 (2024-02-21)
- correctly generate types for optional lists (63732cc)
0.34.1 (2024-02-15)
- fixes an issue with missing renames of Self_ (9c58038)
0.34.0 (2024-02-15)
- generate latest changes from OpenApi spec (a3b0e4d)
0.33.1 (2024-02-08)
- expose the
auto_advance
field from theFinalizeInvoiceParams
struct (ae1a807)
0.33.0 (2024-02-02)
- support pdp_ as an id prefix for dispute objects (be506d6)
- generate latest changes from OpenApi spec (29a457d)
0.32.0 (2024-01-27)
- generate latest changes from OpenApi spec (19ac377)
0.31.2 (2024-01-24)
- currency: add BYN and MMK to currency list (03cddce)
0.31.1 (2024-01-24)
- pagination: prevent infinite loop caused by clone (bc20bd4)
0.31.0 (2024-01-24)
- generate latest changes from OpenApi spec (9b3a844)
0.30.1 (2024-01-24)
- codegen: generate terminal resource objects (bf7e117)
0.30.0 (2024-01-24)
- generate latest changes from OpenApi spec (d0cbc71)
0.29.0 (2024-01-10)
- generate latest changes from OpenApi spec (32e802e)
0.28.1 (2024-01-10)
- add plan prefix to PriceId (6655058)
0.28.0 (2023-12-08)
- generate latest changes from OpenApi spec (4c25649)
0.27.0 (2023-12-01)
- add support for atxi id prefix (414d534)
0.26.0 (2023-10-31)
- fixed bool value (c752f52)
- fixed bool value (153d63d)
- fixed mutability (86aabdd)
- fixed mutability (5ad76c5)
- fixed warnings (30f0a1e)
- fixed warnings (e0d0bd8)
- updated ListPaginator to be generic over type T where T impl PaginableList instead of having separate SearchListPaginator and ListPaginator implementations for types SearchList and List. (9d49602)
- updated ListPaginator to be generic over type T where T impl PaginableList instead of having separate SearchListPaginator and ListPaginator implementations for types SearchList and List. (411f82c)
0.25.2 (2023-10-05)
- prevent panic on StatusCode conversion (9b94228)
0.25.1 (2023-09-27)
- respect the required and optional fields for EventType and Metadata (cdabd2e)
0.25.0 (2023-09-25)
- generate latest changes from OpenApi spec (652a360)
0.24.0 (2023-09-21)
- Generate latest changes from OpenApi spec (7421960)
- Generate latest changes from OpenApi spec (2fedb71)
0.23.0 (2023-09-06)
- add support for connect tokens (b7c5489)
- add tax calculation api behind a feature (2266ed1)
- handle currency_options (1bb8165)
0.22.2 (2023-05-11)
- Add sis_ id prefix for usage record summaries (1042493)
0.22.1 (2023-05-09)
- Move feature check to
build.rs
(8d06be0)
0.22.0 (2023-04-18)
- generate latest changes from OpenApi spec (a76703c)
0.21.0 (2023-04-06)
- use codegen version of WebhookEvent rather than overriding manually (8347a6d)
0.20.2 (2023-04-05)
- generate api version from the codegen (3006688)
0.20.1 (2023-03-23)
- Use
HashMap::from
(0c8dc9d)
0.20.0 (2023-03-09)
- Implement Balance retrieve (7509c98)
0.19.0 (2023-03-05)
- add CreditNote and CustomerBalanceTransaction (dc82e59)
0.18.4 (2023-03-05)
- add missing prefix for CheckoutSessionItemId (c6bdb57)
0.18.3 (2023-02-20)
- reexport duplicate SubscriptionPaymentBehaviour (dbcff41)
0.18.2 (2023-02-04)
- prevent publishing the benchmark crate (e4be54d)
0.18.1 (2023-02-04)
- prevent publishing the openapi crate (6de846e)
0.18.0 (2023-02-04)
- fn to expire checkout sessions (0368c79)
0.17.0 (2023-02-01)
- improve api doc code to fix / add more coverage (fecaa2e)
0.16.0 (2023-01-17)
- prevent freeze when hitting network errors in a retry strategy (d423be2)
- add support for webpki (alt. to native-certs) (c994b1c)
0.15.2 (2023-01-17)
- add automated release config (ac5a87a)
This is a half-release before we overhaul the codegen in 0.16. I want to give a special shoutout to @mzeitlin11 who has been doing some excellent work behind the scenes cleaning up the codegen.
- add a number of missing ids to
ids.rs
- add a number of missing prefixes to
ids.rs
- restore
serde_path_to_error
to give better error messages when parsing responses from the API - add api to retrieve checkout session
- add api to cancel a setup intent
- export the
generated
modules so that overlapping apis can be reached by their path - handle the
idempotency_error
error variant - allow blocking client to be used in a multithreaded scenario
- disable connection pooling to prevent API errors
This release comes with some improvements to list traversal as well as dramatic expansion of the api surface when dealing with webhooks!
- BREAKING: list methods now only borrow their parameters
- Add a streaming api for lazily and ergonomically traversing lists
- Exported the stripe terminal APIs
- Significantly more webhook types now available
- List traversals now properly include parameters when fetching later list items
This release is a minor patch release to fix an oversight in the API.
- Expose the request strategy API
This release has been focused on refining the ergonomics supporting additional stripe APIs, and adding retries / idempotency.
- BREAKING: fluent client config api.
- Add the
card
param to the codegen. (@erichCompSci) - Derive
Default
across the codebase. - Opt-in idempotency functionality. (@erichCompSci)
- Opt-in retry logic.
In addition we have expanded the test coverage, and will continue to do so with more examples.
First release of async-stripe with swappable runtimes.
- You will now need to select a runtime to use the library.
- There may be small breaks in other places in the api.
- Fix failing
Invoice::upcoming
by adding ais_none
representation to InvoiceId (@bryanburgers)
- Enable RustTLS behind a feature flag (@kiljacken)
- Add missing values to
PaymentMethodType
andPaymentIntentMethodType
(@ThouCheese)
- Fixed deserialization of
ChargeId
s withpy_
prefix inPaymentIntent
event(s).
-
Updated to a newer version of the Stripe API.
-
The
PaymentIntent<___>Params
structs have been renamed to be consistent with the autogenerated APIe.g.
PaymentIntentCreateParams
has becomeCreatePaymentIntent
- The
app-info
header can now be set/customized with theClient::set_app_info
method.
-
New feature flags have been introduced to disable unused parts of the stripe APIs. This helps reduce binary bloat and compile time.
-
The async client has been updated to use
std::future::Future
. Theasync
feature flag is deprecated. Prefer{ default-features = false, features = ["full"] }
instead. -
Set default stripe api version to the latest version supported by the library. This is intended to avoid bugs where a later version of stripe is enabled by a customer.
By default the full
stripe api is enabled.
To reduce code size, disable default features and enable just the APIs you use:
# Example: Core-only (enough to create a `Charge` or `Card` or `Customer`)
stripe-rust = { version = "*", default-features = false, features = ["blocking"] }
# Example: Support for "Subscriptions" and "Invoices"
stripe-rust = { version = "*", default-features = false, features = ["blocking", "billing"] }
Refer to the Stripe API docs to determine which APIs are included as part of each feature flag.
- The
stripe-version
header can now be set/customized with theClient::with_headers
method.
- The
Default
trait is now derived for all structs that have only defaultable parameters. Webhook::construct_event
takes payload, signature, and secret args by ref (&str
) instead of value.- The
payment_method
andconfirmation_method
fields were added toPaymentIntentCreateParams
. - The
payment_method_details
structure now supports thecard
data field.
- Boolean fields that may be
null
, are nowOption
instead ofserde(default)
. - The
Customer
variant was added to theEventObject
enum. - The
PaymentIntentCaptureParams
are now correctlypub
. - Fixed parsing a negative customer
account_balance
.
- The
PaymentSourceParams
struct was edit to only include aTokenId
andSourceId
as per improvements to the API. - The
charge.source
field to create aCharge
was fixed to accept the new structChargeSourceParams
.
- Added
id
field toEvent
- Fixes a regression deriving
Eq
andPartialEq
forPaymentIntent
enums.
- Fixed deserialization of
CheckoutSessionCompleted
events. - Added missing
Invoice
events.
- Fixed the
InvoiceLineItemId
type to correctly handle subscription items.
This version uses code generation to generate the stripe API according to the openapi spec.
This contains major breaking changes from previous versions, both because many structures were out of date and because some changes were made to make things easier to generate.
-
Many new APIs have now been implemented (mostly CRUD); some requests are still missing because not all requests are automatically implemented. All previously implemented requests are still implemented (even if they couldn't be code-generated).
-
Many requests now take the
expand
parameter which controls whether more data should be returned forExpandable<T>
fields. Previously these fields were just id types.
- Fields and requests have descriptive documentation rather than just referring to the stripe API docs.
- Ids and fields are more strictly typed (newtypes vs raw strings).
- Ids no longer need to be allocated and are cheaply clonable (in almost all cases).
- Enum types now implement
Display
andAsRef<str>
.
- Add missing
product
toPlan
. - Add missing
receipt_url
toCharge
. - The deprecated
closed
field inInvoice
is now optional. - Fix allowing the
description
field inPayout
to be optional. - Fix allowing a
SubscriptionItem
quantity to beNone
(e.g. when using metered pricing API). - Fix signature checking for received Webhooks.
- Allow the timestamp to be manually specified when verifying webhook signature.
- Detach source data structure is a new
DetachedSource
enum - The
object
field was removed fromPaymentIntent
,Refund
andPayout
. - Fields in
PaymentIntent
were updated to correctly be optional
- Added an
async
feature flag which removesstripe::Client
and addsstripe::async::Client
.
- The
stripe::Params
typed was renamed toHeaders
to avoid confusion with otherFooParams
types and theparams
module.
- Added
verify_bank_account
toCustomer
resource. - Added BankAccount as a variant of
PaymentSource
. - Add the PaymentIntents resources, apis and events.
- Minimum Rust version required is 1.31.1.
- Moved
retrieve_source
anddetach_source
toCustomer
resource fromSource
. - The
Error::Conversion
enum variant has been replaced byError::Serialize
andError::Deserialize
. - See also Fixes / Improvements.
- TokenId has become an enum to account for different Token options
- Updated fields on
BankAccount
resource so all are correct. - The
Payout
andRefund
types now use enums instead of Strings. - The
WebhookError
type is now externally public.
- Fix sending
metadata
(and other nested params) as part of a POST request; e.g.Customer::create
,Customer::update
, etc.
- The type of
Customer.default_source
has changed fromSourceId
toPaymentSourceId
. - The type of
Customer.sources
has changed fromList<Source>
toList<PaymentSource>
.
- The
List<T>
type has newnext
andget_all
methods for pagination. - Struct types more consistently implement
Clone
. - Enum types more consistently implement
Copy
,Eq
, andHash
. - More source details (e.g.
ach_credit_transfer
, etc) were added toSource
. - The blocking api is now backed by
reqwest
instead ofhyper:0.10
so that the library is no longer pinned to outdated dependencies. - Added the "webhooks" feature flag for processing events (enabled by default)
to convert
hmac
andsha2
to optional dependencies.
- (Mostly from 0.5.x series)
Charge
,Card
, andSource
have been updated to use new enum values rather thanString
. - The
SourceType
enum used by ChargeListParams has been renamed toSourceFilterType
to remove a conflict with theSourceType
enum used by the type field of Source.
- All
Address
fields have been updated to be optional. - The
Client-Id
param has been added to params to make support for impersonating Connect Accounts compatible with newer stripe api versions.
- Updated
Charge
to use enum types rather than&str
where possible.
- Fixed many issues with the
Source
object. - Updated
Card
to use enum types rather than&str
where possible. - Added many new fields to
Card
.
- Bumped dependency versions
- Implemented the sources resource and
added the
Source
type .
- The
CustomerSourceParams
struct was renamed toPaymentSourceParams
. - The
Source
enum was renamed toPaymentSource
(there is a newSource
struct). - Source and token fields (like
token: &str
) now usesource: SourceId
ortoken: TokenId
instead.
- Added missing
default_source
field toCustomer
. - The
Deserialize
andSerialize
traits have now been implemented for all param and resource structs. - The
Copy
,Clone
,Eq
,PartialEq
, andHash
traits have been derived for flat enum types.
- Fix, adds all missing error code variants to
stripe::error::ErrorCode
.
- Fixed field
nickname
ofPlan
can be null.
- Fixed field
nickname
ofPlan
should bename
- The
balance_transaction
field ofCharge
is nowOption<_>
.
- Added basic crate documentation
- Added the
invoice.upcoming
event
- Add RangeQuery struct for created/date filters in list requests
- Implement
Customer::list
request (ie. "GET /customers"); Thanks @pocket7878 - Add missing params to
InvoiceListParams
forInvoice::list
- Upgrade Serde to v1.0
- Add support for authentication using the Stripe-Account header
- Implement
Event
struct for implementing a Stripe Webhook (only some events) - Implement
Invoice::update
request (ie. POST "/invoices/{invoice_id}") - Implement
InvoiceItem::create
request (ie. POST "/invoiceitems") - Fix
Subscription::cancel
request (previously used wrong method/path)
- Implemented the
Invoice::list
API (ie. "/invoices") - Fixed a request encoding error for
Invoice::pay
(ie. "/invoices/{invoice_id}/pay") - Fixed fields on
Subscription
that could be null but were missingOptional<..>
- Added missing
last4
field toCard
resource - Changed the repository URL
- Made rust docs slightly easier to read
- Fixed incorrect method name for
Plan
resource - Use
native-tls
by default and add feature-flag supportingopenssl
- Implemented the charges resource and
added the
Charge
type.
- The
Resource::get
requests have been renamed toResource::retrieve
. - The
Subscription::cancel
request now expectsCancelParams
instead of expecting a one-off function argument. - Removed the
blame
method andBlame
type from errors. - The
Error::Decode
andError::Encode
variants have been combined into a singleError::Conversion
variant.
- The
Error
type now has easier to read error messages and will parses JSON errors returned by Stripe into a structured error type (RequestError
). - Added Travis CI for automated testing on GitHub.
- Added reference documentation to implemented resources (but still no docs at crate/module level nor a "Getting started" guide)
- Added
Client
which is created once with a stripe private key and is intended to be re-used for multiple requests. It implementsSync
so you can share it among multiple threads. - Added new strongly-typed
Currency
type following the example of https://github.com/stripe/stripe-go. Customer::create
/CustomerParams
now support usingCardParams
as a source instead of just tokens.- Implemented the sources API in the
Source
type.
- All
Params
types now use&str
fields instead ofString
s. - Requests used to require a
stripe_key: &str
as their final argument but now use a&Client
as the first argument instead. - Stripe tokens used to be directly used as a source in
CustomerParams
but now must be used withCustomerSourceParams::Token("tok_xyzABC123")
.
- Added remaining fields to
Params
types after switching fromserde_urlencoded
toserde_qs
to support nested params. - Added the
create_customer
example - Types that implement
Deserialize
now also implementDebug
. - Types that implement
Serialize
now also implementDefault
.