API Explorer

OBP-Stripe

OBP-Stripe

OBP-Stripe takes card payments for API Products through Stripe, and keeps each here in step with Stripe.

  • Prices: OBP-API is the source of truth. OBP-Stripe reads the API Products whose BILLING_SYSTEM attribute is stripe, and keeps a monthly Stripe Price for each one, from monthly_subscription_amount and monthly_subscription_currency.
  • Checkout: a developer subscribes a Consumer in the Portal, and the subscription starts as requested. The Portal sends them to OBP-Stripe, which checks that they may act for the Consumer, then starts a Stripe Checkout. Members of an here can pay for its Consumers' subscriptions.
  • Status: Stripe's webhooks, and a check every 5 minutes, set the subscription to active, past_due, suspended or cancelled. OBP-API grants and removes access on each status, so OBP-Stripe never grants a Role or Scope itself. A subscription cancelled in OBP is cancelled in Stripe.
  • Billing: each person's Stripe customer is kept in their non-personal user attribute STRIPE_CUSTOMER_ID, and they change their card or download invoices on Stripe's billing page.

OBP-Stripe is a Platform App: it calls OBP-API with its own token, and declares the Scopes it needs. See here.