List all secrets stored on the given scope.
" }, { "info": { "name": "Stripe Get Apps Secrets Find", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/apps/secrets/find", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "name", "value": "", "type": "query", "description": "A name for the secret that's unique within the scope." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Finds a secret in the secret store by name and scope.
" }, { "info": { "name": "Stripe Get Balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/balance", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see Accounting for negative balances.
" }, { "info": { "name": "Stripe Get Balance History", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/balance/history", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query", "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "payout", "value": "", "type": "query", "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID." }, { "name": "source", "value": "", "type": "query", "description": "Only returns the original transaction." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "type", "value": "", "type": "query", "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
\n\nNote that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Retrieves the balance transaction with the given ID.
\n\nNote that this endpoint previously used the path /v1/balance/history/:id.
Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
\n\nNote that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Retrieves the balance transaction with the given ID.
\n\nNote that this endpoint previously used the path /v1/balance/history/:id.
Returns a list of configurations that describe the functionality of the customer portal.
" }, { "info": { "name": "Stripe Get Billing Portal Configurations Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/billing_portal/configurations/:configuration", "params": [ { "name": "configuration", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a configuration that describes the functionality of the customer portal.
" }, { "info": { "name": "Stripe Get Checkout Sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/checkout/sessions", "params": [ { "name": "created", "value": "", "type": "query", "description": "Only return the Checkout Sessions that were created during the given date interval." }, { "name": "customer", "value": "", "type": "query", "description": "Only return the Checkout Sessions for the Customer specified." }, { "name": "customer_details", "value": "", "type": "query", "description": "Only return the Checkout Sessions for the Customer details specified." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "payment_intent", "value": "", "type": "query", "description": "Only return the Checkout Session for the PaymentIntent specified." }, { "name": "payment_link", "value": "", "type": "query", "description": "Only return the Checkout Sessions for the Payment Link specified." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "status", "value": "", "type": "query", "description": "Only return the Checkout Sessions matching the given status." }, { "name": "subscription", "value": "", "type": "query", "description": "Only return the Checkout Session for the subscription specified." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of Checkout Sessions.
" }, { "info": { "name": "Stripe Get Checkout Sessions Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/checkout/sessions/:session", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a Session object.
" }, { "info": { "name": "Stripe Get Checkout Sessions Session Line Items", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/checkout/sessions/:session/line_items", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "session", "value": "", "type": "path" }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "When retrieving a Checkout Session, 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.
" }, { "info": { "name": "Stripe Get Country Specs", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/country_specs", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Lists all Country Spec objects available in the API.
" }, { "info": { "name": "Stripe Get Country Specs Country", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/country_specs/:country", "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a Country Spec for a given Country code.
" }, { "info": { "name": "Stripe Get Coupons", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/coupons", "params": [ { "name": "created", "value": "", "type": "query", "description": "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." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of your coupons.
" }, { "info": { "name": "Stripe Get Coupons Coupon", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/coupons/:coupon", "params": [ { "name": "coupon", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the coupon with the given ID.
" }, { "info": { "name": "Stripe Get Credit Notes", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/credit_notes", "params": [ { "name": "customer", "value": "", "type": "query", "description": "Only return credit notes for the customer specified by this customer ID." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "invoice", "value": "", "type": "query", "description": "Only return credit notes for the invoice specified by this invoice ID." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of credit notes.
" }, { "info": { "name": "Stripe Get Credit Notes Preview", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/credit_notes/preview", "params": [ { "name": "amount", "value": "", "type": "query", "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note." }, { "name": "credit_amount", "value": "", "type": "query", "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice." }, { "name": "effective_at", "value": "", "type": "query", "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "invoice", "value": "", "type": "query", "description": "ID of the invoice." }, { "name": "lines", "value": "", "type": "query", "description": "Line items that make up the credit note." }, { "name": "memo", "value": "", "type": "query", "description": "The credit note's memo appears on the credit note PDF." }, { "name": "metadata", "value": "", "type": "query", "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, { "name": "out_of_band_amount", "value": "", "type": "query", "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe." }, { "name": "reason", "value": "", "type": "query", "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`" }, { "name": "refund", "value": "", "type": "query", "description": "ID of an existing refund to link this credit note to." }, { "name": "refund_amount", "value": "", "type": "query", "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice." }, { "name": "shipping_cost", "value": "", "type": "query", "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Get a preview of a credit note without creating it.
" }, { "info": { "name": "Stripe Get Credit Notes Preview Lines", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/credit_notes/preview/lines", "params": [ { "name": "amount", "value": "", "type": "query", "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note." }, { "name": "credit_amount", "value": "", "type": "query", "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice." }, { "name": "effective_at", "value": "", "type": "query", "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "invoice", "value": "", "type": "query", "description": "ID of the invoice." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "lines", "value": "", "type": "query", "description": "Line items that make up the credit note." }, { "name": "memo", "value": "", "type": "query", "description": "The credit note's memo appears on the credit note PDF." }, { "name": "metadata", "value": "", "type": "query", "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, { "name": "out_of_band_amount", "value": "", "type": "query", "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe." }, { "name": "reason", "value": "", "type": "query", "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`" }, { "name": "refund", "value": "", "type": "query", "description": "ID of an existing refund to link this credit note to." }, { "name": "refund_amount", "value": "", "type": "query", "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice." }, { "name": "shipping_cost", "value": "", "type": "query", "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
" }, { "info": { "name": "Stripe Get Credit Notes Credit Note Lines", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/credit_notes/:credit_note/lines", "params": [ { "name": "credit_note", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
" }, { "info": { "name": "Stripe Get Credit Notes Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/credit_notes/:id", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the credit note object with the given identifier.
" }, { "info": { "name": "Stripe Get Customers", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "email", "value": "", "type": "query", "description": "A case-sensitive filter on the list based on the customer's `email` field. The value must be a string." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "test_clock", "value": "", "type": "query", "description": "Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
" }, { "info": { "name": "Stripe Get Customers Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/search", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "query", "value": "", "type": "query", "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers)." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Search for customers you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
" }, { "info": { "name": "Stripe Get Customers Customer", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a Customer object.
" }, { "info": { "name": "Stripe Get Customers Customer Balance Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of transactions that updated the customer’s balances.
" }, { "info": { "name": "Stripe Get Customers Customer Balance Transactions Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions/:transaction", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "transaction", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a specific customer balance transaction that updated the customer’s balances.
" }, { "info": { "name": "Stripe Get Customers Customer Bank Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/bank_accounts", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.
By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.
" }, { "info": { "name": "Stripe Get Customers Customer Cards", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cards", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "You can see a list of the cards belonging to a customer.\nNote that the 10 most recent sources are always available on the Customer object.\nIf you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.
You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.
" }, { "info": { "name": "Stripe Get Customers Customer Cash Balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a customer’s cash balance.
" }, { "info": { "name": "Stripe Get Customers Customer Cash Balance Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance_transactions", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of transactions that modified the customer’s cash balance.
" }, { "info": { "name": "Stripe Get Customers Customer Cash Balance Transactions Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance_transactions/:transaction", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "transaction", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
" }, { "info": { "name": "Stripe Get Customers Customer Discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/discount", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Stripe Get Customers Customer Discount" }, { "info": { "name": "Stripe Get Customers Customer Payment Methods", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/payment_methods", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "type", "value": "", "type": "query", "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of PaymentMethods for a given Customer
" }, { "info": { "name": "Stripe Get Customers Customer Payment Methods Payment Method", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/payment_methods/:payment_method", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "payment_method", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a PaymentMethod object for a given Customer.
" }, { "info": { "name": "Stripe Get Customers Customer Sources", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/sources", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "object", "value": "", "type": "query", "description": "Filter sources according to a particular object type." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "List sources for a specified customer.
" }, { "info": { "name": "Stripe Get Customers Customer Sources Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/sources/:id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieve a specified source for a given customer.
" }, { "info": { "name": "Stripe Get Customers Customer Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.
" }, { "info": { "name": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the subscription with the given ID.
" }, { "info": { "name": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id Discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id/discount", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id Discount" }, { "info": { "name": "Stripe Get Customers Customer Tax Ids", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/tax_ids", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of tax IDs for a customer.
" }, { "info": { "name": "Stripe Get Customers Customer Tax Ids Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/tax_ids/:id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the tax_id object with the given identifier.
Returns a list of your disputes.
" }, { "info": { "name": "Stripe Get Disputes Dispute", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/disputes/:dispute", "params": [ { "name": "dispute", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the dispute with the given ID.
" }, { "info": { "name": "Stripe Get Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/events", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "delivery_success", "value": "", "type": "query", "description": "Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "type", "value": "", "type": "query", "description": "A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property." }, { "name": "types", "value": "", "type": "query", "description": "An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).
Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
" }, { "info": { "name": "Stripe Get Exchange Rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/exchange_rates", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
" }, { "info": { "name": "Stripe Get Exchange Rates Rate Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/exchange_rates/:rate_id", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "rate_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the exchange rates from the given currency to every supported currency.
" }, { "info": { "name": "Stripe Get Files", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/files", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "purpose", "value": "", "type": "query", "description": "Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
" }, { "info": { "name": "Stripe Get Files File", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/files/:file", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "file", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.
" }, { "info": { "name": "Stripe Get Financial Connections Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/financial_connections/accounts", "params": [ { "name": "account_holder", "value": "", "type": "query", "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "session", "value": "", "type": "query", "description": "If present, only return accounts that were collected as part of the given session." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of Financial Connections Account objects.
Retrieves the details of an Financial Connections Account.
Lists all owners for a given Account
Retrieves the details of a Financial Connections Session
Returns a list of Financial Connections Transaction objects.
Retrieves the details of a Financial Connections Transaction
List all verification reports.
" }, { "info": { "name": "Stripe Get Identity Verification Reports Report", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_reports/:report", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "report", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves an existing VerificationReport
" }, { "info": { "name": "Stripe Get Identity Verification Sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_sessions", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "status", "value": "", "type": "query", "description": "Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work)." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of VerificationSessions
" }, { "info": { "name": "Stripe Get Identity Verification Sessions Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the details of a VerificationSession that was previously created.
\n\nWhen the session status is requires_input, you can use this method to retrieve a valid\nclient_secret or url to allow re-submission.
Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
" }, { "info": { "name": "Stripe Get Invoice Items", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/Invoice Items/:invoiceitem", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "invoiceitem", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the invoice item with the given ID.
" }, { "info": { "name": "Stripe Get Invoices", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/invoices", "params": [ { "name": "collection_method", "value": "", "type": "query", "description": "The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`." }, { "name": "created", "value": "", "type": "query" }, { "name": "customer", "value": "", "type": "query", "description": "Only return invoices for the customer specified by this customer ID." }, { "name": "due_date", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "status", "value": "", "type": "query", "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)" }, { "name": "subscription", "value": "", "type": "query", "description": "Only return invoices for the subscription specified by this subscription ID." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
" }, { "info": { "name": "Stripe Get Invoices Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/invoices/search", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "query", "value": "", "type": "query", "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices)." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Search for invoices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
" }, { "info": { "name": "Stripe Get Invoices Upcoming", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/invoices/upcoming", "params": [ { "name": "automatic_tax", "value": "", "type": "query", "description": "Settings for automatic tax lookup for this invoice preview." }, { "name": "coupon", "value": "", "type": "query", "description": "The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string." }, { "name": "currency", "value": "", "type": "query", "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified." }, { "name": "customer", "value": "", "type": "query", "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set." }, { "name": "customer_details", "value": "", "type": "query", "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set." }, { "name": "discounts", "value": "", "type": "query", "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "invoice_items", "value": "", "type": "query", "description": "List of invoice items to add or update in the upcoming invoice preview." }, { "name": "schedule", "value": "", "type": "query", "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields." }, { "name": "subscription", "value": "", "type": "query", "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions." }, { "name": "subscription_billing_cycle_anchor", "value": "", "type": "query", "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`." }, { "name": "subscription_cancel_at", "value": "", "type": "query", "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, { "name": "subscription_cancel_at_period_end", "value": "", "type": "query", "description": "Boolean indicating whether this subscription should cancel at the end of the current period." }, { "name": "subscription_cancel_now", "value": "", "type": "query", "description": "This simulates the subscription being canceled or expired immediately." }, { "name": "subscription_default_tax_rates", "value": "", "type": "query", "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set." }, { "name": "subscription_items", "value": "", "type": "query", "description": "A list of up to 20 subscription items, each with an attached price." }, { "name": "subscription_proration_behavior", "value": "", "type": "query", "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`." }, { "name": "subscription_proration_date", "value": "", "type": "query", "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'." }, { "name": "subscription_resume_at", "value": "", "type": "query", "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed." }, { "name": "subscription_start_date", "value": "", "type": "query", "description": "Date a subscription is intended to start (can be future or past)." }, { "name": "subscription_trial_end", "value": "", "type": "query", "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required." }, { "name": "subscription_trial_from_plan", "value": "", "type": "query", "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
\n\nNote that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay" }, { "info": { "name": "Stripe Get Invoices Upcoming Lines", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/invoices/upcoming/lines", "params": [ { "name": "automatic_tax", "value": "", "type": "query", "description": "Settings for automatic tax lookup for this invoice preview." }, { "name": "coupon", "value": "", "type": "query", "description": "The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string." }, { "name": "currency", "value": "", "type": "query", "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified." }, { "name": "customer", "value": "", "type": "query", "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set." }, { "name": "customer_details", "value": "", "type": "query", "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set." }, { "name": "discounts", "value": "", "type": "query", "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "invoice_items", "value": "", "type": "query", "description": "List of invoice items to add or update in the upcoming invoice preview." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "schedule", "value": "", "type": "query", "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "subscription", "value": "", "type": "query", "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions." }, { "name": "subscription_billing_cycle_anchor", "value": "", "type": "query", "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`." }, { "name": "subscription_cancel_at", "value": "", "type": "query", "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, { "name": "subscription_cancel_at_period_end", "value": "", "type": "query", "description": "Boolean indicating whether this subscription should cancel at the end of the current period." }, { "name": "subscription_cancel_now", "value": "", "type": "query", "description": "This simulates the subscription being canceled or expired immediately." }, { "name": "subscription_default_tax_rates", "value": "", "type": "query", "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set." }, { "name": "subscription_items", "value": "", "type": "query", "description": "A list of up to 20 subscription items, each with an attached price." }, { "name": "subscription_proration_behavior", "value": "", "type": "query", "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`." }, { "name": "subscription_proration_date", "value": "", "type": "query", "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'." }, { "name": "subscription_resume_at", "value": "", "type": "query", "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed." }, { "name": "subscription_start_date", "value": "", "type": "query", "description": "Date a subscription is intended to start (can be future or past)." }, { "name": "subscription_trial_end", "value": "", "type": "query", "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required." }, { "name": "subscription_trial_from_plan", "value": "", "type": "query", "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "
When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
" }, { "info": { "name": "Stripe Get Invoices Invoice", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/invoices/:invoice", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "invoice", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the invoice with the given ID.
" }, { "info": { "name": "Stripe Get Invoices Invoice Lines", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/invoices/:invoice/lines", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "invoice", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
" }, { "info": { "name": "Stripe Get Issuing Authorizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/issuing/authorizations", "params": [ { "name": "card", "value": "", "type": "query", "description": "Only return authorizations that belong to the given card." }, { "name": "cardholder", "value": "", "type": "query", "description": "Only return authorizations that belong to the given cardholder." }, { "name": "created", "value": "", "type": "query", "description": "Only return authorizations that were created during the given date interval." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "status", "value": "", "type": "query", "description": "Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing Authorization object.
Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing Cardholder object.
Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing Card object.
Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing Dispute object.
Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing Settlement object.
Lists all Issuing Token objects for a given card.
Retrieves an Issuing Token object.
Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing Transaction object.
Retrieves the details of a Financial Connections Session
Returns a list of Financial Connections Account objects.
Retrieves the details of an Financial Connections Account.
Lists all owners for a given Account
Returns a list of PaymentIntents.
" }, { "info": { "name": "Stripe Get Payment Intents Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_intents/search", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "page", "value": "", "type": "query", "description": "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." }, { "name": "query", "value": "", "type": "query", "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents)." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
" }, { "info": { "name": "Stripe Get Payment Intents", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_intents/:intent", "params": [ { "name": "client_secret", "value": "", "type": "query", "description": "The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "intent", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the details of a PaymentIntent that has previously been created.
\n\nYou can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.
If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.
" }, { "info": { "name": "Stripe Get Payment Links", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_links", "params": [ { "name": "active", "value": "", "type": "query", "description": "Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links)." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of your payment links.
" }, { "info": { "name": "Stripe Get Payment Links", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_links/:payment_link", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "payment_link", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieve a payment link.
" }, { "info": { "name": "Stripe Get Payment Links Line Items", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_links/:payment_link/line_items", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "payment_link", "value": "", "type": "path" }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "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.
" }, { "info": { "name": "Stripe Get Payment Method Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_method_configurations", "params": [ { "name": "application", "value": "", "type": "query", "description": "The Connect application to filter by." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "List payment method configurations
" }, { "info": { "name": "Stripe Get Payment Method Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_method_configurations/:configuration", "params": [ { "name": "configuration", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieve payment method configuration
" }, { "info": { "name": "Stripe Get Payment Method Domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_method_domains", "params": [ { "name": "domain_name", "value": "", "type": "query", "description": "The domain name that this payment method domain object represents." }, { "name": "enabled", "value": "", "type": "query", "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements" }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Lists the details of existing payment method domains.
" }, { "info": { "name": "Stripe Get Payment Method Domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_method_domains/:payment_method_domain", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "payment_method_domain", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the details of an existing payment method domain.
" }, { "info": { "name": "Stripe Get Payment Methods", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_methods", "params": [ { "name": "customer", "value": "", "type": "query", "description": "The ID of the customer whose PaymentMethods will be retrieved." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "type", "value": "", "type": "query", "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
" }, { "info": { "name": "Stripe Get Payment Methods", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_methods/:payment_method", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "payment_method", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "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
" }, { "info": { "name": "Stripe Get Payouts", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payouts", "params": [ { "name": "arrival_date", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "destination", "value": "", "type": "query", "description": "The ID of an external account - only return payouts sent to this external account." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "status", "value": "", "type": "query", "description": "Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "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.
" }, { "info": { "name": "Stripe Get Payouts", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payouts/:payout", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "payout", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "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.
" }, { "info": { "name": "Stripe Get Plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/plans", "params": [ { "name": "active", "value": "", "type": "query", "description": "Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans)." }, { "name": "created", "value": "", "type": "query", "description": "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." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "product", "value": "", "type": "query", "description": "Only return plans for the given product." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of your plans.
" }, { "info": { "name": "Stripe Get Plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/plans/:plan", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "plan", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the plan with the given ID.
" }, { "info": { "name": "Stripe Get Prices", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/prices", "params": [ { "name": "active", "value": "", "type": "query", "description": "Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices)." }, { "name": "created", "value": "", "type": "query", "description": "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." }, { "name": "currency", "value": "", "type": "query", "description": "Only return prices for the given currency." }, { "name": "ending_before", "value": "", "type": "query", "description": "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." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "lookup_keys", "value": "", "type": "query", "description": "Only return the price with these lookup_keys, if any exist." }, { "name": "product", "value": "", "type": "query", "description": "Only return prices for the given product." }, { "name": "recurring", "value": "", "type": "query", "description": "Only return prices with these recurring fields." }, { "name": "starting_after", "value": "", "type": "query", "description": "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." }, { "name": "type", "value": "", "type": "query", "description": "Only return prices of type `recurring` or `one_time`." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.
Search for prices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
" }, { "info": { "name": "Stripe Get Prices", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/prices/:price", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "price", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the price with the given ID.
" } ] } ], "bundled": true }