Skip to content

lmspann/OAS.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 

Repository files navigation

Stripe Tax Code API Requests

Technical Writing Portfolio

About

Stripe is a company that has an API for credit card transactions. Many online companies use it as a way to charge their customers. Customers will enter credit card information at a company’s website, then the company’s servers will make calls to the Stripe API to make those transactions happen.

Tax codes classify goods and services for tax purposes. Stripe's Tax Code API requests are used to obtain codes that determine a product’s tax rate.

I referenced Stripe's API documentation to create a sample OAS for the Tax Code API endpoints in Swagger.

Access and Authentication

Accessing the Tax Code API endpoints require a Stripe user account with basic authorization credentials. Anyone can create a Stripe user account by signing up at Stripe.com.

In my sample OAS, clicking the "Authorize" button will open a dialogue box to enter a user name and password. Authorize button

Requests

There are two tax code endpoints which use the GET method to list all tax codes and retrive tax codes.

The GET requests in my sample OAS are depicted in the screenshot below. GET requests

Parameters

The tax_code_id is the only required paramter for the /tax_codes/{tax_code_id} request. Tax code id parameter

The ending_before, limit, and starting_after parameters apply to the /tax_codes request. These parameters are not required. When left unpopulated, the default number of Tax Codes retrieved is ten. Tax code list parameters

Responses

The Stripe API returns JSON responses.

/tax_codes/{tax_code_id} Request Response Code

respose code

/tax_codes Request Response Code

response code

About

This is an SAP OAS specification

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors