Paymentlinks 4 endpoints

POST /v1/payment_links Create a payment link

Creates a payment link.

operationId: PostPaymentLinks

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
currency	string	optional
metadata	object	optional
line_items	array	required
└ price	string	optional
└ quantity	integer	required
└ price_data	object	optional
└ product	string	optional
└ currency	string	required
└ recurring	object	optional
└ interval	string	required
└ interval_count	integer	optional
└ unit_amount	integer	optional
└ product_data	object	optional
└ name	string	required
└ images	array	optional
└ metadata	object	optional
└ tax_code	string	optional
└ unit_label	string	optional
└ description	string	optional
└ tax_behavior	string	optional
└ unit_amount_decimal	string	optional
└ adjustable_quantity	object	optional
└ enabled	boolean	required
└ maximum	integer	optional
└ minimum	integer	optional
custom_text	object	optional
└ submit	object	optional
└ after_submit	object	optional
└ shipping_address	object	optional
└ terms_of_service_acceptance	object	optional
submit_type	string	optional
on_behalf_of	string	optional
restrictions	object	optional
└ completed_sessions	object	required
└ limit	integer	required
automatic_tax	object	optional
└ enabled	boolean	required
└ liability	object	optional
└ type	string	required
└ account	string	optional
custom_fields	array	optional
└ key	string	required
└ text	object	optional
└ default_value	string	optional
└ maximum_length	integer	optional
└ minimum_length	integer	optional
└ type	string	required
└ label	object	required
└ type	string	required
└ custom	string	required
└ numeric	object	optional
└ default_value	string	optional
└ maximum_length	integer	optional
└ minimum_length	integer	optional
└ dropdown	object	optional
└ options	array	required
└ label	string	required
└ value	string	required
└ default_value	string	optional
└ optional	boolean	optional
transfer_data	object	optional
└ amount	integer	optional
└ destination	string	required
optional_items	array	optional
└ price	string	required
└ quantity	integer	required
└ adjustable_quantity	object	optional
└ enabled	boolean	required
└ maximum	integer	optional
└ minimum	integer	optional
name_collection	object	optional
└ business	object	optional
└ enabled	boolean	required
└ optional	boolean	optional
└ individual	object	optional
└ enabled	boolean	required
└ optional	boolean	optional
after_completion	object	optional
└ type	string	required
└ redirect	object	optional
└ url	string	required
└ hosted_confirmation	object	optional
└ custom_message	string	optional
inactive_message	string	optional
invoice_creation	object	optional
└ enabled	boolean	required
└ invoice_data	object	optional
└ footer	string	optional
└ issuer	object	optional
└ type	string	required
└ account	string	optional
└ metadata	object	optional
└ description	string	optional
└ custom_fields	object	optional
└ account_tax_ids	object	optional
└ rendering_options	object	optional
managed_payments	object	optional
└ enabled	boolean	optional
shipping_options	array	optional
└ shipping_rate	string	optional
customer_creation	string	optional
subscription_data	object	optional
└ metadata	object	optional
└ description	string	optional
└ trial_settings	object	optional
└ end_behavior	object	required
└ missing_payment_method	string	required
└ invoice_settings	object	optional
└ issuer	object	optional
└ type	string	required
└ account	string	optional
└ trial_period_days	integer	optional
…11 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_links

GET /v1/payment_links/{payment_link} Retrieve payment link

Retrieve a payment link.

operationId: GetPaymentLinksPaymentLink

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payment_link	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_links/{payment_link}

POST /v1/payment_links/{payment_link} Update a payment link

Updates a payment link.

operationId: PostPaymentLinksPaymentLink

Parameters

Name	In	Required	Type	Description
payment_link	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
active	boolean	optional
expand	array	optional
metadata	object	optional
line_items	array	optional
└ id	string	required
└ quantity	integer	optional
└ adjustable_quantity	object	optional
└ enabled	boolean	required
└ maximum	integer	optional
└ minimum	integer	optional
custom_text	object	optional
└ submit	object	optional
└ after_submit	object	optional
└ shipping_address	object	optional
└ terms_of_service_acceptance	object	optional
submit_type	string	optional
restrictions	object	optional
automatic_tax	object	optional
└ enabled	boolean	required
└ liability	object	optional
└ type	string	required
└ account	string	optional
custom_fields	object	optional
optional_items	object	optional
name_collection	object	optional
after_completion	object	optional
└ type	string	required
└ redirect	object	optional
└ url	string	required
└ hosted_confirmation	object	optional
└ custom_message	string	optional
inactive_message	object	optional
invoice_creation	object	optional
└ enabled	boolean	required
└ invoice_data	object	optional
└ footer	string	optional
└ issuer	object	optional
└ type	string	required
└ account	string	optional
└ metadata	object	optional
└ description	string	optional
└ custom_fields	object	optional
└ account_tax_ids	object	optional
└ rendering_options	object	optional
customer_creation	string	optional
subscription_data	object	optional
└ metadata	object	optional
└ trial_settings	object	optional
└ invoice_settings	object	optional
└ issuer	object	optional
└ type	string	required
└ account	string	optional
└ trial_period_days	object	optional
tax_id_collection	object	optional
└ enabled	boolean	required
└ required	string	optional
payment_intent_data	object	optional
└ metadata	object	optional
└ description	object	optional
└ transfer_group	object	optional
└ statement_descriptor	object	optional
└ statement_descriptor_suffix	object	optional
payment_method_types	object	optional
allow_promotion_codes	boolean	optional
…4 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_links/{payment_link}

GET /v1/payment_links/{payment_link}/line_items Retrieve a payment link's line items

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetPaymentLinksPaymentLinkLineItems

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_link	path	required	string	—
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_links/{payment_link}/line_items

Paymentmethodconfigurations 4 endpoints

GET /v1/payment_method_configurations List payment method configurations

List payment method configurations

operationId: GetPaymentMethodConfigurations

Parameters

Name	In	Required	Type	Description
application	query	optional		The Connect application to filter by.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_method_configurations

POST /v1/payment_method_configurations Create a payment method configuration

Creates a payment method configuration

operationId: PostPaymentMethodConfigurations

Request Body

application/x-www-form-urlencoded

Property	Type	Required
eps	object	optional
└ display_preference	object	optional
└ preference	string	optional
fpx	object	optional
└ display_preference	object	optional
└ preference	string	optional
jcb	object	optional
└ display_preference	object	optional
└ preference	string	optional
p24	object	optional
└ display_preference	object	optional
└ preference	string	optional
pix	object	optional
└ display_preference	object	optional
└ preference	string	optional
upi	object	optional
└ display_preference	object	optional
└ preference	string	optional
zip	object	optional
└ display_preference	object	optional
└ preference	string	optional
alma	object	optional
└ display_preference	object	optional
└ preference	string	optional
blik	object	optional
└ display_preference	object	optional
└ preference	string	optional
card	object	optional
└ display_preference	object	optional
└ preference	string	optional
link	object	optional
└ display_preference	object	optional
└ preference	string	optional
name	string	optional
oxxo	object	optional
└ display_preference	object	optional
└ preference	string	optional
ideal	object	optional
└ display_preference	object	optional
└ preference	string	optional
payco	object	optional
└ display_preference	object	optional
└ preference	string	optional
payto	object	optional
└ display_preference	object	optional
└ preference	string	optional
swish	object	optional
└ display_preference	object	optional
└ preference	string	optional
twint	object	optional
└ display_preference	object	optional
└ preference	string	optional
affirm	object	optional
└ display_preference	object	optional
└ preference	string	optional
alipay	object	optional
└ display_preference	object	optional
└ preference	string	optional
…41 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_method_configurations

GET /v1/payment_method_configurations/{configuration} Retrieve payment method configuration

Retrieve payment method configuration

operationId: GetPaymentMethodConfigurationsConfiguration

Parameters

Name	In	Required	Type	Description
configuration	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_method_configurations/{configuration}

POST /v1/payment_method_configurations/{configuration} Update payment method configuration

Update payment method configuration

operationId: PostPaymentMethodConfigurationsConfiguration

Parameters

Name	In	Required	Type	Description
configuration	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
eps	object	optional
└ display_preference	object	optional
└ preference	string	optional
fpx	object	optional
└ display_preference	object	optional
└ preference	string	optional
jcb	object	optional
└ display_preference	object	optional
└ preference	string	optional
p24	object	optional
└ display_preference	object	optional
└ preference	string	optional
pix	object	optional
└ display_preference	object	optional
└ preference	string	optional
upi	object	optional
└ display_preference	object	optional
└ preference	string	optional
zip	object	optional
└ display_preference	object	optional
└ preference	string	optional
alma	object	optional
└ display_preference	object	optional
└ preference	string	optional
blik	object	optional
└ display_preference	object	optional
└ preference	string	optional
card	object	optional
└ display_preference	object	optional
└ preference	string	optional
link	object	optional
└ display_preference	object	optional
└ preference	string	optional
name	string	optional
oxxo	object	optional
└ display_preference	object	optional
└ preference	string	optional
ideal	object	optional
└ display_preference	object	optional
└ preference	string	optional
payco	object	optional
└ display_preference	object	optional
└ preference	string	optional
payto	object	optional
└ display_preference	object	optional
└ preference	string	optional
swish	object	optional
└ display_preference	object	optional
└ preference	string	optional
twint	object	optional
└ display_preference	object	optional
└ preference	string	optional
active	boolean	optional
affirm	object	optional
└ display_preference	object	optional
└ preference	string	optional
…41 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_method_configurations/{configuration}

Paymentmethoddomains 5 endpoints

GET /v1/payment_method_domains List payment method domains

Lists the details of existing payment method domains.

operationId: GetPaymentMethodDomains

Parameters

Name	In	Required	Type	Description
domain_name	query	optional	string	The domain name that this payment method domain object represents.
enabled	query	optional	boolean	Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_method_domains

POST /v1/payment_method_domains Create a payment method domain

Creates a payment method domain.

operationId: PostPaymentMethodDomains

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
enabled	boolean	optional
domain_name	string	required

Responses

default

Error response.

200

Successful response.

POST /v1/payment_method_domains

GET /v1/payment_method_domains/{payment_method_domain} Retrieve a payment method domain

Retrieves the details of an existing payment method domain.

operationId: GetPaymentMethodDomainsPaymentMethodDomain

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payment_method_domain	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_method_domains/{payment_method_domain}

POST /v1/payment_method_domains/{payment_method_domain} Update a payment method domain

Updates an existing payment method domain.

operationId: PostPaymentMethodDomainsPaymentMethodDomain

Parameters

Name	In	Required	Type	Description
payment_method_domain	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
enabled	boolean	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_method_domains/{payment_method_domain}

POST /v1/payment_method_domains/{payment_method_domain}/validate Validate an existing payment method domain

Some payment methods might require additional steps to register a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements or Embedded Checkout for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

operationId: PostPaymentMethodDomainsPaymentMethodDomainValidate

Parameters

Name	In	Required	Type	Description
payment_method_domain	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_method_domains/{payment_method_domain}/validate

Paymentmethods 6 endpoints

GET /v1/payment_methods List PaymentMethods

Returns a list of all PaymentMethods.

operationId: GetPaymentMethods

Parameters

Name	In	Required	Type	Description
allow_redisplay	query	optional	string	This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
customer	query	optional	string	The ID of the customer whose PaymentMethods will be retrieved.
customer_account	query	optional	string	The ID of the Account whose PaymentMethods will be retrieved.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	Filters the list by the object `type` field. Unfiltered, the list returns all payment method types except `custom`. If your integration expects only one type of payment method in the response, specify that type value in the request to reduce your payload.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_methods

POST /v1/payment_methods Shares a PaymentMethod

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

operationId: PostPaymentMethods

Request Body

application/x-www-form-urlencoded

Property	Type	Required
eps	object	optional
└ bank	string	optional
fpx	object	optional
└ bank	string	required
p24	object	optional
└ bank	string	optional
pix	object	optional
upi	object	optional
└ mandate_options	object	optional
└ amount	integer	optional
└ end_date	integer	optional
└ amount_type	string	optional
└ description	string	optional
zip	object	optional
alma	object	optional
blik	object	optional
card	object	optional
link	object	optional
oxxo	object	optional
type	string	optional
ideal	object	optional
└ bank	string	optional
payco	object	optional
payto	object	optional
└ pay_id	string	optional
└ bsb_number	string	optional
└ account_number	string	optional
swish	object	optional
twint	object	optional
affirm	object	optional
alipay	object	optional
billie	object	optional
…42 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_methods

GET /v1/payment_methods/{payment_method} Retrieve a PaymentMethod

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

operationId: GetPaymentMethodsPaymentMethod

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payment_method	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_methods/{payment_method}

POST /v1/payment_methods/{payment_method} Update a PaymentMethod

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

operationId: PostPaymentMethodsPaymentMethod

Parameters

Name	In	Required	Type	Description
payment_method	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
card	object	optional
└ exp_year	integer	optional
└ networks	object	optional
└ preferred	string	optional
└ exp_month	integer	optional
payto	object	optional
└ pay_id	string	optional
└ bsb_number	string	optional
└ account_number	string	optional
expand	array	optional
metadata	object	optional
allow_redisplay	string	optional
billing_details	object	optional
└ name	object	optional
└ email	object	optional
└ phone	object	optional
└ tax_id	string	optional
└ address	object	optional
us_bank_account	object	optional
└ account_type	string	optional
└ account_holder_type	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_methods/{payment_method}

POST /v1/payment_methods/{payment_method}/attach Attach a PaymentMethod to a Customer

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

operationId: PostPaymentMethodsPaymentMethodAttach

Parameters

Name	In	Required	Type	Description
payment_method	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
customer	string	optional
customer_account	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_methods/{payment_method}/attach

POST /v1/payment_methods/{payment_method}/detach Detach a PaymentMethod from a Customer

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

operationId: PostPaymentMethodsPaymentMethodDetach

Parameters

Name	In	Required	Type	Description
payment_method	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_methods/{payment_method}/detach

Paymentrecords 8 endpoints

POST /v1/payment_records/report_payment Report a payment

Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.

operationId: PostPaymentRecordsReportPayment

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
failed	object	optional
└ failed_at	integer	required
outcome	string	optional
metadata	object	optional
guaranteed	object	optional
└ guaranteed_at	integer	required
description	string	optional
initiated_at	integer	required
amount_requested	object	required
└ value	integer	required
└ currency	string	required
customer_details	object	optional
└ name	string	optional
└ email	string	optional
└ phone	string	optional
└ customer	string	optional
shipping_details	object	optional
└ name	string	optional
└ phone	string	optional
└ address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
customer_presence	string	optional
processor_details	object	optional
└ type	string	required
└ custom	object	optional
└ payment_reference	string	required
payment_method_details	object	required
└ type	string	optional
└ custom	object	optional
└ type	string	optional
└ display_name	string	optional
└ payment_method	string	optional
└ billing_details	object	optional
└ name	string	optional
└ email	string	optional
└ phone	string	optional
└ address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_records/report_payment

GET /v1/payment_records/{id} Retrieve a Payment Record

Retrieves a Payment Record with the given ID

operationId: GetPaymentRecordsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	The ID of the Payment Record.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_records/{id}

POST /v1/payment_records/{id}/report_payment_attempt Report a payment attempt

Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.

operationId: PostPaymentRecordsIdReportPaymentAttempt

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the Payment Record.

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
failed	object	optional
└ failed_at	integer	required
outcome	string	optional
metadata	object	optional
guaranteed	object	optional
└ guaranteed_at	integer	required
description	string	optional
initiated_at	integer	required
shipping_details	object	optional
└ name	string	optional
└ phone	string	optional
└ address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
payment_method_details	object	optional
└ type	string	optional
└ custom	object	optional
└ type	string	optional
└ display_name	string	optional
└ payment_method	string	optional
└ billing_details	object	optional
└ name	string	optional
└ email	string	optional
└ phone	string	optional
└ address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_records/{id}/report_payment_attempt

POST /v1/payment_records/{id}/report_payment_attempt_canceled Report payment attempt canceled

Report that the most recent payment attempt on the specified Payment Record was canceled.

operationId: PostPaymentRecordsIdReportPaymentAttemptCanceled

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the Payment Record.

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional
canceled_at	integer	required

Responses

default

Error response.

200

Successful response.

POST /v1/payment_records/{id}/report_payment_attempt_canceled

POST /v1/payment_records/{id}/report_payment_attempt_failed Report payment attempt failed

Report that the most recent payment attempt on the specified Payment Record failed or errored.

operationId: PostPaymentRecordsIdReportPaymentAttemptFailed

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the Payment Record.

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional
failed_at	integer	required

Responses

default

Error response.

200

Successful response.

POST /v1/payment_records/{id}/report_payment_attempt_failed

POST /v1/payment_records/{id}/report_payment_attempt_guaranteed Report payment attempt guaranteed

Report that the most recent payment attempt on the specified Payment Record was guaranteed.

operationId: PostPaymentRecordsIdReportPaymentAttemptGuaranteed

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the Payment Record.

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional
guaranteed_at	integer	required

Responses

default

Error response.

200

Successful response.

POST /v1/payment_records/{id}/report_payment_attempt_guaranteed

POST /v1/payment_records/{id}/report_payment_attempt_informational Report payment attempt informational

Report informational updates on the specified Payment Record.

operationId: PostPaymentRecordsIdReportPaymentAttemptInformational

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the Payment Record.

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional
description	object	optional
customer_details	object	optional
└ name	string	optional
└ email	string	optional
└ phone	string	optional
└ customer	string	optional
shipping_details	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payment_records/{id}/report_payment_attempt_informational

POST /v1/payment_records/{id}/report_refund Report a refund

Report that the most recent payment attempt on the specified Payment Record was refunded.

operationId: PostPaymentRecordsIdReportRefund

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the Payment Record.

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
amount	object	optional
└ value	integer	required
└ currency	string	required
expand	array	optional
outcome	string	required
metadata	object	optional
refunded	object	required
└ refunded_at	integer	required
initiated_at	integer	optional
processor_details	object	required
└ type	string	required
└ custom	object	optional
└ refund_reference	string	required

Responses

default

Error response.

200

Successful response.

POST /v1/payment_records/{id}/report_refund

Payouts 6 endpoints

GET /v1/payouts List all payouts

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

operationId: GetPayouts

Parameters

Name	In	Required	Type	Description
arrival_date	query	optional		Only return payouts that are expected to arrive during the given date interval.
created	query	optional		Only return payouts that were created during the given date interval.
destination	query	optional	string	The ID of an external account - only return payouts sent to this external account.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payouts

POST /v1/payouts Create a payout

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

operationId: PostPayouts

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
amount	integer	required
expand	array	optional
method	string	optional
currency	string	required
metadata	object	optional
description	string	optional
destination	string	optional
source_type	string	optional
payout_method	string	optional
statement_descriptor	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payouts

GET /v1/payouts/{payout} Retrieve a payout

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

operationId: GetPayoutsPayout

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payout	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payouts/{payout}

POST /v1/payouts/{payout} Update a payout

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

operationId: PostPayoutsPayout

Parameters

Name	In	Required	Type	Description
payout	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payouts/{payout}

POST /v1/payouts/{payout}/cancel Cancel a payout

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

operationId: PostPayoutsPayoutCancel

Parameters

Name	In	Required	Type	Description
payout	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payouts/{payout}/cancel

POST /v1/payouts/{payout}/reverse Reverse a payout

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US and Canadian bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

operationId: PostPayoutsPayoutReverse

Parameters

Name	In	Required	Type	Description
payout	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/payouts/{payout}/reverse

Plans 5 endpoints

GET /v1/plans List all plans

Returns a list of your plans.

operationId: GetPlans

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
product	query	optional	string	Only return plans for the given product.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/plans

POST /v1/plans Create a plan

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

operationId: PostPlans

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
id	string	optional
meter	string	optional
tiers	array	optional
└ up_to	object	required
└ flat_amount	integer	optional
└ unit_amount	integer	optional
└ flat_amount_decimal	string	optional
└ unit_amount_decimal	string	optional
active	boolean	optional
amount	integer	optional
expand	array	optional
product	object	optional
currency	string	required
interval	string	required
metadata	object	optional
nickname	string	optional
tiers_mode	string	optional
usage_type	string	optional
amount_decimal	string	optional
billing_scheme	string	optional
interval_count	integer	optional
transform_usage	object	optional
└ round	string	required
└ divide_by	integer	required
trial_period_days	integer	optional

Responses

default

Error response.

200

Successful response.

POST /v1/plans

DELETE /v1/plans/{plan} Delete a plan

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

operationId: DeletePlansPlan

Parameters

Name	In	Required	Type	Description
plan	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

DELETE /v1/plans/{plan}

GET /v1/plans/{plan} Retrieve a plan

Retrieves the plan with the given ID.

operationId: GetPlansPlan

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
plan	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/plans/{plan}

POST /v1/plans/{plan} Update a plan

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

operationId: PostPlansPlan

Parameters

Name	In	Required	Type	Description
plan	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
active	boolean	optional
expand	array	optional
product	string	optional
metadata	object	optional
nickname	string	optional
trial_period_days	integer	optional

Responses

default

Error response.

200

Successful response.

POST /v1/plans/{plan}

Prices 5 endpoints

GET /v1/prices List all prices

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

operationId: GetPrices

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
currency	query	optional	string	Only return prices for the given currency.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
lookup_keys	query	optional	array	Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
product	query	optional	string	Only return prices for the given product.
recurring	query	optional	object	Only return prices with these recurring fields.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	Only return prices of type `recurring` or `one_time`.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/prices

POST /v1/prices Create a price

Creates a new Price for an existing Product. The Price can be recurring or one-time.

operationId: PostPrices

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
tiers	array	optional
└ up_to	object	required
└ flat_amount	integer	optional
└ unit_amount	integer	optional
└ flat_amount_decimal	string	optional
└ unit_amount_decimal	string	optional
active	boolean	optional
expand	array	optional
product	string	optional
currency	string	required
metadata	object	optional
nickname	string	optional
recurring	object	optional
└ meter	string	optional
└ interval	string	required
└ usage_type	string	optional
└ interval_count	integer	optional
lookup_key	string	optional
tiers_mode	string	optional
unit_amount	integer	optional
product_data	object	optional
└ id	string	optional
└ name	string	required
└ active	boolean	optional
└ metadata	object	optional
└ tax_code	string	optional
└ unit_label	string	optional
└ statement_descriptor	string	optional
tax_behavior	string	optional
billing_scheme	string	optional
currency_options	object	optional
custom_unit_amount	object	optional
└ preset	integer	optional
└ enabled	boolean	required
└ maximum	integer	optional
└ minimum	integer	optional
transform_quantity	object	optional
└ round	string	required
└ divide_by	integer	required
transfer_lookup_key	boolean	optional
unit_amount_decimal	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/prices

GET /v1/prices/search Search prices

Search for prices you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetPricesSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See search query language and the list of supported query fields for prices.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/prices/search

GET /v1/prices/{price} Retrieve a price

Retrieves the price with the given ID.

operationId: GetPricesPrice

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
price	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/prices/{price}

POST /v1/prices/{price} Update a price

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

operationId: PostPricesPrice

Parameters

Name	In	Required	Type	Description
price	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
active	boolean	optional
expand	array	optional
metadata	object	optional
nickname	string	optional
lookup_key	string	optional
tax_behavior	string	optional
currency_options	object	optional
transfer_lookup_key	boolean	optional

Responses

default

Error response.

200

Successful response.

POST /v1/prices/{price}

Products 7 endpoints

GET /v1/products List all products

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

operationId: GetProducts

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return products that are active or inactive (e.g., pass `false` to list all inactive products).
created	query	optional		Only return products that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
ids	query	optional	array	Only return products with the given IDs. Cannot be used with starting_after or ending_before.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
shippable	query	optional	boolean	Only return products that can be shipped (i.e., physical, not digital products).
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
url	query	optional	string	Only return products with the given url.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/products

POST /v1/products Create a product

Creates a new product object.

operationId: PostProducts

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
id	string	optional
url	string	optional
name	string	required
active	boolean	optional
expand	array	optional
images	array	optional
metadata	object	optional
tax_code	string	optional
shippable	boolean	optional
unit_label	string	optional
description	string	optional
default_price_data	object	optional
└ currency	string	required
└ metadata	object	optional
└ recurring	object	optional
└ interval	string	required
└ interval_count	integer	optional
└ unit_amount	integer	optional
└ tax_behavior	string	optional
└ currency_options	object	optional
└ custom_unit_amount	object	optional
└ preset	integer	optional
└ enabled	boolean	required
└ maximum	integer	optional
└ minimum	integer	optional
└ unit_amount_decimal	string	optional
marketing_features	array	optional
└ name	string	required
package_dimensions	object	optional
└ width	number	required
└ height	number	required
└ length	number	required
└ weight	number	required
statement_descriptor	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/products

GET /v1/products/search Search products

Search for products you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetProductsSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See search query language and the list of supported query fields for products.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/products/search

DELETE /v1/products/{id} Delete a product

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

operationId: DeleteProductsId

Parameters

Name	In	Required	Type	Description
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

DELETE /v1/products/{id}

GET /v1/products/{id} Retrieve a product

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

operationId: GetProductsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/products/{id}

POST /v1/products/{id} Update a product

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

operationId: PostProductsId

Parameters

Name	In	Required	Type	Description
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
url	object	optional
name	string	optional
active	boolean	optional
expand	array	optional
images	object	optional
metadata	object	optional
tax_code	object	optional
shippable	boolean	optional
unit_label	object	optional
description	object	optional
default_price	string	optional
marketing_features	object	optional
package_dimensions	object	optional
statement_descriptor	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/products/{id}

GET /v1/products/{product}/features List all features attached to a product

Retrieve a list of features for a product

operationId: GetProductsProductFeatures

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
product	path	required	string	—
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/products/{product}/features

Load more endpoints