#Billing API

monetr's hosted service charges for itself through Stripe, and these three endpoints are how the app hands you off to Stripe and picks you back up afterwards. monetr never sees a card number: both endpoints that matter return a Stripe URL for the browser to go to.

#POST Start a checkout

Creates a Stripe checkout session and returns where to send the browser.

In the app: The subscribe button on the "your subscription isn't active" screen.

POST /api/billing/create_checkout

Auth: Not available to API keys.

#Body

#Errors

#GET Finish a checkout

Called when Stripe sends the user back to monetr. It checks with Stripe whether the payment actually went through and updates the account, then tells the client where to go.

In the app: The page Stripe redirects to after checkout, which reads the answer and either lets you in or sends you back to subscribe.

GET /api/billing/checkout/:checkoutSessionId

Auth: Not available to API keys.

#Path parameters

#Responses

Payment went through:

{
  "nextUrl": "/",
  "isActive": true
}

It didn't, or hasn't yet:

{
  "message": "Subscription is not active.",
  "nextUrl": "/account/subscribe",
  "isActive": false
}

Both are 200. Check isActive, not the status code. An inactive answer isn't necessarily failure either, Stripe's webhook may not have landed yet.

#Errors

#GET Open the billing portal

Returns a URL to Stripe's billing portal, where someone can change their card, see invoices or cancel.

In the app: The manage subscription button on the subscription settings page.

GET /api/billing/portal

Auth: Not available to API keys.

#Response

{
  "url": "https://billing.stripe.com/p/session/live_YWNjdF8xTTJKVGtMa2RJd0h1N2l4"
}

Send the browser there. The link is short lived and single use, so fetch a fresh one each time rather than storing it.

#Errors