SetupIntents: save a customer's payment method for later off-session charges (subscriptions, invoices, usage billing) without charging now, handling authentication up front. See https://docs.stripe.com/api/setup_intents.
Functions
cancel-setup-intent
fn (setup-intent: Str): Map
fn (setup-intent: Str, opts: Map): Map
fn (setup-intent: Str, cancellation-reason: Str): Map
fn (setup-intent: Str, cancellation-reason: Str, opts: Map): Map
POST /v1/setup_intents/{intent}/cancel - Cancel a SetupIntent that
hasn't succeeded. Optional cancellation-reason: "abandoned",
"requested_by_customer", or "duplicate".
Example
::si ::stripe::setup-intents
canceled ::si/cancel-setup-intent("seti_123", "abandoned")
canceled.status
confirm-setup-intent
fn (setup-intent: Str): Map
fn (setup-intent: Str, request: ConfirmSetupIntentRequest): Map
fn (setup-intent: Str, request: ConfirmSetupIntentRequest, options: ::stripe::api/RequestOptions | Map): Map
POST /v1/setup_intents/{intent}/confirm - Confirm a SetupIntent server-side. status becomes "succeeded", or "requires_action" when the customer must authenticate (finish with Stripe.js).
Example
::si ::stripe::setup-intents
done ::si/confirm-setup-intent("seti_...",
::si/ConfirmSetupIntentRequest({payment_method: "pm_card_visa"}))
done.status // => "succeeded"
create-setup-intent
fn (request: CreateSetupIntentRequest): Map
fn (request: CreateSetupIntentRequest, options: ::stripe::api/RequestOptions | Map): Map
POST /v1/setup_intents - Create a SetupIntent. usage is "off_session" (default: charge later without the customer) or "on_session". Hand client_secret to Stripe.js to collect and confirm the payment method, or confirm server-side with a payment_method. On success the payment method is attached to customer.
Example
::si ::stripe::setup-intents
intent ::si/create-setup-intent(::si/CreateSetupIntentRequest({
customer: "cus_...",
automatic_payment_methods: {enabled: true}
}))
intent.client_secret // => "seti_..._secret_..." (pass to Stripe.js)
get-setup-intent
fn (setup-intent: Str): Map
fn (setup-intent: Str, params: Map): Map
fn (setup-intent: Str, params: Map, opts: Map): Map
GET /v1/setup_intents/{intent} - Retrieve a SetupIntent by ID. Optional
params such as {expand: ["payment_method"]}.
Example
::si ::stripe::setup-intents
intent ::si/get-setup-intent("seti_123", {expand: ["payment_method"]})
intent.status
intent.payment_method.card.last4
list-setup-intents
fn (): Map
fn (request: ListSetupIntentsRequest): Map
fn (request: ListSetupIntentsRequest, opts: Map): Map
GET /v1/setup_intents - List SetupIntents. Filter by customer or
payment_method.
Example
::si ::stripe::setup-intents
page ::si/list-setup-intents(::si/ListSetupIntentsRequest({customer: "cus_123", limit: 10}))
statuses map(page.data, %.status)
update-setup-intent
fn (setup-intent: Str, request: UpdateSetupIntentRequest): Map
fn (setup-intent: Str, request: UpdateSetupIntentRequest, options: ::stripe::api/RequestOptions | Map): Map
POST /v1/setup_intents/{intent} - Update a SetupIntent that hasn't been confirmed.
Example
::si ::stripe::setup-intents
::si/update-setup-intent("seti_123", ::si/UpdateSetupIntentRequest({
customer: "cus_123",
metadata: {user_id: "42"}
}))
Types
ConfirmSetupIntentRequest
ConfirmSetupIntentRequest type {
payment_method: Str?,
return_url: Str?,
mandate_data: Map?,
payment_method_options: Map?,
expand: Vec<Str>?
}
CreateSetupIntentRequest
CreateSetupIntentRequest type {
customer: Str?,
payment_method: Str?,
allowed_payment_method_types: Vec<Str>?,
excluded_payment_method_types: Vec<Str>?,
automatic_payment_methods: Map?,
payment_method_options: Map?,
payment_method_configuration: Str?,
usage: Str?,
confirm: Bool?,
return_url: Str?,
mandate_data: Map?,
description: Str?,
metadata: Map?,
on_behalf_of: Str?,
expand: Vec<Str>?
}
ListSetupIntentsRequest
ListSetupIntentsRequest type {
customer: Str?,
payment_method: Str?,
attach_to_self: Bool?,
created: Any?,
limit: Int?,
starting_after: Str?,
ending_before: Str?,
expand: Vec<Str>?
}
UpdateSetupIntentRequest
UpdateSetupIntentRequest type {
customer: Str?,
payment_method: Str?,
allowed_payment_method_types: Vec<Str>?,
excluded_payment_method_types: Vec<Str>?,
payment_method_options: Map?,
payment_method_configuration: Str?,
description: Str?,
metadata: Map?,
expand: Vec<Str>?
}