Connect AI agents to Stripe

currencystring

The currency to preview this invoice in. Defaults to the customer's currency if not specified.

customerstring

The ID of the customer whose upcoming invoice you're previewing.

expandarray

List of fields to expand in the response.

invoice_itemsarray

List of ad-hoc invoice items to add to the preview (up to 250).

preview_modestring

Whether to preview only the next invoice, or a full recurring schedule. Defaults to 'next'.one of nextrecurring

subscriptionstring

The ID of the subscription to preview, e.g. to preview the effect of a plan change.

subscription_detailsobject

Overrides used to preview a subscription update, such as new items or a proration date.

This tool takes no inputs.

accountstringrequired

The ID of the connected account.

personstringrequired

The ID of the person to retrieve.

expandarray

List of fields to expand in the response.

This tool takes no inputs.

idstringrequired

The ID of the balance transaction to retrieve.

charge_idstringrequired

The ID of the charge to retrieve.

expandarray

List of fields to expand in the response.

sessionstringrequired

The ID of the Checkout Session to retrieve.

session_idstringrequired

The ID of the Checkout Session.

ending_beforestring

Line item ID to end pagination before.

expandarray

List of fields to expand in the response.

limitinteger

Number of line items to return (1-100, default 10).

starting_afterstring

Line item ID to start pagination after.

accountstringrequired

The ID of the connected account to retrieve.

expandarray

List of fields to expand in the response.

couponstringrequired

The ID of the coupon to retrieve.

customer_idstringrequired

The ID of the customer to retrieve

expandarray

List of fields to expand in the response.

customer_idstringrequired

The ID of the customer the payment method is attached to.

payment_method_idstringrequired

The ID of the payment method to retrieve.

expandarray

List of fields to expand in the response.

customer_idstringrequired

The ID of the customer the tax ID belongs to.

tax_idstringrequired

The ID of the tax ID object to retrieve.

expandarray

List of fields to expand in the response.

disputestringrequired

The ID of the dispute to retrieve.

idstringrequired

The ID of the event to retrieve.

invoice_idstringrequired

The ID of the invoice to retrieve

expandarray

List of fields to expand in the response.

invoice_item_idstringrequired

The ID of the invoice item to retrieve

expandarray

List of fields to expand in the response.

payment_intent_idstringrequired

The ID of the PaymentIntent to retrieve.

expandarray

List of fields to expand in the response.

idstringrequired

The ID of the PaymentMethod to retrieve.

payoutstringrequired

The ID of the payout to retrieve.

planstringrequired

The ID of the plan to retrieve.

price_idstringrequired

The ID of the price to retrieve.

expandarray

List of fields to expand in the response.

product_idstringrequired

The ID of the product to retrieve

expandarray

List of fields to expand in the response.

promotion_codestringrequired

The ID of the promotion code to retrieve.

quotestringrequired

The ID of the quote to retrieve.

idstringrequired

The ID of the refund to retrieve.

setup_intent_idstringrequired

The ID of the SetupIntent to retrieve.

subscription_idstringrequired

The ID of the subscription to retrieve

expandarray

List of fields to expand in the response.

subscription_item_idstringrequired

The ID of the subscription item to retrieve

expandarray

List of fields to expand in the response.

subscription_schedule_idstringrequired

The ID of the subscription schedule to retrieve.

expandarray

List of fields to expand in the response.

tax_ratestringrequired

The ID of the tax rate to retrieve.

transferstringrequired

The ID of the transfer to retrieve.

reversal_idstringrequired

The ID of the reversal to retrieve.

transfer_idstringrequired

The ID of the transfer the reversal belongs to.

expandarray

List of fields to expand in the response.

webhook_endpointstringrequired

The ID of the webhook endpoint to retrieve.

accountstringrequired

The ID of the connected account.

expandarray

List of fields to expand in the response.

accountstringrequired

The ID of the connected account.

ending_beforestring

External account ID to end pagination before.

expandarray

List of fields to expand in the response.

limitinteger

Number of external accounts to return (1-100, default 10).

objectstring

Filter external accounts by object type.one of bank_accountcard

starting_afterstring

External account ID to start pagination after.

accountstringrequired

The ID of the connected account.

ending_beforestring

Person ID to end pagination before.

expandarray

List of fields to expand in the response.

limitinteger

Number of persons to return (1-100, default 10).

relationshipobject

Filter people by their relationship to the account's company (e.g. representative, owner, director, executive).

starting_afterstring

Person ID to start pagination after.

ending_beforestring

Cursor for pagination: return results before this account ID.

limitinteger

Maximum number of accounts to return (1–100).

starting_afterstring

Cursor for pagination: return results after this account ID.

chargestring

Only return application fees for the charge specified by this charge ID.

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

ending_beforestring

Application fee ID to end pagination before.

expandarray

List of fields to expand in the response.

limitinteger

Number of application fees to return (1-100, default 10).

starting_afterstring

Application fee ID to start pagination after.

currencystring

Filter by three-letter ISO currency code.

ending_beforestring

Balance transaction ID to end pagination before.

limitinteger

Number of transactions to return (1-100, default 10).

sourcestring

Filter by source object ID (charge or payout ID).

starting_afterstring

Balance transaction ID to start pagination after.

typestring

Filter by transaction type.one of chargerefundadjustmentpayoutpayout_failurestripe_feenetwork_costpaymentpayment_refundtransfertransfer_canceltransfer_failure

activeboolean

Only return configurations that are active (true) or inactive (false).

ending_beforestring

Configuration ID to end pagination before.

expandarray

List of fields to expand in the response.

is_defaultboolean

Only return the default (true) or non-default (false) configuration.

limitinteger

Number of configurations to return (1-100, default 10).

starting_afterstring

Configuration ID to start pagination after.

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

customerstring

Filter charges by customer ID

ending_beforestring

Charge ID to end pagination before

limitinteger

Number of charges to return (1-100, default 10)

payment_intentstring

Filter charges by PaymentIntent ID

starting_afterstring

Charge ID to start pagination after

customerstring

Filter sessions by customer ID.

ending_beforestring

Cursor for pagination. Returns sessions before this ID.

limitinteger

Maximum number of sessions to return (1-100).

payment_intentstring

Filter sessions by payment intent ID.

starting_afterstring

Cursor for pagination. Returns sessions after this ID.

subscriptionstring

Filter sessions by subscription ID.

ending_beforestring

Cursor for pagination. Returns results before this coupon ID.

limitinteger

Maximum number of coupons to return (1–100).

starting_afterstring

Cursor for pagination. Returns results after this coupon ID.

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

customerstring

Only return credit notes for the customer specified by this customer ID.

ending_beforestring

Credit note ID to end pagination before.

expandarray

List of fields to expand in the response.

invoicestring

Only return credit notes for the invoice specified by this invoice ID.

limitinteger

Number of credit notes to return (1-100, default 10).

starting_afterstring

Credit note ID to start pagination after.

customer_idstringrequired

The ID of the customer whose balance transactions you want to list.

ending_beforestring

Balance transaction ID to end pagination before.

expandarray

List of fields to expand in the response.

limitinteger

Number of balance transactions to return (1-100, default 10).

starting_afterstring

Balance transaction ID to start pagination after.

customerstringrequired

The ID of the customer whose payment methods to list.

ending_beforestring

Cursor for pagination — return results before this payment method ID.

limitinteger

Maximum number of payment methods to return.

starting_afterstring

Cursor for pagination — return results after this payment method ID.

typestring

Filter payment methods by type.one of acss_debitaffirmafterpay_clearpayalipayau_becs_debitbacs_debitbancontactblikboletocardcashappcustomer_balanceepsfpxgiropaygrabpayidealklarnakonbinilinkmobilepayoxxop24paynowpaypalpixpromptpaysepa_debitsofortswishus_bank_accountwechat_payzip

customer_idstringrequired

The ID of the customer whose tax IDs you want to list.

ending_beforestring

Tax ID to end pagination before.

expandarray

List of fields to expand in the response.

limitinteger

Number of tax IDs to return (1-100, default 10).

starting_afterstring

Tax ID to start pagination after.

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

emailstring

Filter customers by exact email address

ending_beforestring

Customer ID to end pagination before

expandarray

List of fields to expand in the response.

limitinteger

Number of customers to return (1-100, default 10)

starting_afterstring

Customer ID to start pagination after

chargestring

Filter disputes by charge ID.

ending_beforestring

Cursor for pagination: return disputes before this dispute ID.

limitinteger

Maximum number of disputes to return (1-100).

payment_intentstring

Filter disputes by payment intent ID.

starting_afterstring

Cursor for pagination: return disputes after this dispute ID.

ending_beforestring

Cursor for pagination: return events before this event ID.

limitinteger

Maximum number of events to return (1-100).

starting_afterstring

Cursor for pagination: return events after this event ID.

typestring

Filter events by type, e.g. payment_intent.created.

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

customerstring

Filter invoice items by customer ID

ending_beforestring

Invoice item ID to end pagination before

expandarray

List of fields to expand in the response.

invoicestring

Filter invoice items by invoice ID

limitinteger

Number of invoice items to return (1-100, default 10)

pendingboolean

Filter by pending status

starting_afterstring

Invoice item ID to start pagination after

invoice_idstringrequired

The ID of the invoice to list line items for

ending_beforestring

Line item ID to end pagination before

expandarray

List of fields to expand in the response.

limitinteger

Number of line items to return (1-100, default 10)

starting_afterstring

Line item ID to start pagination after

collection_methodstring

Filter invoices by collection methodone of charge_automaticallysend_invoice

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

customerstring

Filter invoices by customer ID

ending_beforestring

Invoice ID to end pagination before

expandarray

List of fields to expand in the response.

limitinteger

Number of invoices to return (1-100, default 10)

starting_afterstring

Invoice ID to start pagination after

statusstring

Filter invoices by statusone of draftopenpaiduncollectiblevoid

subscriptionstring

Filter invoices by subscription ID

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

customerstring

Filter PaymentIntents by customer ID

ending_beforestring

PaymentIntent ID to end pagination before

limitinteger

Number of results to return (1-100, default 10)

starting_afterstring

PaymentIntent ID to start pagination after

customerstring

The ID of the customer whose payment methods to list.

ending_beforestring

Cursor for pagination; returns results before this PaymentMethod ID.

limitinteger

Number of results to return (1–100).

starting_afterstring

Cursor for pagination; returns results after this PaymentMethod ID.

typestring

Filter by payment method type.one of acss_debitaffirmafterpay_clearpayalipayau_becs_debitbacs_debitbancontactblikboletocardcashappcustomer_balanceepsfpxgiropaygrabpayidealklarnakonbinilinkoxxop24paynowpaypalpixpromptpayrevolut_paysepa_debitsofortswishus_bank_accountwechat_payzip

arrival_dateinteger

Filter by arrival date (Unix timestamp).

destinationstring

Filter by destination bank account or card ID.

ending_beforestring

Payout ID to end pagination before.

limitinteger

Number of payouts to return (1-100, default 10).

starting_afterstring

Payout ID to start pagination after.

statusstring

Filter by payout status.one of paidpendingin_transitcanceledfailed

activeboolean

Filter plans by active status. Pass true to list only active plans.

ending_beforestring

Cursor for pagination: return results before this plan ID.

limitinteger

Maximum number of plans to return (1–100).

productstring

Filter plans by product ID.

starting_afterstring

Cursor for pagination: return results after this plan ID.

activeboolean

Only return prices that are active or inactive.

currencystring

Only return prices for the given currency.

ending_beforestring

Price ID to end pagination before

limitinteger

Number of prices to return (1-100, default 10)

productstring

Only return prices for the given product.

starting_afterstring

Price ID to start pagination after

typestring

Only return prices of this type.one of one_timerecurring

activeboolean

Filter products by active status

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

ending_beforestring

Product ID to end pagination before

expandarray

List of fields to expand in the response.

limitinteger

Number of products to return (1-100, default 10)

shippableboolean

Filter products by shippable status

starting_afterstring

Product ID to start pagination after

typestring

Filter products by typeone of goodservice

urlstring

Filter products by URL

activeboolean

Filter by active status. True returns only active codes, false returns only inactive.

codestring

Filter by the exact customer-facing code string.

couponstring

Filter by the coupon ID the promotion codes belong to.

customerstring

Filter by the customer ID the promotion codes are restricted to.

ending_beforestring

Cursor for reverse pagination. Returns results before this promotion code ID.

limitinteger

Maximum number of promotion codes to return (1–100).

starting_afterstring

Cursor for forward pagination. Returns results after this promotion code ID.

customerstring

Filter quotes by customer ID.

ending_beforestring

Cursor for pagination — return results before this quote ID.

limitinteger

Maximum number of quotes to return.

starting_afterstring

Cursor for pagination — return results after this quote ID.

statusstring

Filter quotes by status.one of draftopenacceptedcanceled

chargestring

Filter refunds by the charge ID.

ending_beforestring

A cursor for pagination. Returns objects before this refund ID.

limitinteger

A limit on the number of objects to be returned, between 1 and 100.

payment_intentstring

Filter refunds by the PaymentIntent ID.

starting_afterstring

A cursor for pagination. Returns objects after this refund ID.

customerstring

Filter by customer ID.

ending_beforestring

A cursor for pagination. Returns objects before this ID.

limitinteger

Maximum number of objects to return (1–100).

payment_methodstring

Filter by payment method ID.

starting_afterstring

A cursor for pagination. Returns objects after this ID.

subscriptionstringrequired

The ID of the subscription to list items for

ending_beforestring

Subscription item ID to end pagination before

expandarray

List of fields to expand in the response.

limitinteger

Number of subscription items to return (1-100, default 10)

starting_afterstring

Subscription item ID to start pagination after

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

customerstring

Only return subscription schedules for the given customer.

ending_beforestring

Subscription schedule ID to end pagination before.

expandarray

List of fields to expand in the response.

limitinteger

Number of subscription schedules to return (1-100, default 10).

scheduledboolean

Only return subscription schedules that have not started yet.

starting_afterstring

Subscription schedule ID to start pagination after.

createdinteger

Filter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtinteger

Filter by creation date, strictly after this Unix timestamp.

created_gteinteger

Filter by creation date, at or after this Unix timestamp.

created_ltinteger

Filter by creation date, strictly before this Unix timestamp.

created_lteinteger

Filter by creation date, at or before this Unix timestamp.

customerstring

Filter subscriptions by customer ID

ending_beforestring

Subscription ID to end pagination before

expandarray

List of fields to expand in the response.

limitinteger

Number of subscriptions to return (1-100, default 10)

pricestring

Filter subscriptions by price ID

starting_afterstring

Subscription ID to start pagination after

statusstring

Filter subscriptions by statusone of activecanceledincompleteincomplete_expiredpast_duetrialingunpaid

activeboolean

Filter to only return active or inactive tax rates.

ending_beforestring

A cursor for pagination. Returns objects before this ID.

inclusiveboolean

Filter to return only inclusive or exclusive tax rates.

limitinteger

Maximum number of objects to return (1–100).

starting_afterstring

A cursor for pagination. Returns objects after this ID.

transfer_idstringrequired

The ID of the transfer whose reversals you want to list.

ending_beforestring

Reversal ID to end pagination before.

expandarray

List of fields to expand in the response.

limitinteger

Number of reversals to return (1-100, default 10).

starting_afterstring

Reversal ID to start pagination after.

destinationstring

Filter transfers by the connected account ID they were sent to.

ending_beforestring

Cursor for pagination: return results before this transfer ID.

limitinteger

Maximum number of transfers to return (1–100).

starting_afterstring

Cursor for pagination: return results after this transfer ID.

ending_beforestring

Cursor for pagination: return endpoints before this webhook endpoint ID.

limitinteger

Maximum number of webhook endpoints to return (1-100).

starting_afterstring

Cursor for pagination: return endpoints after this webhook endpoint ID.

querystringrequired

The search query string using Stripe's Search Query Language.

limitinteger

Number of results to return (1-100, default 10).

pagestring

Cursor for pagination across multiple pages of search results.

querystringrequired

The search query string using Stripe's Search Query Language.

limitinteger

Number of results to return (1-100, default 10).

pagestring

Cursor for pagination across multiple pages of search results.

querystringrequired

The search query string using Stripe's Search Query Language.

limitinteger

Number of results to return (1-100, default 10).

pagestring

Cursor for pagination across multiple pages of search results.

querystringrequired

The search query string using Stripe's Search Query Language.

limitinteger

Number of results to return (1-100, default 10).

pagestring

Cursor for pagination across multiple pages of search results.

querystringrequired

The search query string using Stripe's Search Query Language.

limitinteger

Number of results to return (1-100, default 10).

pagestring

Cursor for pagination across multiple pages of search results.

querystringrequired

The search query string using Stripe's Search Query Language.

limitinteger

Number of results to return (1-100, default 10).

pagestring

Cursor for pagination across multiple pages of search results.

querystringrequired

The search query string using Stripe's Search Query Language.

limitinteger

Number of results to return (1-100, default 10).

pagestring

Cursor for pagination across multiple pages of search results.

quotestringrequired

The ID of the quote to accept.

invoice_idstringrequired

The ID of the invoice to attach the payment to.

expandarray

List of fields to expand in the response.

payment_intentstring

The ID of the PaymentIntent to attach to the invoice.

customerstringrequired

The ID of the customer to attach the PaymentMethod to.

idstringrequired

The ID of the PaymentMethod to attach.

payoutstringrequired

The ID of the payout to cancel.

quotestringrequired

The ID of the quote to cancel.

refund_idstringrequired

The ID of the refund to cancel.

expandarray

List of fields to expand in the response.

charge_idstringrequired

The ID of the uncaptured charge to capture.

amountinteger

The amount to capture, which must be less than or equal to the original charge amount.

expandarray

List of fields to expand in the response.

receipt_emailstring

The email address to send the receipt to, overriding any previously-specified email.

statement_descriptorstring

Text that appears on the customer's statement as the statement descriptor for a non-card charge.

payment_intent_idstringrequired

The ID of the PaymentIntent to confirm.

payment_methodstring

ID of the payment method to confirm with.

return_urlstring

The URL to redirect the customer to after payment completion.

setup_intent_idstringrequired

The ID of the SetupIntent to confirm.

payment_methodstring

ID of the payment method to attach to this SetupIntent.

return_urlstring

The URL to redirect to after the SetupIntent is confirmed.

business_profileobject

Business information shown to customers, such as the business's URL and MCC.

business_typestring

The business type: individual, company, government_entity, or non_profit.one of individualcompanygovernment_entitynon_profit

capabilitiesobject

Capabilities to request for the account, e.g. card_payments and transfers.

companyobject

Information about the company, used when business_type is 'company'.

controllerobject

Configuration describing who is responsible for pricing, fee collection, and dashboard access on this account.

countrystring

Two-letter country code for the account holder's country.

default_currencystring

Three-letter ISO currency code representing the default currency for the account.

emailstring

The email address of the account holder.

expandarray

List of fields to expand in the response.

individualobject

Information about the individual represented by the account, used when business_type is 'individual'.

metadataobject

Set of key-value pairs to attach to the account.

tos_acceptanceobject

Details on the account's acceptance of the Stripe Services Agreement.

accountstringrequired

The ID of the connected account.

external_accountstringrequired

A token (from Stripe.js) representing the bank account or card to attach, or a dictionary of external account details.

default_for_currencyboolean

Whether this external account should become the default for its currency.

expandarray

List of fields to expand in the response.

metadataobject

Set of key-value pairs to attach to the external account.

accountstringrequired

The ID of the Express-dashboard connected account.

expandarray

List of fields to expand in the response.

accountstringrequired

The ID of the connected account.

addressobject

The person's address.

dobobject

The person's date of birth.

emailstring

The person's email address.

expandarray

List of fields to expand in the response.

first_namestring

The person's first name.

last_namestring

The person's last name.

metadataobject

Set of key-value pairs to attach to the person.

phonestring

The person's phone number.

relationshipobject

The relationship that this person has with the account's legal entity (e.g. owner, director, representative).

ssn_last_4string

The last four digits of the person's Social Security number (U.S. only).

application_fee_idstringrequired

The ID of the application fee to refund.

amountinteger

A positive integer, in the smallest currency unit, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. Omit to refund the full remaining amount.

metadataobject

Set of key-value pairs to attach to the fee refund.

default_aggregationobjectrequired

The default settings used to aggregate this meter's events.

display_namestringrequired

The meter's name. Not visible to the customer. Max 250 characters.

event_namestringrequired

The name of the meter event to record usage for. Corresponds with the event_name field on meter events. Max 100 characters.

customer_mappingobject

Fields that specify how to map a meter event to a customer.

event_time_windowstring

The time window which meter events have been pre-aggregated for, if any.one of dayhour

value_settingsobject

Fields that specify how to calculate a meter event's value.

event_namestringrequired

The name of the meter event. Must match the event_name configured on a billing meter. Max 100 characters.

payloadobjectrequired

The payload of the event. Must contain the fields corresponding to the meter's customer_mapping.event_payload_key (default 'stripe_customer_id') and value_settings.event_payload_key (default 'value').

identifierstring

A unique identifier for the event. If not provided, one is generated. Stripe enforces uniqueness within a rolling period of at least 24 hours. Max 100 characters.

timestampinteger

The time of the event, in Unix seconds. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to the current time if not specified.

featuresobjectrequired

Information about the features available in the portal, such as invoice_history, subscription_cancel, and payment_method_update.

business_profileobject

The business information shown to customers in the portal.

default_return_urlstring

The default URL to redirect customers to when they click the portal's return-to-site link.

expandarray

List of fields to expand in the response.

metadataobject

Set of key-value pairs to attach to the configuration.

amountintegerrequired

Amount to be collected, in the smallest currency unit (e.g. cents for USD).

currencystringrequired

Three-letter ISO currency code for the charge.

captureboolean

Whether to immediately capture the charge. Defaults to true; pass false to create an authorization only.

customerstring

The ID of an existing customer to charge.

descriptionstring

An arbitrary string attached to the charge, shown in the dashboard.

expandarray

List of fields to expand in the response.

metadataobject

Set of key-value pairs to attach to the charge.

receipt_emailstring

The email address to which the receipt for this charge will be sent.

modestringrequired

The mode of the Checkout Session.one of paymentsetupsubscription

success_urlstringrequired

The URL the customer will be redirected to after a successful payment.

cancel_urlstring

The URL the customer will be redirected to if they cancel the payment.

currencystring

Three-letter ISO currency code (e.g., usd, eur, gbp).

customerstring

ID of an existing Customer to associate with this session.

customer_emailstring

If provided, this value will be used when the customer has not provided an email address.

line_itemsarray

Array of line items for this Checkout Session. Each item is a JSON object with fields: price (Stripe Price ID) and quantity. Required for payment/subscription mode.

metadataobject

Set of key-value pairs to attach to the Checkout Session.

durationstringrequired

How long the discount will be in effect. 'once' applies to the first charge, 'repeating' applies for duration_in_months, 'forever' applies indefinitely.one of foreveroncerepeating

amount_offinteger

Fixed amount discount in the smallest currency unit (e.g. cents). Requires currency. Use this OR percent_off.

currencystring

Three-letter ISO currency code. Required when amount_off is set.

duration_in_monthsinteger

Number of months the discount applies when duration is repeating.

idstring

Unique identifier for the coupon. If not provided, Stripe generates a random ID.

max_redemptionsinteger

Maximum number of times this coupon can be redeemed in total.

metadataobject

Set of key-value pairs for storing additional information.

namestring

Name of the coupon displayed to customers.

percent_offnumber

Percentage discount to apply. Use this OR amount_off, not both.

redeem_byinteger

Unix timestamp after which the coupon can no longer be redeemed.

invoicestringrequired

The ID of the invoice to credit.

amountinteger

The integer amount in the smallest currency unit representing the total amount of the credit note. One of amount, lines, or shipping_cost must be provided.

credit_amountinteger

The integer amount in the smallest currency unit to credit to the customer's balance, automatically applied to their next invoice.

email_typestring

Type of email to send to the customer.one of credit_notenone

linesarray

Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.

memostring

The credit note's memo, which appears on the credit note PDF.

metadataobject

Set of key-value pairs to attach to the credit note.

out_of_band_amountinteger

The integer amount in the smallest currency unit that is or will be credited outside of Stripe.

reasonstring

Reason for issuing this credit note.one of duplicatefraudulentorder_changeproduct_unsatisfactory

refund_amountinteger

The integer amount in the smallest currency unit to refund. If set, a refund is created for the charge associated with the invoice.

amountintegerrequired

The signed integer amount, in the smallest currency unit, to apply to the customer's credit balance. A negative amount is a credit; a positive amount is a debit.

currencystringrequired

Three-letter ISO currency code for the balance transaction.

customer_idstringrequired

The ID of the customer whose balance to adjust.

descriptionstring

An arbitrary string attached to the object, useful for displaying to users.

expandarray

List of fields to expand in the response.

metadataobject

Set of key-value pairs to attach to the balance transaction.

addressobject

The customer's address as a JSON object with fields: line1, line2, city, state, postal_code, country.

descriptionstring

An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.

emailstring

Customer's email address. It is displayed alongside the customer in the dashboard and can be useful for searching and tracking.

metadataobject

Set of key-value pairs that you can attach to an object. Useful for storing additional information about the customer.

namestring

The customer's full name or business name.

payment_methodstring

The ID of the PaymentMethod to attach to the customer.

phonestring

The customer's phone number.

shippingobject

The customer's shipping information as a JSON object with name, address, and optional phone fields.

tax_exemptstring

The customer's tax exemption status. One of: none, exempt, or reverse.one of noneexemptreverse

customerstringrequired

The ID of an existing customer

configurationstring

The ID of an existing configuration to use for this session

localestring

The IETF language tag of the locale customer portal is displayed in

on_behalf_ofstring

The `on_behalf_of` account to use for this session

return_urlstring

The default URL to redirect customers to when they click on the portal's link to return to your website

customer_idstringrequired

The ID of the customer to add the tax ID to.

typestringrequired

The type of tax ID, e.g. eu_vat, us_ein, gb_vat.one of ad_nrtae_trnal_tinam_tinao_tinar_cuitau_abnau_arnaw_tinaz_tinba_tinbb_tinbd_binbf_ifubg_uicbh_vatbj_ifubo_tinbr_cnpjbr_cpfbs_tinby_tinca_bnca_gst_hstca_pst_bcca_pst_mbca_pst_skca_qstcd_nifch_uidch_vatcl_tincm_niucn_tinco_nitcr_tincv_nifde_stndo_rcnec_ruceg_tines_cifet_tineu_oss_vateu_vatfo_vatgb_vatge_vatgi_tingn_nifhk_brhr_oibhu_tinic_nifid_npwpil_vatin_gstis_vatit_cfjp_cnjp_rnjp_trnke_pinkg_tinkh_tinkr_brnkz_binla_tinli_uidli_vatlk_vatma_vatmd_vatme_pibmk_vatmr_nifmx_rfcmy_frpmy_itnmy_sstng_tinno_vatno_voecnp_pannz_gstom_vatpe_rucph_tinpl_nippy_rucro_tinrs_pibru_innru_kppsa_vatsg_gstsg_uensi_tinsn_nineasr_finsv_nitth_vattj_tintr_tintw_vattz_vatua_vatug_tinus_einuy_rucuz_tinuz_vatve_rifvn_tinza_vatzm_tinzw_tin

valuestringrequired

The value of the tax ID.

expandarray

List of fields to expand in the response.

customerstringrequired

The ID of the customer to bill.

auto_advanceboolean

Controls whether Stripe performs automatic collection of the invoice.

collection_methodstring

Either charge_automatically or send_invoice.one of charge_automaticallysend_invoice

currencystring

Three-letter ISO currency code.

days_until_dueinteger

The number of days from when the invoice is created until it is due (send_invoice only).

default_payment_methodstring

ID of the default payment method for this invoice.

descriptionstring

An arbitrary string attached to the invoice.

footerstring

Footer text displayed on the invoice.

metadataobject

Set of key-value pairs to attach to the invoice.

pending_invoice_items_behaviorstring

Controls whether the customer's pending invoice items are attached to this invoice.one of includeexclude

subscriptionstring

The ID of the subscription to invoice.

currencystringrequired

Three-letter ISO currency code for the invoice item.

customerstringrequired

The ID of the customer to create the invoice item for.

amountinteger

The amount in the smallest currency unit (e.g. cents for USD).

descriptionstring

An arbitrary string describing the invoice item.

invoicestring

The ID of an existing invoice to attach this item to.

pricestring

The ID of a Price to use for this invoice item.

quantityinteger

Non-negative integer quantity of units for this invoice item.

amountintegerrequired

Amount intended to be collected in the smallest currency unit (e.g., 100 cents for $1.00 USD).

currencystringrequired

Three-letter ISO currency code (lowercase, e.g., usd, eur, gbp).

capture_methodstring

Controls when the funds will be captured from the customer's account.one of automaticautomatic_asyncmanual

confirmboolean

Set to true to attempt to confirm this PaymentIntent immediately after creation.

customerstring

ID of the Customer this PaymentIntent belongs to, if one exists.

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

metadataobject

Set of key-value pairs that you can attach to an object.

payment_methodstring

ID of the payment method to attach to this PaymentIntent.

payment_method_typesarray

The payment method types to allow for this PaymentIntent (e.g. ["card"], ["card", "sepa_debit"]). Stripe's API requires this as an array, even for a single type.

receipt_emailstring

Email address to send the receipt to after successful payment.

return_urlstring

The URL to redirect to after payment is confirmed (used when confirm=true).

statement_descriptorstring

Text shown on the customer's bank or card statement (max 22 characters).

typestringrequired

The type of payment method to create. Excludes 'link': Stripe rejects direct creation of a link PaymentMethod ("You cannot create a type `link` PaymentMethod directly") regardless of input — it can only be obtained via other flows (e.g. an automatic_payment_methods-enabled PaymentIntent/SetupIntent).one of acss_debitaffirmafterpay_clearpayalipayau_becs_debitbacs_debitbancontactblikboletocardcashappcustomer_balanceepsfpxgiropaygrabpayidealklarnakonbinioxxop24paynowpaypalpixpromptpayrevolut_paysepa_debitsofortswishus_bank_accountwechat_payzip

billing_detailsobject

Billing information associated with the PaymentMethod, as a JSON object with fields: name, email, phone.

cardobject

Card details (for type=card), as a JSON object with fields: number, exp_month, exp_year, cvc. Use Stripe test numbers like 4242424242424242.

metadataobject

Set of key-value pairs to attach to the PaymentMethod.

amountintegerrequired

Amount in the smallest currency unit (e.g., cents for USD). Must be a positive integer.

currencystringrequired

Three-letter ISO 4217 currency code for the payout.

descriptionstring

An arbitrary string to describe the payout.

destinationstring

The ID of a bank account or debit card to send the payout to.

methodstring

The method used to send the payout. 'standard' (bank transfer) or 'instant' (instant payout to debit card).one of standardinstant

statement_descriptorstring

A string that appears on the recipient's bank statement (max 22 characters).

amountintegerrequired

Amount to charge per billing interval, in the smallest currency unit (e.g. cents for USD).

currencystringrequired

Three-letter ISO currency code (lowercase) for the plan.

intervalstringrequired

Billing frequency for the plan.one of dayweekmonthyear

productstringrequired

The product ID (or inline product object) this plan belongs to.

idstring

An optional custom identifier for the plan. Must be unique.

interval_countinteger

Number of intervals between billings. For example, interval=month and interval_count=3 means every 3 months.

nicknamestring

A friendly name for the plan shown in the Stripe dashboard.

trial_period_daysinteger

Number of trial period days granted when subscribing to this plan.

currencystringrequired

Three-letter ISO currency code.

activeboolean

Whether the price can be used for new purchases. Defaults to true.

billing_schemestring

Describes how to compute the price per period. Either per_unit or tiered.one of per_unittiered

lookup_keystring

A lookup key used to retrieve prices dynamically from a static string.

metadataobject

Set of key-value pairs to attach to the price.

nicknamestring

A brief description of the price, hidden from customers.

productstring

The ID of the product that this price will belong to.

recurringobject

Recurring billing details as a JSON object with fields: interval (day, week, month, year) and optional interval_count. Omit for a one-time price.

tax_behaviorstring

Specifies whether the price is considered inclusive of taxes or exclusive of taxes.one of exclusiveinclusiveunspecified

unit_amountinteger

A positive integer in cents (or 0 for a free price) representing how much to charge.

namestringrequired

The product's name, meant to be displayable to the customer.

activeboolean

Whether the product is currently available for purchase. Defaults to true.

descriptionstring

The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product.

imagesarray

A list of up to 8 URLs of images for this product.

metadataobject

Set of key-value pairs to attach to the product.

shippableboolean

Whether this product is shipped (i.e., physical goods).

statement_descriptorstring

An arbitrary string to be displayed on your customer's credit card or bank statement.

tax_codestring

A tax code ID. Stripe Tax uses this to classify the product for tax calculations.

unit_labelstring

A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.

urlstring

A URL of a publicly-accessible webpage for this product.

couponstringrequired

The ID of the coupon to apply to this promotion code.

activeboolean

Whether the promotion code is currently active. Defaults to true.

codestring

Human-readable code that customers enter at checkout. If not set, Stripe generates a random code.

customerstring

Restrict this promotion code to a specific customer ID.

expires_atinteger

Unix timestamp after which the promotion code can no longer be redeemed.

max_redemptionsinteger

Maximum number of times this promotion code can be redeemed.

metadataobject

Set of key-value pairs for storing additional information.

customerstring

The ID of the customer the quote belongs to.

descriptionstring

A description visible to customers on the quote.

expires_atinteger

Unix timestamp at which the quote will expire.

footerstring

Footer text shown at the bottom of the quote document.

headerstring

Header text shown at the top of the quote document.

line_itemsarray

A list of line items to include on the quote.

metadataobject

Set of key-value pairs to attach to the quote.

subscription_dataobject

Subscription data to apply when converting the quote to a subscription.

amountinteger

A positive integer in the smallest currency unit representing how much to refund. Defaults to full refund if omitted.

chargestring

The identifier of the charge to refund. Either charge or payment_intent must be provided.

payment_intentstring

The identifier of the PaymentIntent to refund. Alternative to charge.

reasonstring

The reason for the refund.one of duplicatefraudulentrequested_by_customer

confirmboolean

Set to true to attempt to confirm this SetupIntent immediately.

customerstring

ID of the Stripe customer this SetupIntent is associated with.

descriptionstring

An arbitrary string description for the SetupIntent.

payment_methodstring

ID of the payment method to attach to this SetupIntent.

payment_method_typesarray

The payment method types this SetupIntent is allowed to use (e.g. ["card"], ["card", "sepa_debit"]). Stripe's API requires this as an array, even for a single type.

usagestring

Indicates how the payment method is intended to be used in the future.one of off_sessionon_session

customerstringrequired

The identifier of the customer to subscribe.

itemsarrayrequired

List of subscription items, each with a price ID and optional quantity.

cancel_at_period_endboolean

Boolean indicating whether this subscription should cancel at the end of the current period.

collection_methodstring

Either charge_automatically or send_invoice.one of charge_automaticallysend_invoice

currencystring

Three-letter ISO currency code for the subscription.

days_until_dueinteger

Number of days a customer has to pay invoices (used with send_invoice collection method).

default_payment_methodstring

ID of the default payment method for this subscription.

metadataobject

Set of key-value pairs to attach to the subscription.

payment_behaviorstring

Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Use default_incomplete to let the subscription go to status=incomplete (generating a PaymentIntent the client confirms) instead of hard-failing when the customer has no default payment method.one of allow_incompletedefault_incompleteerror_if_incompletepending_if_incomplete

trial_endstring

Unix timestamp for when the trial period ends. Use 'now' to end an existing trial.

trial_period_daysinteger

Integer representing the number of trial period days before the customer is charged.

pricestringrequired

The ID of the price to use for this subscription item.

subscriptionstringrequired

The ID of the subscription to add this item to.

proration_behaviorstring

Determines how to handle prorations when adding this item.one of create_prorationsnonealways_invoice

quantityinteger

The quantity of the plan to which the customer should be subscribed.

customerstring

The identifier of the customer to create the subscription schedule for. Required unless from_subscription is set.

default_settingsobject

Default settings for the subscription schedule, applied to phases that don't override them (e.g. default_payment_method, collection_method, application_fee_percent).

end_behaviorstring

Behavior when the schedule ends: 'release' (default, keeps the underlying subscription running as-is) or 'cancel' (cancels the underlying subscription).one of cancelrelease

expandarray

List of fields to expand in the response.

from_subscriptionstring

Migrate an existing subscription to be managed by a subscription schedule, using the subscription's item(s), set to auto-renew using the subscription's interval. When set, phase values cannot also be set.

metadataobject

Set of key-value pairs to attach to the subscription schedule.

phasesarray

List of phases for the subscription schedule. Each phase can have different prices/quantities and duration. The end_date of one phase equals the start_date of the next.

start_datestring

When the subscription schedule starts. Use 'now' to start immediately, or a Unix timestamp to backdate/postdate the start.

display_namestringrequired

Label shown to customers on invoices and receipts, e.g. VAT or GST.

inclusivebooleanrequired

Whether the tax is included in the price (true) or added on top (false).

percentagenumberrequired

The tax rate percentage as a decimal, e.g. 20.0 for 20%.

countrystring

Two-letter ISO country code the tax rate applies to, e.g. DE or US.

descriptionstring

Internal description of the tax rate, not shown to customers.

jurisdictionstring

The jurisdiction for the tax rate, displayed on invoices.

metadataobject

Set of key-value pairs for storing additional information.

statestring

State, county, province, or region the tax rate applies to.

amountintegerrequired

Amount to transfer in the smallest currency unit (e.g. cents for USD).

currencystringrequired

Three-letter ISO currency code (lowercase) for the transfer.

destinationstringrequired

The ID of the connected Stripe account to transfer funds to.

descriptionstring

An optional description of the transfer.

source_transactionstring

The ID of a charge to use as the source for the transfer.

transfer_idstringrequired

The ID of the transfer to reverse.

amountinteger

The amount in the smallest currency unit to reverse. Omit to reverse the entire remaining transfer amount.

descriptionstring

An arbitrary string attached to the reversal object.

expandarray

List of fields to expand in the response.

metadataobject

Set of key-value pairs to attach to the reversal.

refund_application_feeboolean

Whether the application fee should be refunded when reversing this transfer.

enabled_eventsarrayrequired

Array of event types to subscribe to. Use ["*"] to receive all events.

urlstringrequired

The HTTPS URL of your webhook endpoint.

descriptionstring

An optional description of the webhook endpoint.

idstringrequired

The ID of the PaymentMethod to detach.

sessionstringrequired

The ID of the Checkout Session to expire.

invoice_idstringrequired

The ID of the invoice to finalize.

auto_advanceboolean

Controls whether Stripe performs automatic collection of the invoice after finalization.

quotestringrequired

The ID of the quote to finalize.

expires_atinteger

Unix timestamp at which the finalized quote will expire.

invoice_idstringrequired

The ID of the invoice to pay.

forgiveboolean

In cases where the source used to pay the invoice has insufficient funds, the invoice becomes past_due. Setting forgive to true forgives the invoice and marks it as paid.

payment_methodstring

ID of the payment method to use for this invoice payment.

subscription_idstringrequired

The ID of the paused subscription to resume.

billing_cycle_anchorstring

The billing cycle anchor to apply when resuming: 'now' or 'unchanged'. Defaults to 'now'.one of nowunchanged

expandarray

List of fields to expand in the response.

proration_behaviorstring

How to handle prorations resulting from the billing_cycle_anchor being 'unchanged'.one of always_invoicecreate_prorationsnone

invoice_idstringrequired

The ID of the finalized invoice to send.

expandarray

List of fields to expand in the response.

accountstringrequired

The ID of the connected account.

capabilitystringrequired

The capability identifier, e.g. card_payments or transfers.

expandarray

List of fields to expand in the response.

requestedboolean

Whether to request the capability. Pass true to request it; pass false to remove a previous request.

accountstringrequired

The ID of the connected account to update.

business_profileobject

Business information shown to customers, such as the business's URL and MCC.

companyobject

Information about the company, used when business_type is 'company'.

default_currencystring

Three-letter ISO currency code representing the default currency for the account.

emailstring

The email address of the account holder.

expandarray

List of fields to expand in the response.

individualobject

Information about the individual represented by the account.

metadataobject

Set of key-value pairs to attach to the account.

tos_acceptanceobject

Details on the account's acceptance of the Stripe Services Agreement.

accountstringrequired

The ID of the connected account.

personstringrequired

The ID of the person to update.

addressobject

The person's address.

emailstring

The person's email address.

expandarray

List of fields to expand in the response.

first_namestring

The person's first name.

last_namestring

The person's last name.

metadataobject

Set of key-value pairs to attach to the person.

phonestring

The person's phone number.

relationshipobject

The relationship that this person has with the account's legal entity.

charge_idstringrequired

The ID of the charge to update.

descriptionstring

An arbitrary string attached to the charge.

expandarray

List of fields to expand in the response.

fraud_detailsobject

Information about the charge's riskiness, e.g. marking it as fraudulent or safe.

metadataobject

Set of key-value pairs to attach to the charge.

receipt_emailstring

This is the email address that the receipt for this charge will be sent to.

session_idstringrequired

The ID of the Checkout Session to update.

collected_informationobject

Information about the customer collected within the session. Can only be set when updating embedded or custom sessions.

expandarray

List of fields to expand in the response.

line_itemsarray

The full list of items the customer is purchasing. When updating, you must retransmit the entire array; include an existing item's id to retain it.

couponstringrequired

The ID of the coupon to update.

metadataobject

Set of key-value pairs for storing additional information. Replaces existing metadata.

namestring

Updated name for the coupon, shown to customers.

customer_idstringrequired

The ID of the customer to update.

addressobject

The customer's address as a JSON object with fields: line1, line2, city, state, postal_code, country.

descriptionstring

An arbitrary string that you can attach to a customer object.

emailstring

Customer's email address.

metadataobject

Set of key-value pairs to attach to the customer. Pass an empty value to remove a key.

namestring

The customer's full name or business name.

phonestring

The customer's phone number.

tax_exemptstring

The customer's tax exemption status. One of: none, exempt, or reverse.one of noneexemptreverse

disputestringrequired

The ID of the dispute to update.

customer_email_addressstring

Customer's email address as evidence.

customer_namestring

Customer's name as evidence.

product_descriptionstring

Description of the product or service as evidence.

shipping_documentationstring

File ID for shipping documentation evidence.

submitboolean

If true, immediately submit evidence to the card issuer.

invoiceitemstringrequired

The ID of the invoice item to update.

amountinteger

The new amount in the smallest currency unit (e.g. cents for USD).

descriptionstring

An updated description for the invoice item.

quantityinteger

Non-negative integer quantity of units for this invoice item.

payment_intent_idstringrequired

The ID of the PaymentIntent to update.

amountinteger

Amount intended to be collected, in the smallest currency unit.

currencystring

Three-letter ISO currency code.

customerstring

ID of the customer this PaymentIntent belongs to.

descriptionstring

An arbitrary string attached to the object, useful for displaying to users.

expandarray

List of fields to expand in the response.

metadataobject

Set of key-value pairs to attach to the PaymentIntent.

receipt_emailstring

Email address the receipt for the resulting payment will be sent to.

payment_method_idstringrequired

The ID of the payment method to update.

billing_detailsobject

Billing information associated with the payment method.

cardobject

If this is a card PaymentMethod, a hash of updatable card fields (currently only exp_month and exp_year).

expandarray

List of fields to expand in the response.

metadataobject

Set of key-value pairs to attach to the payment method.

payout_idstringrequired

The ID of the payout to update.

expandarray

List of fields to expand in the response.

metadataobject

Set of key-value pairs to attach to the payout.

planstringrequired

The ID of the plan to update.

activeboolean

Whether the plan is currently available for new subscriptions.

metadataobject

Set of key-value pairs to attach to the plan object.

nicknamestring

A brief description of the plan, hidden from customers.

trial_period_daysinteger

Default number of trial days for subscriptions created using this plan.

price_idstringrequired

The ID of the price to update.

activeboolean

Whether the price can be used for new purchases. Defaults to true.

expandarray

List of fields to expand in the response.

lookup_keystring

A lookup key used to retrieve this price dynamically from a static string.

metadataobject

Set of key-value pairs to attach to the price.

nicknamestring

A brief description of the price, hidden from customers.

tax_behaviorstring

Whether the price is considered inclusive or exclusive of tax.one of exclusiveinclusiveunspecified

product_idstringrequired

The ID of the product to update.

activeboolean

Whether the product is currently available for purchase.

descriptionstring

The product's description.

imagesarray

A list of up to 8 URLs of images for this product.

metadataobject

Set of key-value pairs to attach to the product.

namestring

The product's name.

unit_labelstring

A label that represents units of this product.

urlstring

A URL of a publicly-accessible webpage for this product.

promotion_codestringrequired

The ID of the promotion code to update.

activeboolean

Set to false to deactivate the promotion code so it can no longer be redeemed.

metadataobject

Set of key-value pairs for storing additional information. Replaces existing metadata.

quotestringrequired

The ID of the quote to update.

customerstring

The ID of the customer to associate with the quote.

descriptionstring

A description visible to customers on the quote.

expires_atinteger

Unix timestamp at which the quote will expire.

footerstring

Footer text shown at the bottom of the quote document.

headerstring

Header text shown at the top of the quote document.

metadataobject

Set of key-value pairs to attach to the quote.

idstringrequired

The ID of the refund to update.

metadataobject

Set of key-value pairs to attach to the refund as metadata.