⭐️ Stripe API [2024-04-10]
Number of APIs: 457
Stripe API Qodex Collection
This is a Qodex collection covering the Stripe API. See https://stripe.com/docs/api for more details.
Prerequisites
Getting Started
To get started fork the collection from [Stripe's public workspace] within Qodex.

Enter a name for your fork and select the workspace where it will be created:

You can also fork the environment template from the Stripe Developers Workspace:

Set your API key
To run requests you'll need to supply your testmode secret API key and set it as an [environment variable] within your workspace.
To set any environment variable, create a new envionment within Qodex:

Add your secret key as a variable to the environment and save:

Set the environment to active:

Now within the collection set it to use the environment you just created:

If your environment is set up correctly, you should see your secret key value if you mouse over the secret_key
variable in the Token field:

Be sure to save the collection after you've configured the set the key:

Make a test call
You should be ready now to make a test call. An easy first call is to create a customer:

Since no parameters are required to create a customer, you can just hit the Send button to run this request:

If your environment is set up you'll get a customer object back as the response to the call:

Add parameters to the call by clicking the body tab, where you'll see a list of available parameters. Select and populate the ones you want to use. Here's an example of adding an email parameter:

You'll see the email address in the reponse:

Passing Metadata In a Request
Right now metadata does not show up as a optional parameter on requests, but it can still be provided to calls that will accept it. Here's an example of adding 2 metadata fields to the customer create call:

Metadata key value pairs can be updated in a similar manner. To remove a metadata key during an update call, supply the metadata[key]
parameter without setting a value. This will pass an empty string as part of the request:

To remove all metadata pass the metadata
parameter without a value set:

Changelog
To keep track of major Stripe API updates and version, reference the API upgrades page in our documentation. For a detailed list of API changes, please refer to our API Changelog.
Get support
If you found a bug or want to suggest a new feature, please file an issue.
-
Customer Cash Balance - Update a cash balance's settings POST {{baseUrl}}/v1/customers/:customer/cash_balance
-
Promotion Codes - List all promotion codes GET {{baseUrl}}/v1/promotion_codes
-
Identity - Redact a VerificationSession POST {{baseUrl}}/v1/identity/verification_sessions/:session/redact
-
Treasury DebitReversals - List all DebitReversals GET {{baseUrl}}/v1/treasury/debit_reversals?financial_account=<string>
-
Personalization Designs - Create an personalization design POST {{baseUrl}}/v1/issuing/personalization_designs
-
Treasury OutboundPayments - Cancel an OutboundPayment POST {{baseUrl}}/v1/treasury/outbound_payments/:id/cancel
-
Promotion Codes - Create a promotion code POST {{baseUrl}}/v1/promotion_codes
-
Issuing Disputes - Create a dispute POST {{baseUrl}}/v1/issuing/disputes
-
Application Fees - List all application fees GET {{baseUrl}}/v1/application_fees
-
Radar Fraud Early Warnings - List all early fraud warnings GET {{baseUrl}}/v1/radar/early_fraud_warnings