@datafire/stripe

Client library for Stripe API

Installation and Usage

npm install --save @datafire/stripe

let stripe = require('@datafire/stripe').create({
  username: "",
  password: "",
  bearerAuth: ""
});

.then(data => {
  console.log(data);
});

Description

The Stripe REST API. Please see https://stripe.com/docs/api for more details.

Actions

Post3dSecure

Initiate 3D Secure authentication.

stripe.Post3dSecure({
  "amount": 0,
  "currency": "",
  "return_url": ""
}, context)

Input

input object
- amount required integer: Amount of the charge that you will create when authentication completes.
- card string: The ID of a card token, or the ID of a card belonging to the given customer.
- currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string: The customer associated with this 3D secure authentication.
- expand array: Specifies which fields in the response should be expanded.
- return_url required string: The URL that the cardholder's browser will be returned to when authentication completes.

Output

output three_d_secure

Get3dSecureThreeDSecure

Retrieves a 3D Secure object.

stripe.Get3dSecureThreeDSecure({
  "three_d_secure": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- three_d_secure required string

Output

output three_d_secure

DeleteAccount

With Connect, you can delete Custom or Express accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

stripe.DeleteAccount({}, context)

Input

input object
- account string

Output

output deleted_account

GetAccount

Retrieves the details of an account.

stripe.GetAccount({}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.

Output

output account

PostAccount

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

stripe.PostAccount({}, context)

Input

input object
- account_token string: An account token, used to securely provide details to the account.
- business_profile object: Business information about the account.
- business_type string (values: company, government_entity, individual, non_profit): The business type.
- capabilities object: Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
- company object: Information about the company or business. This field is available for any business_type.
- default_currency string: Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
- documents object: Documents that may be submitted to satisfy various informational requests.
- email string: The email address of the account holder. This is only to make the account easier to identify to you. Stripe will never directly email Custom accounts.
- expand array: Specifies which fields in the response should be expanded.
- external_account string: A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account parameter for bank account creation.
  
  By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
- individual object: Information about the person represented by the account. This field is null unless business_type is set to individual.
- settings object: Options for customizing how the account functions within Stripe.
- tos_acceptance object: Details on the account's acceptance of the Stripe Services Agreement.

Output

output account

PostAccountBankAccounts

Create an external account for a given account.

stripe.PostAccountBankAccounts({}, context)

Input

input object
- default_for_currency boolean: When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
- expand array: Specifies which fields in the response should be expanded.
- external_account string: Please refer to full documentation instead.
- metadata object: Set of key-value pairs 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.

Output

output external_account

DeleteAccountBankAccountsId

Delete a specified external account for a given account.

stripe.DeleteAccountBankAccountsId({
  "id": ""
}, context)

Input

input object
- id required string

Output

output deleted_external_account

GetAccountBankAccountsId

Retrieve a specified external account for a given account.

stripe.GetAccountBankAccountsId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output external_account

PostAccountBankAccountsId

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

stripe.PostAccountBankAccountsId({
  "id": ""
}, context)

Input

input object
- id required string
- account_holder_name string: The name of the person or business that owns the bank account.
- account_holder_type string (values: , company, individual): The type of entity that holds the account. This can be either individual or company.
- address_city string: City/District/Suburb/Town/Village.
- address_country string: Billing address country, if provided when creating card.
- address_line1 string: Address line 1 (Street address/PO Box/Company name).
- address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
- address_state string: State/County/Province/Region.
- address_zip string: ZIP or postal code.
- default_for_currency boolean: When set to true, this becomes the default external account for its currency.
- exp_month string: Two digit number representing the card’s expiration month.
- exp_year string: Four digit number representing the card’s expiration year.
- expand array: Specifies which fields in the response should be expanded.
- name string: Cardholder name.

Output

output external_account

GetAccountCapabilities

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

stripe.GetAccountCapabilities({}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.

Output

output object
- data required array
  - items capability
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetAccountCapabilitiesCapability

Retrieves information about the specified Account Capability.

stripe.GetAccountCapabilitiesCapability({
  "capability": ""
}, context)

Input

input object
- capability required string
- expand array: Specifies which fields in the response should be expanded.

Output

output capability

PostAccountCapabilitiesCapability

Updates an existing Account Capability.

stripe.PostAccountCapabilitiesCapability({
  "capability": ""
}, context)

Input

input object
- capability required string
- expand array: Specifies which fields in the response should be expanded.
- requested boolean: Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the requirements arrays.

Output

output capability

GetAccountExternalAccounts

List external accounts for an account.

stripe.GetAccountExternalAccounts({}, context)

Input

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

Output

output object
- data required array: The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostAccountExternalAccounts

Create an external account for a given account.

stripe.PostAccountExternalAccounts({}, context)

Input

input object
- default_for_currency boolean: When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
- expand array: Specifies which fields in the response should be expanded.
- external_account string: Please refer to full documentation instead.
- metadata object: Set of key-value pairs 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.

Output

output external_account

DeleteAccountExternalAccountsId

Delete a specified external account for a given account.

stripe.DeleteAccountExternalAccountsId({
  "id": ""
}, context)

Input

input object
- id required string

Output

output deleted_external_account

GetAccountExternalAccountsId

Retrieve a specified external account for a given account.

stripe.GetAccountExternalAccountsId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output external_account

PostAccountExternalAccountsId

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

stripe.PostAccountExternalAccountsId({
  "id": ""
}, context)

Input

input object
- id required string
- account_holder_name string: The name of the person or business that owns the bank account.
- account_holder_type string (values: , company, individual): The type of entity that holds the account. This can be either individual or company.
- address_city string: City/District/Suburb/Town/Village.
- address_country string: Billing address country, if provided when creating card.
- address_line1 string: Address line 1 (Street address/PO Box/Company name).
- address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
- address_state string: State/County/Province/Region.
- address_zip string: ZIP or postal code.
- default_for_currency boolean: When set to true, this becomes the default external account for its currency.
- exp_month string: Two digit number representing the card’s expiration month.
- exp_year string: Four digit number representing the card’s expiration year.
- expand array: Specifies which fields in the response should be expanded.
- name string: Cardholder name.

Output

output external_account

PostAccountLoginLinks

Creates a single-use login link for an Express account to access their Stripe dashboard.

You may only create login links for Express accounts connected to your platform.

stripe.PostAccountLoginLinks({
  "account": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.
- redirect_url string: Where to redirect the user after they log out of their dashboard.

Output

output login_link

PutAccountLogout

Invalidates all sessions for a light account, for a platform to use during platform logout.

You may only log out Express accounts connected to your platform.

stripe.PutAccountLogout({
  "account": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.

Output

output light_account_logout

GetAccountPeople

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

stripe.GetAccountPeople({}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- relationship object: Filters on the list of people returned based on the person's relationship to the account's company.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items person
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostAccountPeople

Creates a new person.

stripe.PostAccountPeople({}, context)

Input

input object
- account string
- address object: The person's address.
- address_kana object: The Kana variation of the person's address (Japan only).
- address_kanji object: The Kanji variation of the person's address (Japan only).
- email string: The person's email address.
- expand array: Specifies which fields in the response should be expanded.
- first_name string: The person's first name.
- first_name_kana string: The Kana variation of the person's first name (Japan only).
- first_name_kanji string: The Kanji variation of the person's first name (Japan only).
- gender string: The person's gender (International regulations require either "male" or "female").
- id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name string: The person's last name.
- last_name_kana string: The Kana variation of the person's last name (Japan only).
- last_name_kanji string: The Kanji variation of the person's last name (Japan only).
- maiden_name string: The person's maiden name.
- person_token string: A person token, used to securely provide details to the person.
- phone string: The person's phone number.
- political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- relationship object: The relationship that this person has with the account's legal entity.
- ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
- verification object: The person's verification status.

Output

output person

DeleteAccountPeoplePerson

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

stripe.DeleteAccountPeoplePerson({
  "person": ""
}, context)

Input

input object
- person required string

Output

output deleted_person

GetAccountPeoplePerson

Retrieves an existing person.

stripe.GetAccountPeoplePerson({
  "person": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- person required string

Output

output person

PostAccountPeoplePerson

Updates an existing person.

stripe.PostAccountPeoplePerson({
  "person": ""
}, context)

Input

input object
- person required string
- account string
- address object: The person's address.
- address_kana object: The Kana variation of the person's address (Japan only).
- address_kanji object: The Kanji variation of the person's address (Japan only).
- email string: The person's email address.
- expand array: Specifies which fields in the response should be expanded.
- first_name string: The person's first name.
- first_name_kana string: The Kana variation of the person's first name (Japan only).
- first_name_kanji string: The Kanji variation of the person's first name (Japan only).
- gender string: The person's gender (International regulations require either "male" or "female").
- id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name string: The person's last name.
- last_name_kana string: The Kana variation of the person's last name (Japan only).
- last_name_kanji string: The Kanji variation of the person's last name (Japan only).
- maiden_name string: The person's maiden name.
- person_token string: A person token, used to securely provide details to the person.
- phone string: The person's phone number.
- political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- relationship object: The relationship that this person has with the account's legal entity.
- ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
- verification object: The person's verification status.

Output

output person

GetAccountPersons

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

stripe.GetAccountPersons({}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- relationship object: Filters on the list of people returned based on the person's relationship to the account's company.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items person
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostAccountPersons

Creates a new person.

stripe.PostAccountPersons({}, context)

Input

input object
- account string
- address object: The person's address.
- address_kana object: The Kana variation of the person's address (Japan only).
- address_kanji object: The Kanji variation of the person's address (Japan only).
- email string: The person's email address.
- expand array: Specifies which fields in the response should be expanded.
- first_name string: The person's first name.
- first_name_kana string: The Kana variation of the person's first name (Japan only).
- first_name_kanji string: The Kanji variation of the person's first name (Japan only).
- gender string: The person's gender (International regulations require either "male" or "female").
- id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name string: The person's last name.
- last_name_kana string: The Kana variation of the person's last name (Japan only).
- last_name_kanji string: The Kanji variation of the person's last name (Japan only).
- maiden_name string: The person's maiden name.
- person_token string: A person token, used to securely provide details to the person.
- phone string: The person's phone number.
- political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- relationship object: The relationship that this person has with the account's legal entity.
- ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
- verification object: The person's verification status.

Output

output person

DeleteAccountPersonsPerson

stripe.DeleteAccountPersonsPerson({
  "person": ""
}, context)

Input

input object
- person required string

Output

output deleted_person

GetAccountPersonsPerson

Retrieves an existing person.

stripe.GetAccountPersonsPerson({
  "person": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- person required string

Output

output person

PostAccountPersonsPerson

Updates an existing person.

stripe.PostAccountPersonsPerson({
  "person": ""
}, context)

Input

input object
- person required string
- account string
- address object: The person's address.
- address_kana object: The Kana variation of the person's address (Japan only).
- address_kanji object: The Kanji variation of the person's address (Japan only).
- email string: The person's email address.
- expand array: Specifies which fields in the response should be expanded.
- first_name string: The person's first name.
- first_name_kana string: The Kana variation of the person's first name (Japan only).
- first_name_kanji string: The Kanji variation of the person's first name (Japan only).
- gender string: The person's gender (International regulations require either "male" or "female").
- id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name string: The person's last name.
- last_name_kana string: The Kana variation of the person's last name (Japan only).
- last_name_kanji string: The Kanji variation of the person's last name (Japan only).
- maiden_name string: The person's maiden name.
- person_token string: A person token, used to securely provide details to the person.
- phone string: The person's phone number.
- political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- relationship object: The relationship that this person has with the account's legal entity.
- ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
- verification object: The person's verification status.

Output

output person

PostAccountLinks

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

stripe.PostAccountLinks({
  "account": "",
  "type": ""
}, context)

Input

input object
- account required string: The identifier of the account to create an account link for.
- collect string (values: currently_due, eventually_due): Which information the platform needs to collect from the user. One of currently_due or eventually_due. Default is currently_due.
- expand array: Specifies which fields in the response should be expanded.
- refresh_url string: The URL that the user will be redirected to if the account link is no longer valid. Your refresh_url should trigger a method on your server to create a new account link using this API, with the same parameters, and redirect the user to the new account link.
- return_url string: The URL that the user will be redirected to upon leaving or completing the linked flow.
- type required string (values: account_onboarding, account_update): The type of account link the user is requesting. Possible values are account_onboarding or account_update.

Output

output account_link

GetAccounts

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

stripe.GetAccounts({}, context)

Input

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

Output

output object
- data required array
  - items account
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostAccounts

With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.

stripe.PostAccounts({}, context)

Input

input object
- account_token string: An account token, used to securely provide details to the account.
- business_profile object: Business information about the account.
- business_type string (values: company, government_entity, individual, non_profit): The business type.
- capabilities object: Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
- company object: Information about the company or business. This field is available for any business_type.
- country string: The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use CA as the country for the account being created.
- default_currency string: Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
- documents object: Documents that may be submitted to satisfy various informational requests.
- email string: The email address of the account holder. This is only to make the account easier to identify to you. Stripe will never directly email Custom accounts.
- expand array: Specifies which fields in the response should be expanded.
- external_account string: A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account parameter for bank account creation.
  
  By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
- individual object: Information about the person represented by the account. This field is null unless business_type is set to individual.
- settings object: Options for customizing how the account functions within Stripe.
- tos_acceptance object: Details on the account's acceptance of the Stripe Services Agreement.
- type string (values: custom, express, standard): The type of Stripe account to create. May be one of custom, express or standard.

Output

output account

DeleteAccountsAccount

With Connect, you can delete Custom or Express accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

stripe.DeleteAccountsAccount({
  "account": ""
}, context)

Input

input object
- account required string

Output

output deleted_account

GetAccountsAccount

Retrieves the details of an account.

stripe.GetAccountsAccount({
  "account": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.

Output

output account

PostAccountsAccount

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

stripe.PostAccountsAccount({
  "account": ""
}, context)

Input

input object
- account required string
- account_token string: An account token, used to securely provide details to the account.
- business_profile object: Business information about the account.
- business_type string (values: company, government_entity, individual, non_profit): The business type.
- capabilities object: Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
- company object: Information about the company or business. This field is available for any business_type.
- default_currency string: Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
- documents object: Documents that may be submitted to satisfy various informational requests.
- email string: The email address of the account holder. This is only to make the account easier to identify to you. Stripe will never directly email Custom accounts.
- expand array: Specifies which fields in the response should be expanded.
- external_account string: A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account parameter for bank account creation.
  
  By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
- individual object: Information about the person represented by the account. This field is null unless business_type is set to individual.
- settings object: Options for customizing how the account functions within Stripe.
- tos_acceptance object: Details on the account's acceptance of the Stripe Services Agreement.

Output

output account

PostAccountsAccountBankAccounts

Create an external account for a given account.

stripe.PostAccountsAccountBankAccounts({
  "account": ""
}, context)

Input

input object
- account required string
- default_for_currency boolean: When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
- expand array: Specifies which fields in the response should be expanded.
- external_account string: Please refer to full documentation instead.
- metadata object: Set of key-value pairs 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.

Output

output external_account

DeleteAccountsAccountBankAccountsId

Delete a specified external account for a given account.

stripe.DeleteAccountsAccountBankAccountsId({
  "account": "",
  "id": ""
}, context)

Input

input object
- account required string
- id required string

Output

output deleted_external_account

GetAccountsAccountBankAccountsId

Retrieve a specified external account for a given account.

stripe.GetAccountsAccountBankAccountsId({
  "account": "",
  "id": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output external_account

PostAccountsAccountBankAccountsId

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

stripe.PostAccountsAccountBankAccountsId({
  "account": "",
  "id": ""
}, context)

Input

input object
- account required string
- id required string
- account_holder_name string: The name of the person or business that owns the bank account.
- account_holder_type string (values: , company, individual): The type of entity that holds the account. This can be either individual or company.
- address_city string: City/District/Suburb/Town/Village.
- address_country string: Billing address country, if provided when creating card.
- address_line1 string: Address line 1 (Street address/PO Box/Company name).
- address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
- address_state string: State/County/Province/Region.
- address_zip string: ZIP or postal code.
- default_for_currency boolean: When set to true, this becomes the default external account for its currency.
- exp_month string: Two digit number representing the card’s expiration month.
- exp_year string: Four digit number representing the card’s expiration year.
- expand array: Specifies which fields in the response should be expanded.
- name string: Cardholder name.

Output

output external_account

GetAccountsAccountCapabilities

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

stripe.GetAccountsAccountCapabilities({
  "account": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.

Output

output object
- data required array
  - items capability
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetAccountsAccountCapabilitiesCapability

Retrieves information about the specified Account Capability.

stripe.GetAccountsAccountCapabilitiesCapability({
  "account": "",
  "capability": ""
}, context)

Input

input object
- account required string
- capability required string
- expand array: Specifies which fields in the response should be expanded.

Output

output capability

PostAccountsAccountCapabilitiesCapability

Updates an existing Account Capability.

stripe.PostAccountsAccountCapabilitiesCapability({
  "account": "",
  "capability": ""
}, context)

Input

input object
- account required string
- capability required string
- expand array: Specifies which fields in the response should be expanded.
- requested boolean: Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the requirements arrays.

Output

output capability

GetAccountsAccountExternalAccounts

List external accounts for an account.

stripe.GetAccountsAccountExternalAccounts({
  "account": ""
}, context)

Input

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

Output

output object
- data required array: The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostAccountsAccountExternalAccounts

Create an external account for a given account.

stripe.PostAccountsAccountExternalAccounts({
  "account": ""
}, context)

Input

input object
- account required string
- default_for_currency boolean: When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
- expand array: Specifies which fields in the response should be expanded.
- external_account string: Please refer to full documentation instead.
- metadata object: Set of key-value pairs 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.

Output

output external_account

DeleteAccountsAccountExternalAccountsId

Delete a specified external account for a given account.

stripe.DeleteAccountsAccountExternalAccountsId({
  "account": "",
  "id": ""
}, context)

Input

input object
- account required string
- id required string

Output

output deleted_external_account

GetAccountsAccountExternalAccountsId

Retrieve a specified external account for a given account.

stripe.GetAccountsAccountExternalAccountsId({
  "account": "",
  "id": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output external_account

PostAccountsAccountExternalAccountsId

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

stripe.PostAccountsAccountExternalAccountsId({
  "account": "",
  "id": ""
}, context)

Input

input object
- account required string
- id required string
- account_holder_name string: The name of the person or business that owns the bank account.
- account_holder_type string (values: , company, individual): The type of entity that holds the account. This can be either individual or company.
- address_city string: City/District/Suburb/Town/Village.
- address_country string: Billing address country, if provided when creating card.
- address_line1 string: Address line 1 (Street address/PO Box/Company name).
- address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
- address_state string: State/County/Province/Region.
- address_zip string: ZIP or postal code.
- default_for_currency boolean: When set to true, this becomes the default external account for its currency.
- exp_month string: Two digit number representing the card’s expiration month.
- exp_year string: Four digit number representing the card’s expiration year.
- expand array: Specifies which fields in the response should be expanded.
- name string: Cardholder name.

Output

output external_account

PostAccountsAccountLoginLinks

Creates a single-use login link for an Express account to access their Stripe dashboard.

You may only create login links for Express accounts connected to your platform.

stripe.PostAccountsAccountLoginLinks({
  "account": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.
- redirect_url string: Where to redirect the user after they log out of their dashboard.

Output

output login_link

PutAccountsAccountLogout

Invalidates all sessions for a light account, for a platform to use during platform logout.

You may only log out Express accounts connected to your platform.

stripe.PutAccountsAccountLogout({
  "account": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.

Output

output light_account_logout

GetAccountsAccountPeople

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

stripe.GetAccountsAccountPeople({
  "account": ""
}, context)

Input

input object
- account required string
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- relationship object: Filters on the list of people returned based on the person's relationship to the account's company.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items person
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostAccountsAccountPeople

Creates a new person.

stripe.PostAccountsAccountPeople({
  "account": ""
}, context)

Input

input object
- account required string
- address object: The person's address.
- address_kana object: The Kana variation of the person's address (Japan only).
- address_kanji object: The Kanji variation of the person's address (Japan only).
- email string: The person's email address.
- expand array: Specifies which fields in the response should be expanded.
- first_name string: The person's first name.
- first_name_kana string: The Kana variation of the person's first name (Japan only).
- first_name_kanji string: The Kanji variation of the person's first name (Japan only).
- gender string: The person's gender (International regulations require either "male" or "female").
- id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name string: The person's last name.
- last_name_kana string: The Kana variation of the person's last name (Japan only).
- last_name_kanji string: The Kanji variation of the person's last name (Japan only).
- maiden_name string: The person's maiden name.
- person_token string: A person token, used to securely provide details to the person.
- phone string: The person's phone number.
- political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- relationship object: The relationship that this person has with the account's legal entity.
- ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
- verification object: The person's verification status.

Output

output person

DeleteAccountsAccountPeoplePerson

stripe.DeleteAccountsAccountPeoplePerson({
  "account": "",
  "person": ""
}, context)

Input

input object
- account required string
- person required string

Output

output deleted_person

GetAccountsAccountPeoplePerson

Retrieves an existing person.

stripe.GetAccountsAccountPeoplePerson({
  "account": "",
  "person": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.
- person required string

Output

output person

PostAccountsAccountPeoplePerson

Updates an existing person.

stripe.PostAccountsAccountPeoplePerson({
  "account": "",
  "person": ""
}, context)

Input

input object
- account required string
- person required string
- address object: The person's address.
- address_kana object: The Kana variation of the person's address (Japan only).
- address_kanji object: The Kanji variation of the person's address (Japan only).
- email string: The person's email address.
- expand array: Specifies which fields in the response should be expanded.
- first_name string: The person's first name.
- first_name_kana string: The Kana variation of the person's first name (Japan only).
- first_name_kanji string: The Kanji variation of the person's first name (Japan only).
- gender string: The person's gender (International regulations require either "male" or "female").
- id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name string: The person's last name.
- last_name_kana string: The Kana variation of the person's last name (Japan only).
- last_name_kanji string: The Kanji variation of the person's last name (Japan only).
- maiden_name string: The person's maiden name.
- person_token string: A person token, used to securely provide details to the person.
- phone string: The person's phone number.
- political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- relationship object: The relationship that this person has with the account's legal entity.
- ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
- verification object: The person's verification status.

Output

output person

GetAccountsAccountPersons

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

stripe.GetAccountsAccountPersons({
  "account": ""
}, context)

Input

input object
- account required string
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- relationship object: Filters on the list of people returned based on the person's relationship to the account's company.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items person
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostAccountsAccountPersons

Creates a new person.

stripe.PostAccountsAccountPersons({
  "account": ""
}, context)

Input

input object
- account required string
- address object: The person's address.
- address_kana object: The Kana variation of the person's address (Japan only).
- address_kanji object: The Kanji variation of the person's address (Japan only).
- email string: The person's email address.
- expand array: Specifies which fields in the response should be expanded.
- first_name string: The person's first name.
- first_name_kana string: The Kana variation of the person's first name (Japan only).
- first_name_kanji string: The Kanji variation of the person's first name (Japan only).
- gender string: The person's gender (International regulations require either "male" or "female").
- id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name string: The person's last name.
- last_name_kana string: The Kana variation of the person's last name (Japan only).
- last_name_kanji string: The Kanji variation of the person's last name (Japan only).
- maiden_name string: The person's maiden name.
- person_token string: A person token, used to securely provide details to the person.
- phone string: The person's phone number.
- political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- relationship object: The relationship that this person has with the account's legal entity.
- ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
- verification object: The person's verification status.

Output

output person

DeleteAccountsAccountPersonsPerson

stripe.DeleteAccountsAccountPersonsPerson({
  "account": "",
  "person": ""
}, context)

Input

input object
- account required string
- person required string

Output

output deleted_person

GetAccountsAccountPersonsPerson

Retrieves an existing person.

stripe.GetAccountsAccountPersonsPerson({
  "account": "",
  "person": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.
- person required string

Output

output person

PostAccountsAccountPersonsPerson

Updates an existing person.

stripe.PostAccountsAccountPersonsPerson({
  "account": "",
  "person": ""
}, context)

Input

input object
- account required string
- person required string
- address object: The person's address.
- address_kana object: The Kana variation of the person's address (Japan only).
- address_kanji object: The Kanji variation of the person's address (Japan only).
- email string: The person's email address.
- expand array: Specifies which fields in the response should be expanded.
- first_name string: The person's first name.
- first_name_kana string: The Kana variation of the person's first name (Japan only).
- first_name_kanji string: The Kanji variation of the person's first name (Japan only).
- gender string: The person's gender (International regulations require either "male" or "female").
- id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name string: The person's last name.
- last_name_kana string: The Kana variation of the person's last name (Japan only).
- last_name_kanji string: The Kanji variation of the person's last name (Japan only).
- maiden_name string: The person's maiden name.
- person_token string: A person token, used to securely provide details to the person.
- phone string: The person's phone number.
- political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- relationship object: The relationship that this person has with the account's legal entity.
- ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
- verification object: The person's verification status.

Output

output person

PostAccountsAccountReject

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

stripe.PostAccountsAccountReject({
  "account": "",
  "reason": ""
}, context)

Input

input object
- account required string
- expand array: Specifies which fields in the response should be expanded.
- reason required string: The reason for rejecting the account. Can be fraud, terms_of_service, or other.

Output

output account

GetApplePayDomains

List apple pay domains.

stripe.GetApplePayDomains({}, context)

Input

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

Output

output object
- data required array
  - items apple_pay_domain
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostApplePayDomains

Create an apple pay domain.

stripe.PostApplePayDomains({
  "domain_name": ""
}, context)

Input

input object
- domain_name required string
- expand array: Specifies which fields in the response should be expanded.

Output

output apple_pay_domain

DeleteApplePayDomainsDomain

Delete an apple pay domain.

stripe.DeleteApplePayDomainsDomain({
  "domain": ""
}, context)

Input

input object
- domain required string

Output

output deleted_apple_pay_domain

GetApplePayDomainsDomain

Retrieve an apple pay domain.

stripe.GetApplePayDomainsDomain({
  "domain": ""
}, context)

Input

input object
- domain required string
- expand array: Specifies which fields in the response should be expanded.

Output

output apple_pay_domain

GetApplicationFees

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

stripe.GetApplicationFees({}, context)

Input

input object
- charge string: Only return application fees for the charge specified by this charge ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items application_fee
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetApplicationFeesFeeRefundsId

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

stripe.GetApplicationFeesFeeRefundsId({
  "fee": "",
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- fee required string
- id required string

Output

output fee_refund

PostApplicationFeesFeeRefundsId

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata as an argument.

stripe.PostApplicationFeesFeeRefundsId({
  "fee": "",
  "id": ""
}, context)

Input

input object
- fee required string
- id required string
- expand array: Specifies which fields in the response should be expanded.

Output

output fee_refund

GetApplicationFeesId

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

stripe.GetApplicationFeesId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output application_fee

PostApplicationFeesIdRefund

stripe.PostApplicationFeesIdRefund({
  "id": ""
}, context)

Input

input object
- id required string
- amount integer
- directive string
- expand array: Specifies which fields in the response should be expanded.

Output

output application_fee

GetApplicationFeesIdRefunds

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

stripe.GetApplicationFeesIdRefunds({
  "id": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items fee_refund
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostApplicationFeesIdRefunds

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

stripe.PostApplicationFeesIdRefunds({
  "id": ""
}, context)

Input

input object
- id required string
- amount integer: A positive integer, in %s, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.

Output

output fee_refund

GetBalance

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

stripe.GetBalance({}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.

Output

output balance

GetBalanceHistory

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.

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

stripe.GetBalanceHistory({}, context)

Input

input object
- currency string: Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payout string: For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
- source string: Only returns the original transaction.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- type string: Only returns transactions of the given type. One of: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, 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.

Output

output object
- data required array
  - items balance_transaction
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetBalanceHistoryId

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

stripe.GetBalanceHistoryId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output balance_transaction

GetBalanceTransactions

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

stripe.GetBalanceTransactions({}, context)

Input

input object
- currency string: Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payout string: For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
- source string: Only returns the original transaction.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- type string: Only returns transactions of the given type. One of: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, payment, payment_failure_refund, payment_refund, 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.

Output

output object
- data required array
  - items balance_transaction
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetBalanceTransactionsId

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

stripe.GetBalanceTransactionsId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output balance_transaction

PostBillingPortalSessions

Creates a session of the customer portal.

stripe.PostBillingPortalSessions({
  "customer": ""
}, context)

Input

input object
- customer required string: The ID of an existing customer.
- expand array: Specifies which fields in the response should be expanded.
- return_url string: The URL to which Stripe should send customers when they click on the link to return to your website. This field is required if a default return URL has not been configured for the portal.

Output

output billing_portal.session

GetBitcoinReceivers

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

stripe.GetBitcoinReceivers({}, context)

Input

input object
- active boolean: Filter for active receivers.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- filled boolean: Filter for filled receivers.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- uncaptured_funds boolean: Filter for receivers with uncaptured funds.

Output

output object
- data required array
  - items bitcoin_receiver
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetBitcoinReceiversId

Retrieves the Bitcoin receiver with the given ID.

stripe.GetBitcoinReceiversId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output bitcoin_receiver

GetBitcoinReceiversReceiverTransactions

List bitcoin transacitons for a given receiver.

stripe.GetBitcoinReceiversReceiverTransactions({
  "receiver": ""
}, context)

Input

input object
- customer string: Only return transactions for the customer specified by this customer ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- receiver required string
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array: Details about each object.
  - items bitcoin_transaction
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetBitcoinTransactions

List bitcoin transacitons for a given receiver.

stripe.GetBitcoinTransactions({}, context)

Input

input object
- customer string: Only return transactions for the customer specified by this customer ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- receiver string
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array: Details about each object.
  - items bitcoin_transaction
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetCharges

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

stripe.GetCharges({}, context)

Input

input object
- customer string: Only return charges for the customer specified by this customer ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent string: Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- transfer_group string: Only return charges for this transfer group.

Output

output object
- data required array
  - items charge
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCharges

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

stripe.PostCharges({}, context)

Input

input object
- amount integer: Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
- application_fee integer
- application_fee_amount integer: A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
- capture boolean: Whether to immediately capture the charge. Defaults to true. When false, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire in seven days. For more information, see the authorizing charges and settling later documentation.
- currency string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string: The ID of an existing customer that will be charged in this request.
- description string: An arbitrary string which you can attach to a Charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.
- expand array: Specifies which fields in the response should be expanded.
- on_behalf_of string: The Stripe account ID for which these funds are intended. Automatically set if you use the destination parameter. For details, see Creating Separate Charges and Transfers.
- receipt_email string: The email address to which this charge's receipt will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a Customer, the email address specified here will override the customer's email address. If receipt_email is specified for a charge in live mode, a receipt will be sent regardless of your email settings.
- shipping object: Shipping information for the charge. Helps prevent fraud on charges for physical goods.
- source string: A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the associated customer.
- statement_descriptor string: For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- statement_descriptor_suffix string: Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- transfer_data object: An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
- transfer_group string: A string that identifies this transaction as part of a group. For details, see Grouping transactions.

Output

output charge

GetChargesCharge

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

stripe.GetChargesCharge({
  "charge": ""
}, context)

Input

input object
- charge required string
- expand array: Specifies which fields in the response should be expanded.

Output

output charge

PostChargesCharge

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

stripe.PostChargesCharge({
  "charge": ""
}, context)

Input

input object
- charge required string
- customer string: The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
- description string: An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.
- expand array: Specifies which fields in the response should be expanded.
- fraud_details object: A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a user_report key with a value of fraudulent. If you believe a charge is safe, include a user_report key with a value of safe. Stripe will use the information you send to improve our fraud detection algorithms.
- receipt_email string: This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
- shipping object: Shipping information for the charge. Helps prevent fraud on charges for physical goods.
- transfer_group string: A string that identifies this transaction as part of a group. transfer_group may only be provided if it has not been set. See the Connect documentation for details.

Output

output charge

PostChargesChargeCapture

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

stripe.PostChargesChargeCapture({
  "charge": ""
}, context)

Input

input object
- charge required string
- amount integer: The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.
- application_fee integer: An application fee to add on to this charge.
- application_fee_amount integer: An application fee amount to add on to this charge, which must be less than or equal to the original amount.
- expand array: Specifies which fields in the response should be expanded.
- receipt_email string: The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
- statement_descriptor string: For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- statement_descriptor_suffix string: Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- transfer_data object: An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
- transfer_group string: A string that identifies this transaction as part of a group. transfer_group may only be provided if it has not been set. See the Connect documentation for details.

Output

output charge

GetChargesChargeDispute

Retrieve a dispute for a specified charge.

stripe.GetChargesChargeDispute({
  "charge": ""
}, context)

Input

input object
- charge required string
- expand array: Specifies which fields in the response should be expanded.

Output

output dispute

PostChargesChargeDispute

stripe.PostChargesChargeDispute({
  "charge": ""
}, context)

Input

input object
- charge required string
- evidence object: Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.
- expand array: Specifies which fields in the response should be expanded.
- submit boolean: Whether to immediately submit evidence to the bank. If false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to true (the default).

Output

output dispute

PostChargesChargeDisputeClose

stripe.PostChargesChargeDisputeClose({
  "charge": ""
}, context)

Input

input object
- charge required string
- expand array: Specifies which fields in the response should be expanded.

Output

output dispute

PostChargesChargeRefund

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

stripe.PostChargesChargeRefund({
  "charge": ""
}, context)

Input

input object
- charge required string
- amount integer
- expand array: Specifies which fields in the response should be expanded.
- payment_intent string
- reason string (values: duplicate, fraudulent, requested_by_customer)
- refund_application_fee boolean
- reverse_transfer boolean

Output

output charge

GetChargesChargeRefunds

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

stripe.GetChargesChargeRefunds({
  "charge": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items refund
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostChargesChargeRefunds

Create a refund.

stripe.PostChargesChargeRefunds({
  "charge": ""
}, context)

Input

input object
- charge required string
- amount integer
- expand array: Specifies which fields in the response should be expanded.
- payment_intent string
- reason string (values: duplicate, fraudulent, requested_by_customer)
- refund_application_fee boolean
- reverse_transfer boolean

Output

output refund

GetChargesChargeRefundsRefund

Retrieves the details of an existing refund.

stripe.GetChargesChargeRefundsRefund({
  "charge": "",
  "refund": ""
}, context)

Input

input object
- charge required string
- expand array: Specifies which fields in the response should be expanded.
- refund required string

Output

output refund

PostChargesChargeRefundsRefund

Update a specified refund.

stripe.PostChargesChargeRefundsRefund({
  "charge": "",
  "refund": ""
}, context)

Input

input object
- charge required string
- refund required string
- expand array: Specifies which fields in the response should be expanded.

Output

output refund

GetCheckoutSessions

Returns a list of Checkout Sessions.

stripe.GetCheckoutSessions({}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent string: Only return the Checkout Session for the PaymentIntent specified.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- subscription string: Only return the Checkout Session for the subscription specified.

Output

output object
- data required array
  - items checkout.session
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCheckoutSessions

Creates a Session object.

stripe.PostCheckoutSessions({
  "cancel_url": "",
  "payment_method_types": [],
  "success_url": ""
}, context)

Input

input object
- allow_promotion_codes boolean: Enables user redeemable promotion codes.
- billing_address_collection string (values: auto, required): Specify whether Checkout should collect the customer's billing address.
- cancel_url required string: The URL the customer will be directed to if they decide to cancel payment and return to your website.
- client_reference_id string: A unique string to reference the Checkout Session. This can be a
- customer string: ID of an existing customer, if one exists. The email stored on the
- customer_email string: If provided, this value will be used when the Customer object is created.
- discounts array: The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
- expand array: Specifies which fields in the response should be expanded.
- line_items array: A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices.
- locale string (values: auto, bg, cs, da, de, el, en, en-GB, es, es-419, et, fi, fr, fr-CA, hu, id, it, ja, lt, lv, ms, mt, nb, nl, pl, pt, pt-BR, ro, ru, sk, sl, sv, tr, zh, zh-HK, zh-TW): The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.
- metadata object: Set of key-value pairs 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.
- mode string (values: payment, setup, subscription): The mode of the Checkout Session. Required when using prices or setup mode. Pass subscription if the Checkout Session includes at least one recurring item.
- payment_intent_data object: A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.
- payment_method_types required array: A list of the types of payment methods (e.g., card) this Checkout Session can accept.
- setup_intent_data object: A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in setup mode.
- shipping_address_collection object: When set, provides configuration for Checkout to collect a shipping address from a customer.
- submit_type string (values: auto, book, donate, pay): Describes the type of transaction being performed by Checkout in order to customize
- subscription_data object: A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription mode.
- success_url required string: The URL to which Stripe should send customers when payment or setup

Output

output checkout.session

GetCheckoutSessionsSession

Retrieves a Session object.

stripe.GetCheckoutSessionsSession({
  "session": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- session required string

Output

output checkout.session

GetCheckoutSessionsSessionLineItems

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.

stripe.GetCheckoutSessionsSessionLineItems({
  "session": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items item
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetCountrySpecs

Lists all Country Spec objects available in the API.

stripe.GetCountrySpecs({}, context)

Input

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

Output

output object
- data required array
  - items country_spec
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetCountrySpecsCountry

Returns a Country Spec for a given Country code.

stripe.GetCountrySpecsCountry({
  "country": ""
}, context)

Input

input object
- country required string
- expand array: Specifies which fields in the response should be expanded.

Output

output country_spec

GetCoupons

Returns a list of your coupons.

stripe.GetCoupons({}, context)

Input

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

Output

output object
- data required array
  - items coupon
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCoupons

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

stripe.PostCoupons({
  "duration": ""
}, context)

Input

input object
- amount_off integer: A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed).
- applies_to object: A hash containing directions for what this Coupon will apply discounts to.
- currency string: Three-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed).
- duration required string (values: forever, once, repeating): Specifies how long the discount will be in effect. Can be forever, once, or repeating.
- duration_in_months integer: Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
- expand array: Specifies which fields in the response should be expanded.
- id string: Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
- max_redemptions integer: A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
- name string: Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the id is shown if name is not set.
- percent_off number: A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amount_off is not passed).
- redeem_by integer: Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.

Output

output coupon

DeleteCouponsCoupon

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

stripe.DeleteCouponsCoupon({
  "coupon": ""
}, context)

Input

input object
- coupon required string

Output

output deleted_coupon

GetCouponsCoupon

Retrieves the coupon with the given ID.

stripe.GetCouponsCoupon({
  "coupon": ""
}, context)

Input

input object
- coupon required string
- expand array: Specifies which fields in the response should be expanded.

Output

output coupon

PostCouponsCoupon

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

stripe.PostCouponsCoupon({
  "coupon": ""
}, context)

Input

input object
- coupon required string
- expand array: Specifies which fields in the response should be expanded.
- name string: Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the id is shown if name is not set.

Output

output coupon

GetCreditNotes

Returns a list of credit notes.

stripe.GetCreditNotes({}, context)

Input

input object
- customer string: Only return credit notes for the customer specified by this customer ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- invoice string: Only return credit notes for the invoice specified by this invoice ID.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items credit_note
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCreditNotes

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result in any combination of the following:

Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

stripe.PostCreditNotes({
  "invoice": ""
}, context)

Input

input object
- amount integer: The integer amount in %s representing the total amount of the credit note.
- credit_amount integer: The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
- expand array: Specifies which fields in the response should be expanded.
- invoice required string: ID of the invoice.
- lines array: Line items that make up the credit note.
- memo string: The credit note's memo appears on the credit note PDF.
- metadata object: Set of key-value pairs 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.
- out_of_band_amount integer: The integer amount in %s representing the amount that is credited outside of Stripe.
- reason string (values: duplicate, fraudulent, order_change, product_unsatisfactory): Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
- refund string: ID of an existing refund to link this credit note to.
- refund_amount integer: The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

Output

output credit_note

GetCreditNotesPreview

Get a preview of a credit note without creating it.

stripe.GetCreditNotesPreview({
  "invoice": ""
}, context)

Input

input object
- amount integer: The integer amount in %s representing the total amount of the credit note.
- credit_amount integer: The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
- expand array: Specifies which fields in the response should be expanded.
- invoice required string: ID of the invoice.
- lines array: Line items that make up the credit note.
- memo string: The credit note's memo appears on the credit note PDF.
- metadata object: Set of key-value pairs 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.
- out_of_band_amount integer: The integer amount in %s representing the amount that is credited outside of Stripe.
- reason string (values: duplicate, fraudulent, order_change, product_unsatisfactory): Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
- refund string: ID of an existing refund to link this credit note to.
- refund_amount integer: The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

Output

output credit_note

GetCreditNotesPreviewLines

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.

stripe.GetCreditNotesPreviewLines({
  "invoice": ""
}, context)

Input

input object
- amount integer: The integer amount in %s representing the total amount of the credit note.
- credit_amount integer: The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- invoice required string: ID of the invoice.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- lines array: Line items that make up the credit note.
- memo string: The credit note's memo appears on the credit note PDF.
- metadata object: Set of key-value pairs 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.
- out_of_band_amount integer: The integer amount in %s representing the amount that is credited outside of Stripe.
- reason string (values: duplicate, fraudulent, order_change, product_unsatisfactory): Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
- refund string: ID of an existing refund to link this credit note to.
- refund_amount integer: The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array: Details about each object.
  - items credit_note_line_item
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetCreditNotesCreditNoteLines

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.

stripe.GetCreditNotesCreditNoteLines({
  "credit_note": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items credit_note_line_item
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetCreditNotesId

Retrieves the credit note object with the given identifier.

stripe.GetCreditNotesId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output credit_note

PostCreditNotesId

Updates an existing credit note.

stripe.PostCreditNotesId({
  "id": ""
}, context)

Input

input object
- id required string
- expand array: Specifies which fields in the response should be expanded.
- memo string: Credit note memo.
- metadata object: Set of key-value pairs 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.

Output

output credit_note

PostCreditNotesIdVoid

Marks a credit note as void. Learn more about voiding credit notes.

stripe.PostCreditNotesIdVoid({
  "id": ""
}, context)

Input

input object
- id required string
- expand array: Specifies which fields in the response should be expanded.

Output

output credit_note

GetCustomers

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

stripe.GetCustomers({}, context)

Input

input object
- email string: A case-sensitive filter on the list based on the customer's email field. The value must be a string.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items customer
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCustomers

Creates a new customer object.

stripe.PostCustomers({}, context)

Input

input object
- balance integer: An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
- coupon string
- description string: An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
- email string: Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
- expand array: Specifies which fields in the response should be expanded.
- invoice_prefix string: The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
- invoice_settings object: Default invoice settings for this customer.
- name string: The customer's full name or business name.
- next_invoice_sequence integer: The sequence to be used on the customer's next invoice. Defaults to 1.
- payment_method string
- phone string: The customer's phone number.
- preferred_locales array: Customer's preferred languages, ordered by preference.
- promotion_code string: The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
- source string
- tax_exempt string (values: , exempt, none, reverse): The customer's tax exemption. One of none, exempt, or reverse.
- tax_id_data array: The customer's tax IDs.

Output

output customer

DeleteCustomersCustomer

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

stripe.DeleteCustomersCustomer({
  "customer": ""
}, context)

Input

input object
- customer required string

Output

output deleted_customer

GetCustomersCustomer

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

stripe.GetCustomersCustomer({
  "customer": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.

Output

Output schema unknown

PostCustomersCustomer

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

This request accepts mostly the same arguments as the customer creation call.

stripe.PostCustomersCustomer({
  "customer": ""
}, context)

Input

input object
- customer required string
- balance integer: An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
- coupon string
- default_alipay_account string: ID of Alipay account to make the customer's new default for invoice payments.
- default_bank_account string: ID of bank account to make the customer's new default for invoice payments.
- default_card string: ID of card to make the customer's new default for invoice payments.
- default_source string: If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method parameter.
- description string: An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
- email string: Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
- expand array: Specifies which fields in the response should be expanded.
- invoice_prefix string: The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
- invoice_settings object: Default invoice settings for this customer.
- name string: The customer's full name or business name.
- next_invoice_sequence integer: The sequence to be used on the customer's next invoice. Defaults to 1.
- phone string: The customer's phone number.
- preferred_locales array: Customer's preferred languages, ordered by preference.
- promotion_code string: The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
- source string
- tax_exempt string (values: , exempt, none, reverse): The customer's tax exemption. One of none, exempt, or reverse.

Output

output customer

GetCustomersCustomerBalanceTransactions

Returns a list of transactions that updated the customer’s balances.

stripe.GetCustomersCustomerBalanceTransactions({
  "customer": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items customer_balance_transaction
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCustomersCustomerBalanceTransactions

Creates an immutable transaction that updates the customer’s credit balance.

stripe.PostCustomersCustomerBalanceTransactions({
  "customer": "",
  "amount": 0,
  "currency": ""
}, context)

Input

input object
- customer required string
- amount required integer: The integer amount in %s to apply to the customer's credit balance.
- currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency. If the customer's currency is set, this value must match it. If the customer's currency is not set, it will be updated to this value.
- description string: An arbitrary string attached to the object. Often useful for displaying to users.
- expand array: Specifies which fields in the response should be expanded.

Output

output customer_balance_transaction

GetCustomersCustomerBalanceTransactionsTransaction

Retrieves a specific customer balance transaction that updated the customer’s balances.

stripe.GetCustomersCustomerBalanceTransactionsTransaction({
  "customer": "",
  "transaction": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.
- transaction required string

Output

output customer_balance_transaction

PostCustomersCustomerBalanceTransactionsTransaction

Most credit balance transaction fields are immutable, but you may update its description and metadata.

stripe.PostCustomersCustomerBalanceTransactionsTransaction({
  "customer": "",
  "transaction": ""
}, context)

Input

input object
- customer required string
- transaction required string
- description string: An arbitrary string attached to the object. Often useful for displaying to users.
- expand array: Specifies which fields in the response should be expanded.

Output

output customer_balance_transaction

GetCustomersCustomerBankAccounts

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.

stripe.GetCustomersCustomerBankAccounts({
  "customer": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items bank_account
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCustomersCustomerBankAccounts

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

stripe.PostCustomersCustomerBankAccounts({
  "customer": ""
}, context)

Input

input object
- customer required string
- alipay_account string: A token returned by Stripe.js representing the user’s Alipay account details.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.
- source string: Please refer to full documentation instead.

Output

output payment_source

DeleteCustomersCustomerBankAccountsId

Delete a specified source for a given customer.

stripe.DeleteCustomersCustomerBankAccountsId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string
- expand array: Specifies which fields in the response should be expanded.

Output

Output schema unknown

GetCustomersCustomerBankAccountsId

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.

stripe.GetCustomersCustomerBankAccountsId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output bank_account

PostCustomersCustomerBankAccountsId

Update a specified source for a given customer.

stripe.PostCustomersCustomerBankAccountsId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string
- account_holder_name string: The name of the person or business that owns the bank account.
- account_holder_type string (values: company, individual): The type of entity that holds the account. This can be either individual or company.
- address_city string: City/District/Suburb/Town/Village.
- address_country string: Billing address country, if provided when creating card.
- address_line1 string: Address line 1 (Street address/PO Box/Company name).
- address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
- address_state string: State/County/Province/Region.
- address_zip string: ZIP or postal code.
- exp_month string: Two digit number representing the card’s expiration month.
- exp_year string: Four digit number representing the card’s expiration year.
- expand array: Specifies which fields in the response should be expanded.
- name string: Cardholder name.
- owner object

Output

Output schema unknown

PostCustomersCustomerBankAccountsIdVerify

Verify a specified bank account for a given customer.

stripe.PostCustomersCustomerBankAccountsIdVerify({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string
- amounts array: Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
- expand array: Specifies which fields in the response should be expanded.

Output

output bank_account

GetCustomersCustomerCards

You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the Customer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

stripe.GetCustomersCustomerCards({
  "customer": ""
}, context)

Input

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

Output

output object
- data required array
  - items card
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCustomersCustomerCards

When you create a new credit card, you must specify a customer or recipient on which to create it.

stripe.PostCustomersCustomerCards({
  "customer": ""
}, context)

Input

input object
- customer required string
- alipay_account string: A token returned by Stripe.js representing the user’s Alipay account details.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.
- source string: Please refer to full documentation instead.

Output

output payment_source

DeleteCustomersCustomerCardsId

Delete a specified source for a given customer.

stripe.DeleteCustomersCustomerCardsId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string
- expand array: Specifies which fields in the response should be expanded.

Output

Output schema unknown

GetCustomersCustomerCardsId

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.

stripe.GetCustomersCustomerCardsId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output card

PostCustomersCustomerCardsId

Update a specified source for a given customer.

stripe.PostCustomersCustomerCardsId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string
- account_holder_name string: The name of the person or business that owns the bank account.
- account_holder_type string (values: company, individual): The type of entity that holds the account. This can be either individual or company.
- address_city string: City/District/Suburb/Town/Village.
- address_country string: Billing address country, if provided when creating card.
- address_line1 string: Address line 1 (Street address/PO Box/Company name).
- address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
- address_state string: State/County/Province/Region.
- address_zip string: ZIP or postal code.
- exp_month string: Two digit number representing the card’s expiration month.
- exp_year string: Four digit number representing the card’s expiration year.
- expand array: Specifies which fields in the response should be expanded.
- name string: Cardholder name.
- owner object

Output

Output schema unknown

DeleteCustomersCustomerDiscount

Removes the currently applied discount on a customer.

stripe.DeleteCustomersCustomerDiscount({
  "customer": ""
}, context)

Input

input object
- customer required string

Output

output deleted_discount

GetCustomersCustomerDiscount

stripe.GetCustomersCustomerDiscount({
  "customer": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.

Output

output discount

GetCustomersCustomerSources

List sources for a specified customer.

stripe.GetCustomersCustomerSources({
  "customer": ""
}, context)

Input

input object
- customer required string
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- object string: Filter sources according to a particular object type.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array: Details about each object.
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCustomersCustomerSources

When you create a new credit card, you must specify a customer or recipient on which to create it.

stripe.PostCustomersCustomerSources({
  "customer": ""
}, context)

Input

input object
- customer required string
- alipay_account string: A token returned by Stripe.js representing the user’s Alipay account details.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.
- source string: Please refer to full documentation instead.

Output

output payment_source

DeleteCustomersCustomerSourcesId

Delete a specified source for a given customer.

stripe.DeleteCustomersCustomerSourcesId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string
- expand array: Specifies which fields in the response should be expanded.

Output

Output schema unknown

GetCustomersCustomerSourcesId

Retrieve a specified source for a given customer.

stripe.GetCustomersCustomerSourcesId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output payment_source

PostCustomersCustomerSourcesId

Update a specified source for a given customer.

stripe.PostCustomersCustomerSourcesId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string
- account_holder_name string: The name of the person or business that owns the bank account.
- account_holder_type string (values: company, individual): The type of entity that holds the account. This can be either individual or company.
- address_city string: City/District/Suburb/Town/Village.
- address_country string: Billing address country, if provided when creating card.
- address_line1 string: Address line 1 (Street address/PO Box/Company name).
- address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
- address_state string: State/County/Province/Region.
- address_zip string: ZIP or postal code.
- exp_month string: Two digit number representing the card’s expiration month.
- exp_year string: Four digit number representing the card’s expiration year.
- expand array: Specifies which fields in the response should be expanded.
- name string: Cardholder name.
- owner object

Output

Output schema unknown

PostCustomersCustomerSourcesIdVerify

Verify a specified bank account for a given customer.

stripe.PostCustomersCustomerSourcesIdVerify({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string
- amounts array: Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
- expand array: Specifies which fields in the response should be expanded.

Output

output bank_account

GetCustomersCustomerSubscriptions

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.

stripe.GetCustomersCustomerSubscriptions({
  "customer": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items subscription
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCustomersCustomerSubscriptions

Creates a new subscription on an existing customer.

stripe.PostCustomersCustomerSubscriptions({
  "customer": ""
}, context)

Input

input object
- customer required string
- add_invoice_items array: A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 10 items.
- application_fee_percent number: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.
- backdate_start_date integer: For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
- billing_cycle_anchor integer: A future timestamp to anchor the subscription's 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.
- cancel_at integer: 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.
- cancel_at_period_end boolean: Boolean indicating whether this subscription should cancel at the end of the current period.
- collection_method string (values: charge_automatically, send_invoice): Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to charge_automatically.
- coupon string: The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
- days_until_due integer: Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.
- default_payment_method string: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- default_source string: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- expand array: Specifies which fields in the response should be expanded.
- items array: A list of up to 20 subscription items, each with an attached price.
- off_session boolean: Indicates if a customer is on or off-session while an invoice payment is attempted.
- payment_behavior string (values: allow_incomplete, error_if_incomplete, pending_if_incomplete): Use allow_incomplete to create subscriptions with status=incomplete if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.
- promotion_code string: The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
- proration_behavior string (values: always_invoice, create_prorations, none): Determines how to handle prorations resulting from the billing_cycle_anchor. Valid values are create_prorations or none.
- transfer_data object: If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
- trial_from_plan boolean: Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed.
- trial_period_days integer: Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan.

Output

output subscription

DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

stripe.DeleteCustomersCustomerSubscriptionsSubscriptionExposedId({
  "customer": "",
  "subscription_exposed_id": ""
}, context)

Input

input object
- customer required string
- subscription_exposed_id required string
- expand array: Specifies which fields in the response should be expanded.
- invoice_now boolean: Can be set to true if at_period_end is not set to true. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.
- prorate boolean: Can be set to true if at_period_end is not set to true. Will generate a proration invoice item that credits remaining unused time until the subscription period end.

Output

output subscription

GetCustomersCustomerSubscriptionsSubscriptionExposedId

Retrieves the subscription with the given ID.

stripe.GetCustomersCustomerSubscriptionsSubscriptionExposedId({
  "customer": "",
  "subscription_exposed_id": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.
- subscription_exposed_id required string

Output

output subscription

PostCustomersCustomerSubscriptionsSubscriptionExposedId

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

stripe.PostCustomersCustomerSubscriptionsSubscriptionExposedId({
  "customer": "",
  "subscription_exposed_id": ""
}, context)

Input

input object
- customer required string
- subscription_exposed_id required string
- add_invoice_items array: A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 10 items.
- application_fee_percent number: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.
- billing_cycle_anchor string (values: now, unchanged): Either now or unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle documentation.
- cancel_at_period_end boolean: Boolean indicating whether this subscription should cancel at the end of the current period.
- collection_method string (values: charge_automatically, send_invoice): Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to charge_automatically.
- coupon string: The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
- days_until_due integer: Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.
- default_payment_method string: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- default_source string: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- expand array: Specifies which fields in the response should be expanded.
- items array: A list of up to 20 subscription items, each with an attached price.
- off_session boolean: Indicates if a customer is on or off-session while an invoice payment is attempted.
- payment_behavior string (values: allow_incomplete, error_if_incomplete, pending_if_incomplete): Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.
- promotion_code string: The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
- proration_behavior string (values: always_invoice, create_prorations, none): Determines how to handle 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. Valid values are create_prorations, none, or always_invoice.
- proration_date integer: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with upcoming invoice endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
- trial_from_plan boolean: Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed.

Output

output subscription

DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount

Removes the currently applied discount on a customer.

stripe.DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount({
  "customer": "",
  "subscription_exposed_id": ""
}, context)

Input

input object
- customer required string
- subscription_exposed_id required string

Output

output deleted_discount

GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount

stripe.GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount({
  "customer": "",
  "subscription_exposed_id": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.
- subscription_exposed_id required string

Output

output discount

GetCustomersCustomerTaxIds

Returns a list of tax IDs for a customer.

stripe.GetCustomersCustomerTaxIds({
  "customer": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items tax_id
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostCustomersCustomerTaxIds

Creates a new TaxID object for a customer.

stripe.PostCustomersCustomerTaxIds({
  "customer": "",
  "type": "",
  "value": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.
- type required string (values: ae_trn, au_abn, br_cnpj, br_cpf, ca_bn, ca_qst, ch_vat, cl_tin, es_cif, eu_vat, hk_br, id_npwp, in_gst, jp_cn, jp_rn, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, th_vat, tw_vat, us_ein, za_vat): Type of the tax ID, one of ae_trn, au_abn, br_cnpj, br_cpf, ca_bn, ca_qst, ch_vat, cl_tin, es_cif, eu_vat, hk_br, id_npwp, in_gst, jp_cn, jp_rn, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, th_vat, tw_vat, us_ein, or za_vat
- value required string: Value of the tax ID.

Output

output tax_id

DeleteCustomersCustomerTaxIdsId

Deletes an existing TaxID object.

stripe.DeleteCustomersCustomerTaxIdsId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- id required string

Output

output deleted_tax_id

GetCustomersCustomerTaxIdsId

Retrieves the TaxID object with the given identifier.

stripe.GetCustomersCustomerTaxIdsId({
  "customer": "",
  "id": ""
}, context)

Input

input object
- customer required string
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output tax_id

GetDisputes

Returns a list of your disputes.

stripe.GetDisputes({}, context)

Input

input object
- charge string: Only return disputes associated to the charge specified by this charge ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent string: Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items dispute
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetDisputesDispute

Retrieves the dispute with the given ID.

stripe.GetDisputesDispute({
  "dispute": ""
}, context)

Input

input object
- dispute required string
- expand array: Specifies which fields in the response should be expanded.

Output

output dispute

PostDisputesDispute

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

stripe.PostDisputesDispute({
  "dispute": ""
}, context)

Input

input object
- dispute required string
- evidence object: Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.
- expand array: Specifies which fields in the response should be expanded.
- submit boolean: Whether to immediately submit evidence to the bank. If false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to true (the default).

Output

output dispute

PostDisputesDisputeClose

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

stripe.PostDisputesDisputeClose({
  "dispute": ""
}, context)

Input

input object
- dispute required string
- expand array: Specifies which fields in the response should be expanded.

Output

output dispute

PostEphemeralKeys

Creates a short-lived API key for a given resource.

stripe.PostEphemeralKeys({}, context)

Input

input object
- customer string: The ID of the Customer you'd like to modify using the resulting ephemeral key.
- expand array: Specifies which fields in the response should be expanded.
- issuing_card string: The ID of the Issuing Card you'd like to access using the resulting ephemeral key.

Output

output ephemeral_key

DeleteEphemeralKeysKey

Invalidates a short-lived API key for a given resource.

stripe.DeleteEphemeralKeysKey({
  "key": ""
}, context)

Input

input object
- key required string
- expand array: Specifies which fields in the response should be expanded.

Output

output ephemeral_key

GetEvents

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).

stripe.GetEvents({}, context)

Input

input object
- delivery_success boolean: 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.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- type string: 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.
- types array: 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.

Output

output object
- data required array
  - items event
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetEventsId

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

stripe.GetEventsId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output event

GetExchangeRates

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.

stripe.GetExchangeRates({}, context)

Input

input object
- ending_before string: 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.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: 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.
- starting_after string: 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.

Output

output object
- data required array
  - items exchange_rate
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetExchangeRatesRateId

Retrieves the exchange rates from the given currency to every supported currency.

stripe.GetExchangeRatesRateId({
  "rate_id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- rate_id required string

Output

output exchange_rate

GetFileLinks

Returns a list of file links.

stripe.GetFileLinks({}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- expired boolean: Filter links by their expiration status. By default, all links are returned.
- file string: Only return links for the given file.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items file_link
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostFileLinks

Creates a new file link object.

stripe.PostFileLinks({
  "file": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- expires_at integer: A future timestamp after which the link will no longer be usable.
- file required string: The ID of the file. The file's purpose must be one of the following: business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, pci_document, sigma_scheduled_query, or tax_document_user_upload.

Output

output file_link

GetFileLinksLink

Retrieves the file link with the given ID.

stripe.GetFileLinksLink({
  "link": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- link required string

Output

output file_link

PostFileLinksLink

Updates an existing file link object. Expired links can no longer be updated.

stripe.PostFileLinksLink({
  "link": ""
}, context)

Input

input object
- link required string
- expand array: Specifies which fields in the response should be expanded.

Output

output file_link

GetFiles

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

stripe.GetFiles({}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- purpose string (values: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, document_provider_identity_document, finance_report_run, identity_document, pci_document, sigma_scheduled_query, tax_document_user_upload): The file purpose to filter queries by. If none is provided, files will not be filtered by purpose.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items file
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostFiles

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

stripe.PostFiles({
  "file": "",
  "purpose": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- file required string: A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the multipart/form-data protocol).
- file_link_data object: Optional parameters to automatically create a file link for the newly created file.
- purpose required string (values: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, identity_document, pci_document, tax_document_user_upload): The purpose of the uploaded file.

Output

output file

GetFilesFile

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

stripe.GetFilesFile({
  "file": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- file required string

Output

output file

GetInvoiceitems

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

stripe.GetInvoiceitems({}, context)

Input

input object
- customer string: The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- invoice string: Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- pending boolean: Set to true to only show pending invoice items, which are not yet attached to any invoices. Set to false to only show invoice items already attached to invoices. If unspecified, no filter is applied.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items invoiceitem
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostInvoiceitems

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

stripe.PostInvoiceitems({
  "customer": ""
}, context)

Input

input object
- amount integer: The integer amount in %s of the charge to be applied to the upcoming invoice. Passing in a negative amount will reduce the amount_due on the invoice.
- currency string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer required string: The ID of the customer who will be billed when this invoice item is billed.
- description string: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
- discountable boolean: Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
- expand array: Specifies which fields in the response should be expanded.
- invoice string: The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
- period object: The period associated with this invoice item.
- price string: The ID of the price object.
- price_data object: Data used to generate a new Price object inline.
- quantity integer: Non-negative integer. The quantity of units for the invoice item.
- subscription string: The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
- tax_rates array: The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
- unit_amount integer: The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount will reduce the amount_due on the invoice.
- unit_amount_decimal string: Same as unit_amount, but accepts a decimal value in %s with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

Output

output invoiceitem

DeleteInvoiceitemsInvoiceitem

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

stripe.DeleteInvoiceitemsInvoiceitem({
  "invoiceitem": ""
}, context)

Input

input object
- invoiceitem required string

Output

output deleted_invoiceitem

GetInvoiceitemsInvoiceitem

Retrieves the invoice item with the given ID.

stripe.GetInvoiceitemsInvoiceitem({
  "invoiceitem": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- invoiceitem required string

Output

output invoiceitem

PostInvoiceitemsInvoiceitem

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

stripe.PostInvoiceitemsInvoiceitem({
  "invoiceitem": ""
}, context)

Input

input object
- invoiceitem required string
- amount integer: The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
- description string: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
- discountable boolean: Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.
- expand array: Specifies which fields in the response should be expanded.
- period object: The period associated with this invoice item.
- price string: The ID of the price object.
- price_data object: Data used to generate a new Price object inline.
- quantity integer: Non-negative integer. The quantity of units for the invoice item.
- unit_amount integer: The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
- unit_amount_decimal string: Same as unit_amount, but accepts a decimal value in %s with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

Output

output invoiceitem

GetInvoices

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.

stripe.GetInvoices({}, context)

Input

input object
- collection_method string (values: charge_automatically, send_invoice): The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.
- customer string: Only return invoices for the customer specified by this customer ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- status string (values: draft, open, paid, uncollectible, void): The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
- subscription string: Only return invoices for the subscription specified by this subscription ID.

Output

output object
- data required array
  - items invoice
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostInvoices

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

stripe.PostInvoices({
  "customer": ""
}, context)

Input

input object
- application_fee_amount integer: A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
- auto_advance boolean: Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice's state will not automatically advance without an explicit action.
- collection_method string (values: charge_automatically, send_invoice): Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to charge_automatically.
- customer required string: The ID of the customer who will be billed.
- days_until_due integer: The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
- default_payment_method string: ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
- default_source string: ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
- default_tax_rates array: The tax rates that will apply to any line item that does not have tax_rates set.
- description string: An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
- due_date integer: The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice.
- expand array: Specifies which fields in the response should be expanded.
- footer string: Footer to be displayed on the invoice.
- statement_descriptor string: Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default statement_descriptor will be set to the first subscription item's product's statement_descriptor.
- subscription string: The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected.
- transfer_data object: If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.

Output

output invoice

GetInvoicesUpcoming

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.

Note 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 or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

stripe.GetInvoicesUpcoming({}, context)

Input

input object
- coupon string: 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.
- customer string: The identifier of the customer whose upcoming invoice you'd like to retrieve.
- expand array: Specifies which fields in the response should be expanded.
- invoice_items array: List of invoice items to add or update in the upcoming invoice preview.
- schedule string: The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
- subscription string: 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.
- subscription_cancel_at_period_end boolean: Boolean indicating whether this subscription should cancel at the end of the current period.
- subscription_cancel_now boolean: This simulates the subscription being canceled or expired immediately.
- subscription_items array: A list of up to 20 subscription items, each with an attached price.
- subscription_proration_behavior string (values: always_invoice, create_prorations, none): Determines how to handle 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. Valid values are create_prorations, none, or always_invoice.
- subscription_proration_date integer: 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 cannot be before the subscription was on its current plan. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration_behavior cannot be set to 'none'.
- subscription_start_date integer: Date a subscription is intended to start (can be future or past)
- subscription_trial_from_plan boolean: 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.

Output

output invoice

GetInvoicesUpcomingLines

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.

stripe.GetInvoicesUpcomingLines({}, context)

Input

input object
- coupon string: 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.
- customer string: The identifier of the customer whose upcoming invoice you'd like to retrieve.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- invoice_items array: List of invoice items to add or update in the upcoming invoice preview.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- schedule string: The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- subscription string: 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.
- subscription_cancel_at_period_end boolean: Boolean indicating whether this subscription should cancel at the end of the current period.
- subscription_cancel_now boolean: This simulates the subscription being canceled or expired immediately.
- subscription_items array: A list of up to 20 subscription items, each with an attached price.
- subscription_proration_behavior string (values: always_invoice, create_prorations, none): Determines how to handle 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. Valid values are create_prorations, none, or always_invoice.
- subscription_proration_date integer: 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 cannot be before the subscription was on its current plan. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration_behavior cannot be set to 'none'.
- subscription_start_date integer: Date a subscription is intended to start (can be future or past)
- subscription_trial_from_plan boolean: 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.

Output

output object
- data required array: Details about each object.
  - items line_item
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

DeleteInvoicesInvoice

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

stripe.DeleteInvoicesInvoice({
  "invoice": ""
}, context)

Input

input object
- invoice required string

Output

output deleted_invoice

GetInvoicesInvoice

Retrieves the invoice with the given ID.

stripe.GetInvoicesInvoice({
  "invoice": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- invoice required string

Output

output invoice

PostInvoicesInvoice

Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

stripe.PostInvoicesInvoice({
  "invoice": ""
}, context)

Input

input object
- invoice required string
- application_fee_amount integer: A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
- auto_advance boolean: Controls whether Stripe will perform automatic collection of the invoice.
- collection_method string (values: charge_automatically, send_invoice): Either charge_automatically or send_invoice. This field can be updated only on draft invoices.
- days_until_due integer: The number of days from which the invoice is created until it is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
- default_payment_method string: ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
- default_source string: ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
- description string: An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
- due_date integer: The date on which payment for this invoice is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
- expand array: Specifies which fields in the response should be expanded.
- footer string: Footer to be displayed on the invoice.
- statement_descriptor string: Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default statement_descriptor will be set to the first subscription item's product's statement_descriptor.

Output

output invoice

PostInvoicesInvoiceFinalize

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

stripe.PostInvoicesInvoiceFinalize({
  "invoice": ""
}, context)

Input

input object
- invoice required string
- auto_advance boolean: Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice's state will not automatically advance without an explicit action.
- expand array: Specifies which fields in the response should be expanded.

Output

output invoice

GetInvoicesInvoiceLines

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.

stripe.GetInvoicesInvoiceLines({
  "invoice": ""
}, context)

Input

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

Output

output object
- data required array: Details about each object.
  - items line_item
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostInvoicesInvoiceMarkUncollectible

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

stripe.PostInvoicesInvoiceMarkUncollectible({
  "invoice": ""
}, context)

Input

input object
- invoice required string
- expand array: Specifies which fields in the response should be expanded.

Output

output invoice

PostInvoicesInvoicePay

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

stripe.PostInvoicesInvoicePay({
  "invoice": ""
}, context)

Input

input object
- invoice required string
- expand array: Specifies which fields in the response should be expanded.
- forgive boolean: In cases where the source used to pay the invoice has insufficient funds, passing forgive=true controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.
- off_session boolean: Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to true (off-session).
- paid_out_of_band boolean: Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to false.
- payment_method string: A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
- source string: A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.

Output

output invoice

PostInvoicesInvoiceSend

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

stripe.PostInvoicesInvoiceSend({
  "invoice": ""
}, context)

Input

input object
- invoice required string
- expand array: Specifies which fields in the response should be expanded.

Output

output invoice

PostInvoicesInvoiceVoid

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

stripe.PostInvoicesInvoiceVoid({
  "invoice": ""
}, context)

Input

input object
- invoice required string
- expand array: Specifies which fields in the response should be expanded.

Output

output invoice

GetIssuerFraudRecords

Returns a list of issuer fraud records.

stripe.GetIssuerFraudRecords({}, context)

Input

input object
- charge string: Only return issuer fraud records for the charge specified by this charge ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items issuer_fraud_record
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetIssuerFraudRecordsIssuerFraudRecord

Retrieves the details of an issuer fraud record that has previously been created.

Please refer to the issuer fraud record object reference for more details.

stripe.GetIssuerFraudRecordsIssuerFraudRecord({
  "issuer_fraud_record": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- issuer_fraud_record required string

Output

output issuer_fraud_record

GetIssuingAuthorizations

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.

stripe.GetIssuingAuthorizations({}, context)

Input

input object
- card string: Only return authorizations that belong to the given card.
- cardholder string: Only return authorizations that belong to the given cardholder.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- status string (values: closed, pending, reversed): Only return authorizations with the given status. One of pending, closed, or reversed.

Output

output object
- data required array
  - items issuing.authorization
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetIssuingAuthorizationsAuthorization

Retrieves an Issuing Authorization object.

stripe.GetIssuingAuthorizationsAuthorization({
  "authorization": ""
}, context)

Input

input object
- authorization required string
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.authorization

PostIssuingAuthorizationsAuthorization

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

stripe.PostIssuingAuthorizationsAuthorization({
  "authorization": ""
}, context)

Input

input object
- authorization required string
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.authorization

PostIssuingAuthorizationsAuthorizationApprove

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

stripe.PostIssuingAuthorizationsAuthorizationApprove({
  "authorization": ""
}, context)

Input

input object
- authorization required string
- amount integer: If the authorization's pending_request.is_amount_controllable property is true, you may provide this value to control how much to hold for the authorization. Must be positive (use decline to decline an authorization request).
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.authorization

PostIssuingAuthorizationsAuthorizationDecline

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

stripe.PostIssuingAuthorizationsAuthorizationDecline({
  "authorization": ""
}, context)

Input

input object
- authorization required string
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.authorization

GetIssuingCardholders

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.

stripe.GetIssuingCardholders({}, context)

Input

input object
- email string: Only return cardholders that have the given email address.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- phone_number string: Only return cardholders that have the given phone number.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- status string (values: active, blocked, inactive): Only return cardholders that have the given status. One of active, inactive, or blocked.
- type string (values: company, individual): Only return cardholders that have the given type. One of individual or company.

Output

output object
- data required array
  - items issuing.cardholder
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostIssuingCardholders

Creates a new Issuing Cardholder object that can be issued cards.

stripe.PostIssuingCardholders({
  "billing": {},
  "name": "",
  "type": ""
}, context)

Input

input object
- billing required object: The cardholder's billing address.
- company object: Additional information about a company cardholder.
- email string: The cardholder's email address.
- expand array: Specifies which fields in the response should be expanded.
- individual object: Additional information about an individual cardholder.
- metadata object: Set of key-value pairs 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 required string: The cardholder's name. This will be printed on cards issued to them.
- phone_number string: The cardholder's phone number. This will be transformed to E.164 if it is not provided in that format already.
- spending_controls object: Rules that control spending across this cardholder's cards. Refer to our documentation for more details.
- status string (values: active, inactive): Specifies whether to permit authorizations on this cardholder's cards. Defaults to active.
- type required string (values: company, individual): One of individual or company.

Output

output issuing.cardholder

GetIssuingCardholdersCardholder

Retrieves an Issuing Cardholder object.

stripe.GetIssuingCardholdersCardholder({
  "cardholder": ""
}, context)

Input

input object
- cardholder required string
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.cardholder

PostIssuingCardholdersCardholder

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

stripe.PostIssuingCardholdersCardholder({
  "cardholder": ""
}, context)

Input

input object
- cardholder required string
- billing object: The cardholder's billing address.
- company object: Additional information about a company cardholder.
- email string: The cardholder's email address.
- expand array: Specifies which fields in the response should be expanded.
- individual object: Additional information about an individual cardholder.
- metadata object: Set of key-value pairs 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.
- phone_number string: The cardholder's phone number.
- spending_controls object: Rules that control spending across this cardholder's cards. Refer to our documentation for more details.
- status string (values: active, inactive): Specifies whether to permit authorizations on this cardholder's cards.

Output

output issuing.cardholder

GetIssuingCards

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.

stripe.GetIssuingCards({}, context)

Input

input object
- cardholder string: Only return cards belonging to the Cardholder with the provided ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- exp_month integer: Only return cards that have the given expiration month.
- exp_year integer: Only return cards that have the given expiration year.
- expand array: Specifies which fields in the response should be expanded.
- last4 string: Only return cards that have the given last four digits.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- status string (values: active, canceled, inactive): Only return cards that have the given status. One of active, inactive, or canceled.
- type string (values: physical, virtual): Only return cards that have the given type. One of virtual or physical.

Output

output object
- data required array
  - items issuing.card
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostIssuingCards

Creates an Issuing Card object.

stripe.PostIssuingCards({
  "currency": "",
  "type": ""
}, context)

Input

input object
- cardholder string: The Cardholder object with which the card will be associated.
- currency required string: The currency for the card. This currently must be usd.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.
- replacement_for string: The card this is meant to be a replacement for (if any).
- replacement_reason string (values: damaged, expired, lost, stolen): If replacement_for is specified, this should indicate why that card is being replaced.
- shipping object: The address where the card will be shipped.
- spending_controls object: Rules that control spending for this card. Refer to our documentation for more details.
- status string (values: active, inactive): Whether authorizations can be approved on this card. Defaults to inactive.
- type required string (values: physical, virtual): The type of card to issue. Possible values are physical or virtual.

Output

output issuing.card

GetIssuingCardsCard

Retrieves an Issuing Card object.

stripe.GetIssuingCardsCard({
  "card": ""
}, context)

Input

input object
- card required string
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.card

PostIssuingCardsCard

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

stripe.PostIssuingCardsCard({
  "card": ""
}, context)

Input

input object
- card required string
- cancellation_reason string (values: lost, stolen): Reason why the status of this card is canceled.
- expand array: Specifies which fields in the response should be expanded.
- spending_controls object: Rules that control spending for this card. Refer to our documentation for more details.
- status string (values: active, canceled, inactive): Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as cancellation_reason.

Output

output issuing.card

GetIssuingDisputes

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.

stripe.GetIssuingDisputes({}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- status string (values: expired, lost, submitted, unsubmitted, won): Select Issuing disputes with the given status.
- transaction string: Select the Issuing dispute for the given transaction.

Output

output object
- data required array
  - items issuing.dispute
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostIssuingDisputes

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

stripe.PostIssuingDisputes({
  "transaction": ""
}, context)

Input

input object
- evidence object: Evidence provided for the dispute.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.
- transaction required string: The ID of the issuing transaction to create a dispute for.

Output

output issuing.dispute

GetIssuingDisputesDispute

Retrieves an Issuing Dispute object.

stripe.GetIssuingDisputesDispute({
  "dispute": ""
}, context)

Input

input object
- dispute required string
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.dispute

PostIssuingDisputesDispute

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

stripe.PostIssuingDisputesDispute({
  "dispute": ""
}, context)

Input

input object
- dispute required string
- evidence object: Evidence provided for the dispute.
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.dispute

PostIssuingDisputesDisputeSubmit

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

stripe.PostIssuingDisputesDisputeSubmit({
  "dispute": ""
}, context)

Input

input object
- dispute required string
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.dispute

GetIssuingSettlements

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.

stripe.GetIssuingSettlements({}, context)

Input

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

Output

output object
- data required array
  - items issuing.settlement
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetIssuingSettlementsSettlement

Retrieves an Issuing Settlement object.

stripe.GetIssuingSettlementsSettlement({
  "settlement": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- settlement required string

Output

output issuing.settlement

PostIssuingSettlementsSettlement

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

stripe.PostIssuingSettlementsSettlement({
  "settlement": ""
}, context)

Input

input object
- settlement required string
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.

Output

output issuing.settlement

GetIssuingTransactions

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.

stripe.GetIssuingTransactions({}, context)

Input

input object
- card string: Only return transactions that belong to the given card.
- cardholder string: Only return transactions that belong to the given cardholder.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items issuing.transaction
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetIssuingTransactionsTransaction

Retrieves an Issuing Transaction object.

stripe.GetIssuingTransactionsTransaction({
  "transaction": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- transaction required string

Output

output issuing.transaction

PostIssuingTransactionsTransaction

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

stripe.PostIssuingTransactionsTransaction({
  "transaction": ""
}, context)

Input

input object
- transaction required string
- expand array: Specifies which fields in the response should be expanded.

Output

output issuing.transaction

GetMandatesMandate

Retrieves a Mandate object.

stripe.GetMandatesMandate({
  "mandate": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- mandate required string

Output

output mandate

GetOrderReturns

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

stripe.GetOrderReturns({}, context)

Input

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

Output

output object
- data required array
  - items order_return
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetOrderReturnsId

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

stripe.GetOrderReturnsId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output order_return

GetOrders

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

stripe.GetOrders({}, context)

Input

input object
- customer string: Only return orders for the given customer.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- ids array: Only return orders with the given IDs.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- status string: Only return orders that have the given status. One of created, paid, fulfilled, or refunded.
- status_transitions object: Filter orders based on when they were paid, fulfilled, canceled, or returned.
- upstream_ids array: Only return orders with the given upstream order IDs.

Output

output object
- data required array
  - items order
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostOrders

Creates a new order object.

stripe.PostOrders({
  "currency": ""
}, context)

Input

input object
- coupon string: A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons.
- currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string: The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If email or shipping are also provided, they will override the values retrieved from the customer object.
- email string: The email address of the customer placing the order.
- expand array: Specifies which fields in the response should be expanded.
- items array: List of items constituting the order. An order can have up to 25 items.
- metadata object: Set of key-value pairs 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.
- shipping object: Shipping address for the order. Required if any of the SKUs are for products that have shippable set to true.

Output

output order

GetOrdersId

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

stripe.GetOrdersId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output order

PostOrdersId

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

stripe.PostOrdersId({
  "id": ""
}, context)

Input

input object
- id required string
- coupon string: A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons.
- expand array: Specifies which fields in the response should be expanded.
- selected_shipping_method string: The shipping method to select for fulfilling this order. If specified, must be one of the ids of a shipping method in the shipping_methods array. If specified, will overwrite the existing selected shipping method, updating items as necessary.
- shipping object: Tracking information once the order has been fulfilled.
- status string (values: canceled, created, fulfilled, paid, returned): Current order status. One of created, paid, canceled, fulfilled, or returned. More detail in the Orders Guide.

Output

output order

PostOrdersIdPay

Pay an order by providing a source to create a payment.

stripe.PostOrdersIdPay({
  "id": ""
}, context)

Input

input object
- id required string
- application_fee integer: A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
- customer string: The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either source or customer is required. Otherwise, the specified customer will be charged instead of the one attached to the order.
- email string: The email address of the customer placing the order. Required if not previously specified for the order.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.
- source string: A Token's or a Source's ID, as returned by Elements. If no customer was attached to the order at creation, either source or customer is required. Otherwise, the specified source will be charged intead of the customer attached to the order.

Output

output order

PostOrdersIdReturns

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

stripe.PostOrdersIdReturns({
  "id": ""
}, context)

Input

input object
- id required string
- expand array: Specifies which fields in the response should be expanded.

Output

output order_return

GetPaymentIntents

Returns a list of PaymentIntents.

stripe.GetPaymentIntents({}, context)

Input

input object
- customer string: Only return PaymentIntents for the customer specified by this customer ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items payment_intent
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostPaymentIntents

Creates a PaymentIntent object.

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can read more about the different payment flows available via the Payment Intents API here.

When confirm=true is used during creation, it is equivalent to creating and confirming the PaymentIntent in the same call. You may use any parameters available in the confirm API when confirm=true is supplied.

stripe.PostPaymentIntents({
  "amount": 0,
  "currency": ""
}, context)

Input

input object
- amount required integer: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
- application_fee_amount integer: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.
- capture_method string (values: automatic, manual): Controls when the funds will be captured from the customer's account.
- confirm boolean: Set to true to attempt to confirm this PaymentIntent immediately. This parameter defaults to false. When creating and confirming a PaymentIntent at the same time, parameters available in the confirm API may also be provided.
- confirmation_method string (values: automatic, manual)
- currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string: ID of the Customer this PaymentIntent belongs to, if one exists.
- description string: An arbitrary string attached to the object. Often useful for displaying to users.
- error_on_requires_action boolean: Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication. This parameter can only be used with confirm=true.
- expand array: Specifies which fields in the response should be expanded.
- mandate string: ID of the mandate to be used for this payment. This parameter can only be used with confirm=true.
- mandate_data object: This hash contains details about the Mandate to create. This parameter can only be used with confirm=true.
- metadata object: Set of key-value pairs 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.
- on_behalf_of string: The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.
- payment_method string: ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
- payment_method_data object: If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
- payment_method_options object: Payment-method-specific configuration for this PaymentIntent.
- payment_method_types array: The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"].
- receipt_email string: Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
- return_url string: The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
- setup_future_usage string (values: off_session, on_session): Indicates that you intend to make future payments with this PaymentIntent's payment method.
- shipping object: Shipping information for this PaymentIntent.
- statement_descriptor string: For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- statement_descriptor_suffix string: Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- transfer_data object: The parameters used to automatically create a Transfer when the payment succeeds.
- transfer_group string: A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
- use_stripe_sdk boolean: Set to true only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.

Output

output payment_intent

GetPaymentIntentsIntent

Retrieves the details of a PaymentIntent that has previously been created.

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.

stripe.GetPaymentIntentsIntent({
  "intent": ""
}, context)

Input

input object
- client_secret string: The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source.
- expand array: Specifies which fields in the response should be expanded.
- intent required string

Output

output payment_intent

PostPaymentIntentsIntent

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you may need to confirm the PaymentIntent again. For example, updating the payment_method will always require you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties via the confirm API instead.

stripe.PostPaymentIntentsIntent({
  "intent": ""
}, context)

Input

input object
- intent required string
- amount integer: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
- currency string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string: ID of the Customer this PaymentIntent belongs to, if one exists.
- description string: An arbitrary string attached to the object. Often useful for displaying to users.
- expand array: Specifies which fields in the response should be expanded.
- payment_method string: ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
- payment_method_data object: If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
- payment_method_options object: Payment-method-specific configuration for this PaymentIntent.
- payment_method_types array: The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
- setup_future_usage string (values: , off_session, on_session): Indicates that you intend to make future payments with this PaymentIntent's payment method.
- statement_descriptor string: For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- statement_descriptor_suffix string: Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- transfer_data object: The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.
- transfer_group string: A string that identifies the resulting payment as part of a group. transfer_group may only be provided if it has not been set. See the PaymentIntents use case for connected accounts for details.

Output

output payment_intent

PostPaymentIntentsIntentCancel

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, or requires_action.

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.

stripe.PostPaymentIntentsIntentCancel({
  "intent": ""
}, context)

Input

input object
- intent required string
- cancellation_reason string (values: abandoned, duplicate, fraudulent, requested_by_customer): Reason for canceling this PaymentIntent. Possible values are duplicate, fraudulent, requested_by_customer, or abandoned
- expand array: Specifies which fields in the response should be expanded.

Output

output payment_intent

PostPaymentIntentsIntentCapture

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents will be canceled exactly seven days after they are created.

Learn more about separate authorization and capture.

stripe.PostPaymentIntentsIntentCapture({
  "intent": ""
}, context)

Input

input object
- intent required string
- amount_to_capture integer: The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full amount_capturable if not provided.
- application_fee_amount integer: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.
- expand array: Specifies which fields in the response should be expanded.
- statement_descriptor string: For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- statement_descriptor_suffix string: Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- transfer_data object: The parameters used to automatically create a Transfer when the payment

Output

output payment_intent

PostPaymentIntentsIntentConfirm

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.

If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent will transition to the requires_payment_method status. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual).

If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment.

If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. Read the expanded documentation to learn more about manual confirmation.

stripe.PostPaymentIntentsIntentConfirm({
  "intent": ""
}, context)

Input

input object
- intent required string
- client_secret string: The client secret of the PaymentIntent.
- error_on_requires_action boolean: Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication.
- expand array: Specifies which fields in the response should be expanded.
- mandate string: ID of the mandate to be used for this payment.
- payment_method string: ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
- payment_method_data object: If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
- payment_method_options object: Payment-method-specific configuration for this PaymentIntent.
- payment_method_types array: The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
- return_url string: The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
- setup_future_usage string (values: , off_session, on_session): Indicates that you intend to make future payments with this PaymentIntent's payment method.
- use_stripe_sdk boolean: Set to true only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps.

Output

output payment_intent

GetPaymentMethods

Returns a list of PaymentMethods for a given Customer

stripe.GetPaymentMethods({
  "customer": "",
  "type": ""
}, context)

Input

input object
- customer required string: The ID of the customer whose PaymentMethods will be retrieved.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- type required string (values: alipay, au_becs_debit, bacs_debit, bancontact, card, eps, fpx, giropay, grabpay, ideal, oxxo, p24, sepa_debit, sofort): A required filter on the list, based on the object type field.

Output

output object
- data required array
  - items payment_method
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostPaymentMethods

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

stripe.PostPaymentMethods({}, context)

Input

input object
- alipay object: If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.
- au_becs_debit object: If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
- bacs_debit object: If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
- bancontact object: If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.
- billing_details object: Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
- customer string: The Customer to whom the original PaymentMethod is attached.
- eps object: If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
- expand array: Specifies which fields in the response should be expanded.
- fpx object: If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
- giropay object: If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.
- grabpay object: If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.
- ideal object: If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
- interac_present object: If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.
- metadata object: Set of key-value pairs 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.
- oxxo object: If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.
- p24 object: If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
- payment_method string: The PaymentMethod to share.
- sepa_debit object: If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
- sofort object: If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
- type string (values: alipay, au_becs_debit, bacs_debit, bancontact, card, eps, fpx, giropay, grabpay, ideal, oxxo, p24, sepa_debit, sofort): The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Output

output payment_method

GetPaymentMethodsPaymentMethod

Retrieves a PaymentMethod object.

stripe.GetPaymentMethodsPaymentMethod({
  "payment_method": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- payment_method required string

Output

output payment_method

PostPaymentMethodsPaymentMethod

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

stripe.PostPaymentMethodsPaymentMethod({
  "payment_method": ""
}, context)

Input

input object
- payment_method required string
- billing_details object: Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
- card object: If this is a card PaymentMethod, this hash contains the user's card details.
- expand array: Specifies which fields in the response should be expanded.

Output

output payment_method

PostPaymentMethodsPaymentMethodAttach

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to ensure that the PaymentMethod can be used in a future payment. Using the /v1/payment_methods/:id/attach endpoint does not ensure that future payments can be made with the attached PaymentMethod. See Optimizing cards for future payments for more information about setting up future payments.

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

stripe.PostPaymentMethodsPaymentMethodAttach({
  "payment_method": "",
  "customer": ""
}, context)

Input

input object
- payment_method required string
- customer required string: The ID of the customer to which to attach the PaymentMethod.
- expand array: Specifies which fields in the response should be expanded.

Output

output payment_method

PostPaymentMethodsPaymentMethodDetach

Detaches a PaymentMethod object from a Customer.

stripe.PostPaymentMethodsPaymentMethodDetach({
  "payment_method": ""
}, context)

Input

input object
- payment_method required string
- expand array: Specifies which fields in the response should be expanded.

Output

output payment_method

GetPayouts

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

stripe.GetPayouts({}, context)

Input

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

Output

output object
- data required array
  - items payout
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostPayouts

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

stripe.PostPayouts({
  "amount": 0,
  "currency": ""
}, context)

Input

input object
- amount required integer: A positive integer in cents representing how much to payout.
- currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description string: An arbitrary string attached to the object. Often useful for displaying to users.
- destination string: The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.
- method string (values: instant, standard): The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)
- source_type string (values: bank_account, card, fpx): The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of bank_account, card, or fpx.
- statement_descriptor string: A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a statement_descriptor longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.

Output

output payout

GetPayoutsPayout

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

stripe.GetPayoutsPayout({
  "payout": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- payout required string

Output

output payout

PostPayoutsPayout

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

stripe.PostPayoutsPayout({
  "payout": ""
}, context)

Input

input object
- payout required string
- expand array: Specifies which fields in the response should be expanded.

Output

output payout

PostPayoutsPayoutCancel

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

stripe.PostPayoutsPayoutCancel({
  "payout": ""
}, context)

Input

input object
- payout required string
- expand array: Specifies which fields in the response should be expanded.

Output

output payout

PostPayoutsPayoutReverse

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

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

stripe.PostPayoutsPayoutReverse({
  "payout": ""
}, context)

Input

input object
- payout required string
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.

Output

output payout

GetPlans

Returns a list of your plans.

stripe.GetPlans({}, context)

Input

input object
- active boolean: Only return plans that are active or inactive (e.g., pass false to list all inactive plans).
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- product string: Only return plans for the given product.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array: Details about each object.
  - items plan
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostPlans

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

stripe.PostPlans({
  "currency": "",
  "interval": ""
}, context)

Input

input object
- active boolean: Whether the plan is currently available for new subscriptions. Defaults to true.
- aggregate_usage string (values: last_during_period, last_ever, max, sum): Specifies a usage aggregation strategy for plans of usage_type=metered. Allowed values are sum for summing up all usage during a period, last_during_period for using the last usage record reported within a period, last_ever for using the last usage record ever (across period bounds) or max which uses the usage record with the maximum reported usage during a period. Defaults to sum.
- amount integer: A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis.
- amount_decimal string: Same as amount, but accepts a decimal value with at most 12 decimal places. Only one of amount and amount_decimal can be set.
- billing_scheme string (values: per_unit, tiered): Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in amount) will be charged per unit in quantity (for plans with usage_type=licensed), or per unit of total usage (for plans with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
- currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- expand array: Specifies which fields in the response should be expanded.
- id string: An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.
- interval required string (values: day, month, week, year): Specifies billing frequency. Either day, week, month or year.
- interval_count integer: The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
- nickname string: A brief description of the plan, hidden from customers.
- tiers array: Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
- tiers_mode string (values: graduated, volume): Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price, in graduated tiering pricing can successively change as the quantity grows.
- transform_usage object: Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers.
- trial_period_days integer: Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.
- usage_type string (values: licensed, metered): Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

Output

output plan

DeletePlansPlan

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

stripe.DeletePlansPlan({
  "plan": ""
}, context)

Input

input object
- plan required string

Output

output deleted_plan

GetPlansPlan

Retrieves the plan with the given ID.

stripe.GetPlansPlan({
  "plan": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- plan required string

Output

output plan

PostPlansPlan

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

stripe.PostPlansPlan({
  "plan": ""
}, context)

Input

input object
- plan required string
- active boolean: Whether the plan is currently available for new subscriptions.
- expand array: Specifies which fields in the response should be expanded.
- nickname string: A brief description of the plan, hidden from customers.
- product string: The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
- trial_period_days integer: Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.

Output

output plan

GetPrices

Returns a list of your prices.

stripe.GetPrices({}, context)

Input

input object
- active boolean: Only return prices that are active or inactive (e.g., pass false to list all inactive prices).
- currency string: Only return prices for the given currency.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- lookup_keys array: Only return the price with these lookup_keys, if any exist.
- product string: Only return prices for the given product.
- recurring object: Only return prices with these recurring fields.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- type string (values: one_time, recurring): Only return prices of type recurring or one_time.

Output

output object
- data required array: Details about each object.
  - items price
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostPrices

Creates a new price for an existing product. The price can be recurring or one-time.

stripe.PostPrices({
  "currency": ""
}, context)

Input

input object
- active boolean: Whether the price can be used for new purchases. Defaults to true.
- billing_scheme string (values: per_unit, tiered): Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
- currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- expand array: Specifies which fields in the response should be expanded.
- lookup_key string: A lookup key used to retrieve prices dynamically from a static string.
- metadata object: Set of key-value pairs 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.
- nickname string: A brief description of the price, hidden from customers.
- product string: The ID of the product that this price will belong to.
- product_data object: These fields can be used to create a new product that this price will belong to.
- recurring object: The recurring components of a price such as interval and usage_type.
- tiers array: Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
- tiers_mode string (values: graduated, volume): Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price, in graduated tiering pricing can successively change as the quantity grows.
- transfer_lookup_key boolean: If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
- transform_quantity object: Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers.
- unit_amount integer: A positive integer in %s (or 0 for a free price) representing how much to charge.
- unit_amount_decimal string: Same as unit_amount, but accepts a decimal value in %s with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

Output

output price

GetPricesPrice

Retrieves the price with the given ID.

stripe.GetPricesPrice({
  "price": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- price required string

Output

output price

PostPricesPrice

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

stripe.PostPricesPrice({
  "price": ""
}, context)

Input

input object
- price required string
- active boolean: Whether the price can be used for new purchases. Defaults to true.
- expand array: Specifies which fields in the response should be expanded.
- lookup_key string: A lookup key used to retrieve prices dynamically from a static string.
- nickname string: A brief description of the price, hidden from customers.
- transfer_lookup_key boolean: If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.

Output

output price

GetProducts

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

stripe.GetProducts({}, context)

Input

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

Output

output object
- data required array
  - items product
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostProducts

Creates a new product object.

stripe.PostProducts({
  "name": ""
}, context)

Input

input object
- active boolean: Whether the product is currently available for purchase. Defaults to true.
- attributes array: A list of up to 5 alphanumeric attributes. Should only be set if type=good.
- caption string: A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.
- deactivate_on array: An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if type=good.
- description string: The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
- expand array: Specifies which fields in the response should be expanded.
- id string: An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.
- images array: A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
- metadata object: Set of key-value pairs 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 required string: The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
- package_dimensions object: The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own package_dimensions. May only be set if type=good.
- shippable boolean: Whether this product is shipped (i.e., physical goods). Defaults to true. May only be set if type=good.
- statement_descriptor string: An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
- unit_label string: A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
- url string: A URL of a publicly-accessible webpage for this product. May only be set if type=good.

Output

output product

DeleteProductsId

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

stripe.DeleteProductsId({
  "id": ""
}, context)

Input

input object
- id required string

Output

output deleted_product

GetProductsId

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

stripe.GetProductsId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

output product

PostProductsId

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

stripe.PostProductsId({
  "id": ""
}, context)

Input

input object
- id required string
- active boolean: Whether the product is available for purchase.
- caption string: A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.
- deactivate_on array: An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if type=good.
- description string: The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
- expand array: Specifies which fields in the response should be expanded.
- name string: The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
- shippable boolean: Whether this product is shipped (i.e., physical goods). Defaults to true. May only be set if type=good.
- statement_descriptor string: An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
- unit_label string: A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if type=service.
- url string: A URL of a publicly-accessible webpage for this product. May only be set if type=good.

Output

output product

GetPromotionCodes

Returns a list of your promotion codes.

stripe.GetPromotionCodes({}, context)

Input

input object
- active boolean: Filter promotion codes by whether they are active.
- code string: Only return promotion codes that have this case-insensitive code.
- coupon string: Only return promotion codes for this coupon.
- customer string: Only return promotion codes that are restricted to this customer.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items promotion_code
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostPromotionCodes

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

stripe.PostPromotionCodes({
  "coupon": ""
}, context)

Input

input object
- active boolean: Whether the promotion code is currently active.
- code string: The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.
- coupon required string: The coupon for this promotion code.
- customer string: The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
- expand array: Specifies which fields in the response should be expanded.
- expires_at integer: The timestamp at which this promotion code will expire. If the coupon has specified a redeems_by, then this value cannot be after the coupon's redeems_by.
- max_redemptions integer: A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a max_redemptions, then this value cannot be greater than the coupon's max_redemptions.
- metadata object: Set of key-value pairs 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.
- restrictions object: Settings that restrict the redemption of the promotion code.

Output

output promotion_code

GetPromotionCodesPromotionCode

Retrieves the promotion code with the given ID.

stripe.GetPromotionCodesPromotionCode({
  "promotion_code": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- promotion_code required string

Output

output promotion_code

PostPromotionCodesPromotionCode

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

stripe.PostPromotionCodesPromotionCode({
  "promotion_code": ""
}, context)

Input

input object
- promotion_code required string
- active boolean: Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.
- expand array: Specifies which fields in the response should be expanded.

Output

output promotion_code

GetRadarEarlyFraudWarnings

Returns a list of early fraud warnings.

stripe.GetRadarEarlyFraudWarnings({}, context)

Input

input object
- charge string: Only return early fraud warnings for the charge specified by this charge ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items radar.early_fraud_warning
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetRadarEarlyFraudWarningsEarlyFraudWarning

Retrieves the details of an early fraud warning that has previously been created.

Please refer to the early fraud warning object reference for more details.

stripe.GetRadarEarlyFraudWarningsEarlyFraudWarning({
  "early_fraud_warning": ""
}, context)

Input

input object
- early_fraud_warning required string
- expand array: Specifies which fields in the response should be expanded.

Output

output radar.early_fraud_warning

GetRadarValueListItems

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

stripe.GetRadarValueListItems({
  "value_list": ""
}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- value string: Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
- value_list required string: Identifier for the parent value list this item belongs to.

Output

output object
- data required array
  - items radar.value_list_item
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostRadarValueListItems

Creates a new ValueListItem object, which is added to the specified parent value list.

stripe.PostRadarValueListItems({
  "value": "",
  "value_list": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- value required string: The value of the item (whose type must match the type of the parent value list).
- value_list required string: The identifier of the value list which the created item will be added to.

Output

output radar.value_list_item

DeleteRadarValueListItemsItem

Deletes a ValueListItem object, removing it from its parent value list.

stripe.DeleteRadarValueListItemsItem({
  "item": ""
}, context)

Input

input object
- item required string

Output

output deleted_radar.value_list_item

GetRadarValueListItemsItem

Retrieves a ValueListItem object.

stripe.GetRadarValueListItemsItem({
  "item": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- item required string

Output

output radar.value_list_item

GetRadarValueLists

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

stripe.GetRadarValueLists({}, context)

Input

input object
- alias string: The alias used to reference the value list when writing rules.
- contains string: A value contained within a value list - returns all value lists containing this value.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items radar.value_list
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostRadarValueLists

Creates a new ValueList object, which can then be referenced in rules.

stripe.PostRadarValueLists({
  "alias": "",
  "name": ""
}, context)

Input

input object
- alias required string: The name of the value list for use in rules.
- expand array: Specifies which fields in the response should be expanded.
- item_type string (values: card_bin, card_fingerprint, case_sensitive_string, country, email, ip_address, string): Type of the items in the value list. One of card_fingerprint, card_bin, email, ip_address, country, string, or case_sensitive_string. Use string if the item type is unknown or mixed.
- metadata object: Set of key-value pairs 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 required string: The human-readable name of the value list.

Output

output radar.value_list

DeleteRadarValueListsValueList

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

stripe.DeleteRadarValueListsValueList({
  "value_list": ""
}, context)

Input

input object
- value_list required string

Output

output deleted_radar.value_list

GetRadarValueListsValueList

Retrieves a ValueList object.

stripe.GetRadarValueListsValueList({
  "value_list": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- value_list required string

Output

output radar.value_list

PostRadarValueListsValueList

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

stripe.PostRadarValueListsValueList({
  "value_list": ""
}, context)

Input

input object
- value_list required string
- alias string: The name of the value list for use in rules.
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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 string: The human-readable name of the value list.

Output

output radar.value_list

GetRecipients

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

stripe.GetRecipients({}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- type string (values: corporation, individual)
- verified boolean: Only return recipients that are verified or unverified.

Output

output object
- data required array
  - items recipient
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostRecipients

Creates a new Recipient object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.

stripe.PostRecipients({
  "name": "",
  "type": ""
}, context)

Input

input object
- bank_account string: A bank account to attach to the recipient. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details, with the options described below.
- card string: A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud.
- description string: An arbitrary string which you can attach to a Recipient object. It is displayed alongside the recipient in the web interface.
- email string: The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking.
- expand array: Specifies which fields in the response should be expanded.
- name required string: The recipient's full, legal name. For type individual, should be in the format First Last, First Middle Last, or First M Last (no prefixes or suffixes). For corporation, the full, incorporated name.
- tax_id string: The recipient's tax ID, as a string. For type individual, the full SSN; for type corporation, the full EIN.
- type required string: Type of the recipient: either individual or corporation.

Output

output recipient

DeleteRecipientsId

Permanently deletes a recipient. It cannot be undone.

stripe.DeleteRecipientsId({
  "id": ""
}, context)

Input

input object
- id required string

Output

output deleted_recipient

GetRecipientsId

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

stripe.GetRecipientsId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

Output schema unknown

PostRecipientsId

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

If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.

stripe.PostRecipientsId({
  "id": ""
}, context)

Input

input object
- id required string
- bank_account string: A bank account to attach to the recipient. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details, with the options described below.
- card string: A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's debit card details, with the options described below. Passing card will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the card creation API. Whenever you attach a card to a recipient, Stripe will automatically validate the debit card.
- default_card string: ID of the card to set as the recipient's new default for payouts.
- description string: An arbitrary string which you can attach to a Recipient object. It is displayed alongside the recipient in the web interface.
- email string: The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking.
- expand array: Specifies which fields in the response should be expanded.
- name string: The recipient's full, legal name. For type individual, should be in the format First Last, First Middle Last, or First M Last (no prefixes or suffixes). For corporation, the full, incorporated name.
- tax_id string: The recipient's tax ID, as a string. For type individual, the full SSN; for type corporation, the full EIN.

Output

output recipient

GetRefunds

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

stripe.GetRefunds({}, context)

Input

input object
- charge string: Only return refunds for the charge specified by this charge ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent string: Only return refunds for the PaymentIntent specified by this ID.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items refund
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostRefunds

Create a refund.

stripe.PostRefunds({}, context)

Input

input object
- amount integer
- charge string
- expand array: Specifies which fields in the response should be expanded.
- payment_intent string
- reason string (values: duplicate, fraudulent, requested_by_customer)
- refund_application_fee boolean
- reverse_transfer boolean

Output

output refund

GetRefundsRefund

Retrieves the details of an existing refund.

stripe.GetRefundsRefund({
  "refund": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- refund required string

Output

output refund

PostRefundsRefund

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

This request only accepts metadata as an argument.

stripe.PostRefundsRefund({
  "refund": ""
}, context)

Input

input object
- refund required string
- expand array: Specifies which fields in the response should be expanded.

Output

output refund

GetReportingReportRuns

Returns a list of Report Runs, with the most recent appearing first. (Requires a live-mode API key.)

stripe.GetReportingReportRuns({}, context)

Input

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

Output

output object
- data required array
  - items reporting.report_run
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostReportingReportRuns

Creates a new object and begin running the report. (Requires a live-mode API key.)

stripe.PostReportingReportRuns({
  "report_type": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- parameters object: Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the API Access to Reports documentation.
- report_type required string: The ID of the report type to run, such as "balance.summary.1".

Output

output reporting.report_run

GetReportingReportRunsReportRun

Retrieves the details of an existing Report Run. (Requires a live-mode API key.)

stripe.GetReportingReportRunsReportRun({
  "report_run": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- report_run required string

Output

output reporting.report_run

GetReportingReportTypes

Returns a full list of Report Types. (Requires a live-mode API key.)

stripe.GetReportingReportTypes({}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.

Output

output object
- data required array
  - items reporting.report_type
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetReportingReportTypesReportType

Retrieves the details of a Report Type. (Requires a live-mode API key.)

stripe.GetReportingReportTypesReportType({
  "report_type": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- report_type required string

Output

output reporting.report_type

GetReviews

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

stripe.GetReviews({}, context)

Input

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

Output

output object
- data required array
  - items review
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetReviewsReview

Retrieves a Review object.

stripe.GetReviewsReview({
  "review": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- review required string

Output

output review

PostReviewsReviewApprove

Approves a Review object, closing it and removing it from the list of reviews.

stripe.PostReviewsReviewApprove({
  "review": ""
}, context)

Input

input object
- review required string
- expand array: Specifies which fields in the response should be expanded.

Output

output review

GetSetupAttempts

Returns a list of SetupAttempts associated with a provided SetupIntent.

stripe.GetSetupAttempts({
  "setup_intent": ""
}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- setup_intent required string: Only return SetupAttempts created by the SetupIntent specified by
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items setup_attempt
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetSetupIntents

Returns a list of SetupIntents.

stripe.GetSetupIntents({}, context)

Input

input object
- customer string: Only return SetupIntents for the customer specified by this customer ID.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_method string: Only return SetupIntents associated with the specified payment method.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items setup_intent
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostSetupIntents

Creates a SetupIntent object.

After the SetupIntent is created, attach a payment method and confirm to collect any required permissions to charge the payment method later.

stripe.PostSetupIntents({}, context)

Input

input object
- confirm boolean: Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If the payment method attached is a card, a return_url may be provided in case additional authentication is required.
- customer string: ID of the Customer this SetupIntent belongs to, if one exists.
- description string: An arbitrary string attached to the object. Often useful for displaying to users.
- expand array: Specifies which fields in the response should be expanded.
- mandate_data object: This hash contains details about the Mandate to create. This parameter can only be used with confirm=true.
- metadata object: Set of key-value pairs 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.
- on_behalf_of string: The Stripe account ID for which this SetupIntent is created.
- payment_method string: ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
- payment_method_options object: Payment-method-specific configuration for this SetupIntent.
- payment_method_types array: The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"].
- return_url string: The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
- single_use object: If this hash is populated, this SetupIntent will generate a single_use Mandate on success.
- usage string (values: off_session, on_session): Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to off_session.

Output

output setup_intent

GetSetupIntentsIntent

Retrieves the details of a SetupIntent that has previously been created.

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

stripe.GetSetupIntentsIntent({
  "intent": ""
}, context)

Input

input object
- client_secret string: The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent.
- expand array: Specifies which fields in the response should be expanded.
- intent required string

Output

output setup_intent

PostSetupIntentsIntent

Updates a SetupIntent object.

stripe.PostSetupIntentsIntent({
  "intent": ""
}, context)

Input

input object
- intent required string
- customer string: ID of the Customer this SetupIntent belongs to, if one exists.
- description string: An arbitrary string attached to the object. Often useful for displaying to users.
- expand array: Specifies which fields in the response should be expanded.
- payment_method string: ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
- payment_method_options object: Payment-method-specific configuration for this SetupIntent.
- payment_method_types array: The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to ["card"].

Output

output setup_intent

PostSetupIntentsIntentCancel

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

stripe.PostSetupIntentsIntentCancel({
  "intent": ""
}, context)

Input

input object
- intent required string
- cancellation_reason string (values: abandoned, duplicate, requested_by_customer): Reason for canceling this SetupIntent. Possible values are abandoned, requested_by_customer, or duplicate
- expand array: Specifies which fields in the response should be expanded.

Output

output setup_intent

PostSetupIntentsIntentConfirm

Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status.

stripe.PostSetupIntentsIntentConfirm({
  "intent": ""
}, context)

Input

input object
- intent required string
- client_secret string: The client secret of the SetupIntent.
- expand array: Specifies which fields in the response should be expanded.
- payment_method string: ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
- payment_method_options object: Payment-method-specific configuration for this SetupIntent.
- return_url string: The URL to redirect your customer back to after they authenticate on the payment method's app or site.

Output

output setup_intent

GetSigmaScheduledQueryRuns

Returns a list of scheduled query runs.

stripe.GetSigmaScheduledQueryRuns({}, context)

Input

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

Output

output object
- data required array
  - items scheduled_query_run
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetSigmaScheduledQueryRunsScheduledQueryRun

Retrieves the details of an scheduled query run.

stripe.GetSigmaScheduledQueryRunsScheduledQueryRun({
  "scheduled_query_run": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- scheduled_query_run required string

Output

output scheduled_query_run

GetSkus

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

stripe.GetSkus({}, context)

Input

input object
- active boolean: Only return SKUs that are active or inactive (e.g., pass false to list all inactive products).
- attributes object: Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if product is also supplied. For instance, if the associated product has attributes ["color", "size"], passing in attributes[color]=red returns all the SKUs for this product that have color set to red.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- ids array: Only return SKUs with the given IDs.
- in_stock boolean: Only return SKUs that are either in stock or out of stock (e.g., pass false to list all SKUs that are out of stock). If no value is provided, all SKUs are returned.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- product string: The ID of the product whose SKUs will be retrieved. Must be a product with type good.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items sku
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostSkus

Creates a new SKU associated with a product.

stripe.PostSkus({
  "currency": "",
  "inventory": {},
  "price": 0,
  "product": ""
}, context)

Input

input object
- active boolean: Whether the SKU is available for purchase. Default to true.
- attributes object: A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are ["size", "gender"], a valid SKU has the following dictionary of attributes: {"size": "Medium", "gender": "Unisex"}.
- currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- expand array: Specifies which fields in the response should be expanded.
- id string: The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated.
- image string: The URL of an image for this SKU, meant to be displayable to the customer.
- inventory required object: Description of the SKU's inventory.
- metadata object: Set of key-value pairs 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.
- package_dimensions object: The dimensions of this SKU for shipping purposes.
- price required integer: The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).
- product required string: The ID of the product this SKU is associated with. Must be a product with type good.

Output

output sku

DeleteSkusId

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

stripe.DeleteSkusId({
  "id": ""
}, context)

Input

input object
- id required string

Output

output deleted_sku

GetSkusId

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

stripe.GetSkusId({
  "id": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- id required string

Output

Output schema unknown

PostSkusId

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

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

stripe.PostSkusId({
  "id": ""
}, context)

Input

input object
- id required string
- active boolean: Whether this SKU is available for purchase.
- attributes object: A dictionary of attributes and values for the attributes defined by the product. When specified, attributes will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product.
- currency string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- expand array: Specifies which fields in the response should be expanded.
- image string: The URL of an image for this SKU, meant to be displayable to the customer.
- inventory object: Description of the SKU's inventory.
- price integer: The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).
- product string: The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type good.

Output

output sku

PostSources

Creates a new source object.

stripe.PostSources({}, context)

Input

input object
- amount integer: Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources. Not supported for receiver type sources, where charge amount may not be specified until funds land.
- currency string: Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready.
- customer string: The Customer to whom the original source is attached to. Must be set when the original source is not a Source (e.g., Card).
- expand array: Specifies which fields in the response should be expanded.
- flow string (values: code_verification, none, receiver, redirect): The authentication flow of the source to create. flow is one of redirect, receiver, code_verification, none. It is generally inferred unless a type supports multiple flows.
- mandate object: Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
- metadata object
- original_source string: The source to share.
- owner object: Information about the owner of the payment instrument that may be used or required by particular source types.
- receiver object: Optional parameters for the receiver flow. Can be set only if the source is a receiver (flow is receiver).
- redirect object: Parameters required for the redirect flow. Required if the source is authenticated by a redirect (flow is redirect).
- source_order object: Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
- statement_descriptor string: An arbitrary string to be displayed on your customer's statement. As an example, if your website is RunClub and the item you're charging for is a race ticket, you may want to specify a statement_descriptor of RunClub 5K race ticket. While many payment types will display this information, some may not display it at all.
- token string: An optional token used to create the source. When passed, token properties will override source parameters.
- type string: The type of the source to create. Required unless customer and original_source are specified (see the Cloning card Sources guide)
- usage string (values: reusable, single_use)

Output

output source

GetSourcesSource

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

stripe.GetSourcesSource({
  "source": ""
}, context)

Input

input object
- client_secret string: The client secret of the source. Required if a publishable key is used to retrieve the source.
- expand array: Specifies which fields in the response should be expanded.
- source required string

Output

output source

PostSourcesSource

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

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

stripe.PostSourcesSource({
  "source": ""
}, context)

Input

input object
- source required string
- amount integer: Amount associated with the source.
- expand array: Specifies which fields in the response should be expanded.
- mandate object: Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
- owner object: Information about the owner of the payment instrument that may be used or required by particular source types.
- source_order object: Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.

Output

output source

GetSourcesSourceMandateNotificationsMandateNotification

Retrieves a new Source MandateNotification.

stripe.GetSourcesSourceMandateNotificationsMandateNotification({
  "mandate_notification": "",
  "source": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- mandate_notification required string
- source required string

Output

output source_mandate_notification

GetSourcesSourceSourceTransactions

List source transactions for a given source.

stripe.GetSourcesSourceSourceTransactions({
  "source": ""
}, context)

Input

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

Output

output object
- data required array
  - items source_transaction
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

GetSourcesSourceSourceTransactionsSourceTransaction

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

stripe.GetSourcesSourceSourceTransactionsSourceTransaction({
  "source": "",
  "source_transaction": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- source required string
- source_transaction required string

Output

output source_transaction

PostSourcesSourceVerify

Verify a given source.

stripe.PostSourcesSourceVerify({
  "source": "",
  "values": []
}, context)

Input

input object
- source required string
- expand array: Specifies which fields in the response should be expanded.
- values required array: The values needed to verify the source.

Output

output source

GetSubscriptionItems

Returns a list of your subscription items for a given subscription.

stripe.GetSubscriptionItems({
  "subscription": ""
}, context)

Input

input object
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- subscription required string: The ID of the subscription whose items will be retrieved.

Output

output object
- data required array
  - items subscription_item
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostSubscriptionItems

Adds a new item to an existing subscription. No existing items will be changed or replaced.

stripe.PostSubscriptionItems({
  "subscription": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- metadata object: Set of key-value pairs 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.
- payment_behavior string (values: allow_incomplete, error_if_incomplete, pending_if_incomplete): Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.
- price string: The ID of the price object.
- price_data object: Data used to generate a new Price object inline.
- proration_behavior string (values: always_invoice, create_prorations, none): Determines how to handle 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. Valid values are create_prorations, none, or always_invoice.
- proration_date integer: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity integer: The quantity you'd like to apply to the subscription item you're creating.
- subscription required string: The identifier of the subscription to modify.

Output

output subscription_item

DeleteSubscriptionItemsItem

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

stripe.DeleteSubscriptionItemsItem({
  "item": ""
}, context)

Input

input object
- item required string
- clear_usage boolean: Delete all usage for the given subscription item. Allowed only when the current plan's usage_type is metered.
- proration_behavior string (values: always_invoice, create_prorations, none): Determines how to handle 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. Valid values are create_prorations, none, or always_invoice.
- proration_date integer: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.

Output

output deleted_subscription_item

GetSubscriptionItemsItem

Retrieves the subscription item with the given ID.

stripe.GetSubscriptionItemsItem({
  "item": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- item required string

Output

output subscription_item

PostSubscriptionItemsItem

Updates the plan or quantity of an item on a current subscription.

stripe.PostSubscriptionItemsItem({
  "item": ""
}, context)

Input

input object
- item required string
- expand array: Specifies which fields in the response should be expanded.
- off_session boolean: Indicates if a customer is on or off-session while an invoice payment is attempted.
- payment_behavior string (values: allow_incomplete, error_if_incomplete, pending_if_incomplete): Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.
- price string: The ID of the price object.
- price_data object: Data used to generate a new Price object inline.
- proration_behavior string (values: always_invoice, create_prorations, none): Determines how to handle 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. Valid values are create_prorations, none, or always_invoice.
- proration_date integer: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity integer: The quantity you'd like to apply to the subscription item you're creating.

Output

output subscription_item

GetSubscriptionItemsSubscriptionItemUsageRecordSummaries

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

stripe.GetSubscriptionItemsSubscriptionItemUsageRecordSummaries({
  "subscription_item": ""
}, context)

Input

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

Output

output object
- data required array
  - items usage_record_summary
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostSubscriptionItemsSubscriptionItemUsageRecords

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.

The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

stripe.PostSubscriptionItemsSubscriptionItemUsageRecords({
  "subscription_item": "",
  "quantity": 0,
  "timestamp": 0
}, context)

Input

input object
- subscription_item required string
- action string (values: increment, set): Valid values are increment (default) or set. When using increment the specified quantity will be added to the usage at the specified timestamp. The set action will overwrite the usage quantity at that timestamp. If the subscription has billing thresholds, increment is the only allowed value.
- expand array: Specifies which fields in the response should be expanded.
- quantity required integer: The usage quantity for the specified timestamp.
- timestamp required integer: The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided subscription_item.

Output

output usage_record

GetSubscriptionSchedules

Retrieves the list of your subscription schedules.

stripe.GetSubscriptionSchedules({}, context)

Input

input object
- customer string: Only return subscription schedules for the given customer.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- scheduled boolean: Only return subscription schedules that have not started yet.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

output object
- data required array
  - items subscription_schedule
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostSubscriptionSchedules

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

stripe.PostSubscriptionSchedules({}, context)

Input

input object
- customer string: The identifier of the customer to create the subscription schedule for.
- default_settings object: Object representing the subscription schedule's default settings.
- end_behavior string (values: cancel, none, release, renew): Configures how the subscription schedule behaves when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running.cancel will end the subscription schedule and cancel the underlying subscription.
- expand array: Specifies which fields in the response should be expanded.
- from_subscription string: Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
- phases array: List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase.

Output

output subscription_schedule

GetSubscriptionSchedulesSchedule

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

stripe.GetSubscriptionSchedulesSchedule({
  "schedule": ""
}, context)

Input

input object
- expand array: Specifies which fields in the response should be expanded.
- schedule required string

Output

output subscription_schedule

PostSubscriptionSchedulesSchedule

Updates an existing subscription schedule.

stripe.PostSubscriptionSchedulesSchedule({
  "schedule": ""
}, context)

Input

input object
- schedule required string
- default_settings object: Object representing the subscription schedule's default settings.
- end_behavior string (values: cancel, none, release, renew): Configures how the subscription schedule behaves when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running.cancel will end the subscription schedule and cancel the underlying subscription.
- expand array: Specifies which fields in the response should be expanded.
- phases array: List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase. Note that past phases can be omitted.
- proration_behavior string (values: always_invoice, create_prorations, none): If the update changes the current phase, indicates if the changes should be prorated. Possible values are create_prorations or none, and the default value is create_prorations.

Output

output subscription_schedule

PostSubscriptionSchedulesScheduleCancel

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

stripe.PostSubscriptionSchedulesScheduleCancel({
  "schedule": ""
}, context)

Input

input object
- schedule required string
- expand array: Specifies which fields in the response should be expanded.
- invoice_now boolean: If the subscription schedule is active, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to true.
- prorate boolean: If the subscription schedule is active, indicates if the cancellation should be prorated. Defaults to true.

Output

output subscription_schedule

PostSubscriptionSchedulesScheduleRelease

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

stripe.PostSubscriptionSchedulesScheduleRelease({
  "schedule": ""
}, context)

Input

input object
- schedule required string
- expand array: Specifies which fields in the response should be expanded.
- preserve_cancel_date boolean: Keep any cancellation on the subscription that the schedule has set

Output

output subscription_schedule

GetSubscriptions

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

stripe.GetSubscriptions({}, context)

Input

input object
- collection_method string (values: charge_automatically, send_invoice): The collection method of the subscriptions to retrieve. Either charge_automatically or send_invoice.
- customer string: The ID of the customer whose subscriptions will be retrieved.
- ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
- expand array: Specifies which fields in the response should be expanded.
- limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- price string: Filter for subscriptions that contain this recurring price ID.
- starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
- status string (values: active, all, canceled, ended, incomplete, incomplete_expired, past_due, trialing, unpaid): The status of the subscriptions to retrieve. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Pass ended to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value of all will return subscriptions of all statuses.

Output

output object
- data required array
  - items subscription
- has_more required boolean: True if this list has another page of items after this one that can be fetched.
- object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
- url required string: The URL where this list can be accessed.

PostSubscriptions

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

stripe.PostSubscriptions({
  "customer": ""
}, context)

Input

input object
- add_invoice_items array: A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 10 items.
- application_fee_percent number: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.
- backdate_start_date integer: For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
- billing_cycle_anchor integer: A future timestamp to anchor the subscription's 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.
- cancel_at integer: 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.
- cancel_at_period_end boolean: Boolean indicating whether this subscription should cancel at the end of the current period.
- collection_method string (values: charge_automatically, send_invoice): Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to charge_automatically.
- coupon string: The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
- customer required string: The identifier of the customer to subscribe.
- days_until_due integer: Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.
- default_payment_method string: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- default_source string: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- expand array: Specifies which fields in the response should be expanded.
- items array: A list of up to 20 subscription items, each with an attached price.
- off_session boolean: Indicates if a customer is on or off-session while an invoice payment is attempted.
- payment_behavior string (values: allow_incomplete, error_if_incomplete, pending_if_incomplete): Use allow_incomplete to create subscriptions with status=incomplete if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.
- promotion_code string: The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
- proration_behavior string (values: always_invoice, create_prorations, none): Determines how to handle prorations resulting from the billing_cycle_anchor. Valid values are create_prorations or none.
- transfer_data object: If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
- trial_from_plan boolean: Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed.
- trial_period_days integer: Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan.

Output

output subscription

DeleteSubscriptionsSubscriptionExposedId

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

Note, however, that any pending invoice items that you’ve created will still be charged for at