Common Design Patterns at Stripe

Mikes Notes

An excellent series of articles on designing APIs from Stripe, The Payment Service Provider. There are detailed examples and coding conventions.

• Stripe

Designing APIs for Humans Series' Articles by Paul Asjes (Stripe Dev)

• Object IDs
• Error messages
• Design patterns
• Common design patterns at Stripe

Examples

$pi = $stripe->paymentIntents->create([
  'amount' => 1000,
  'currency' => 'usd',
  // Without prefixes, we'd have to supply a 'type'
  'payment_method' => [
    'type' => 'card',
    'id' => '1LaRQ7GUcADgqoEMV11wEUxU'
  ],
]);

Docs

Stripe also has superb Developer Docs, which are a helpful format to start with when designing Pipi Docs, especially for the API.

Resources

• https://docs.stripe.com/keys
• https://docs.stripe.com/rate-limits
• https://docs.stripe.com/error-codes
• https://docs.stripe.com/stripe-cli/overview
• https://docs.stripe.com/stripe-shell/launch

Other stuff

• https://markdoc.dev/docs/overview