Customers: create, retrieve, update, delete, list, and search. See https://docs.stripe.com/api/customers.
Functions
create-customer
fn (request: CreateCustomerRequest): Map
fn (request: CreateCustomerRequest, options: ::stripe::api/RequestOptions | Map): Map
POST /v1/customers - Create a customer. Pass RequestOptions({idempotency_key: ...}) to make a retried signup safe.
Example
::customers ::stripe::customers
customer ::customers/create-customer(::customers/CreateCustomerRequest({
name: "Alice Smith",
email: "alice@example.com",
metadata: {user_id: "42"}
}))
customer.id // => "cus_..."
delete-customer
fn (customer: Str): Map
fn (customer: Str, opts: Map): Map
DELETE /v1/customers/{customer} - Permanently delete a customer. Cancels
any active subscriptions. Returns {id, object: "customer", deleted: true}.
Example
::customers ::stripe::customers
result ::customers/delete-customer("cus_123")
result.deleted
get-customer
fn (customer: Str): Map
fn (customer: Str, params: Map): Map
fn (customer: Str, params: Map, opts: Map): Map
GET /v1/customers/{customer} - Retrieve a customer by ID. Optional
params such as {expand: ["invoice_settings.default_payment_method"]}. A deleted customer comes
back as {id, object: "customer", deleted: true}.
Example
::customers ::stripe::customers
customer ::customers/get-customer("cus_123", {expand: ["invoice_settings.default_payment_method"]})
customer.invoice_settings.default_payment_method.card.last4
// For a connected account
::customers/get-customer("cus_123", {}, {stripe-account: "acct_123"})
list-customers
fn (): Map
fn (request: ListCustomersRequest): Map
fn (request: ListCustomersRequest, opts: Map): Map
GET /v1/customers - List customers, most recent first. Filter by email (exact, case-sensitive match) or created. Paginate with limit (1-100) and starting_after, or use ::stripe::api/list-all("/v1/customers", params) to fetch every page.
Example
::customers ::stripe::customers
page ::customers/list-customers(::customers/ListCustomersRequest({limit: 10}))
page.data // => [{id: "cus_...", ...}, ...]
page.has_more // => true
search-customers
fn (query: Str): Map
fn (query: Str, params: Map): Map
fn (query: Str, params: Map, opts: Map): Map
GET /v1/customers/search - Search customers with Stripe's search query
language, e.g. email:"alice@example.com" or
metadata["user_id"]:"42". Returns {object: "search_result", data, has_more, next_page}; pass next_page back as page in params.
Search results can lag writes by about a minute. See
https://docs.stripe.com/search#query-fields-for-customers.
Example
::customers ::stripe::customers
results ::customers/search-customers(`email:"alice@example.com"`, {limit: 10})
ids map(results.data, %.id)
update-customer
fn (customer: Str, request: UpdateCustomerRequest): Map
fn (customer: Str, request: UpdateCustomerRequest, options: ::stripe::api/RequestOptions | Map): Map
POST /v1/customers/{customer} - Update a customer. Only the fields you
provide are changed. To set the default card for subscriptions and
invoices, pass invoice_settings: {default_payment_method: "pm_..."}.
Example
::customers ::stripe::customers
::customers/update-customer("cus_123", ::customers/UpdateCustomerRequest({
email: "alice@example.com",
invoice_settings: {default_payment_method: "pm_123"}
}))
Types
CreateCustomerRequest
CreateCustomerRequest type {
name: Str?,
email: Str?,
phone: Str?,
description: Str?,
address: Map?,
shipping: Map?,
metadata: Map?,
payment_method: Str?,
invoice_settings: Map?,
tax: Map?,
tax_exempt: Str?,
tax_id_data: Vec<Map>?,
preferred_locales: Vec<Str>?,
test_clock: Str?,
expand: Vec<Str>?
}
ListCustomersRequest
ListCustomersRequest type {
email: Str?,
created: Any?,
limit: Int?,
starting_after: Str?,
ending_before: Str?,
test_clock: Str?,
expand: Vec<Str>?
}
UpdateCustomerRequest
UpdateCustomerRequest type {
name: Str?,
email: Str?,
phone: Str?,
description: Str?,
address: Map?,
shipping: Map?,
metadata: Map?,
default_source: Str?,
invoice_settings: Map?,
tax: Map?,
tax_exempt: Str?,
preferred_locales: Vec<Str>?,
expand: Vec<Str>?
}