Qodex.ai

Stripe API [2023-10-16]

Number of APIs: 438

Stripe API Qodex Collection

This is a Qodex collection covering the Stripe API. See https://stripe.com/docs/api for more details.

Prerequisites

Qodex

Stripe Account

Getting Started

To get started fork the collection from [Stripe's public workspace] within Qodex.

Fork collection

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

Fork form

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

Fork environment template

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:

create a new environment

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

set API key

Set the environment to active:

save as active

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

set collection environment

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:

secret key mouseover

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

save key

Make a test call

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

customer endpoints

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

create customer send

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

create customer send

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:

create customer with email

You'll see the email address in the reponse:

create customer with email

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:

set metadata on a request

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:

clear metadata key

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

remove metadata key

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.

If you need to report a bug or request an update, feel free to open an issue on our GitHub repository.

  1. Financial Connections Accounts - Subscribe to data refreshes of an Account POST {{baseUrl}}/v1/financial_connections/accounts/:account/subscribe

  2. Terminal Configurations - Create a Configuration POST {{baseUrl}}/v1/terminal/configurations

  3. Radar Value List Items - Delete a value list item DELETE {{baseUrl}}/v1/radar/value_list_items/:item

  4. Tax Calculations - Create a tax transaction from a calculation POST {{baseUrl}}/v1/tax/transactions/create_from_calculation

  5. Personalization Designs - List all personalization designs GET {{baseUrl}}/v1/issuing/personalization_designs

  6. Subscription Items - Create a usage record POST {{baseUrl}}/v1/subscription_items/:subscription_item/usage_records

  7. Persons - Create a person POST {{baseUrl}}/v1/accounts/:account/persons

  8. Tax Registrations - Retrieve a registration GET {{baseUrl}}/v1/tax/registrations/:id

  9. Refunds - Retrieve a refund GET {{baseUrl}}/v1/refunds/:refund

  10. Radar Fraud Early Warnings - Retrieve an early fraud warning GET {{baseUrl}}/v1/radar/early_fraud_warnings/:early_fraud_warning