Account
Open the billing portal
Get a Stripe billing portal link to change or cancel the plan, update the card and download invoices.
POST
https://api.rankparse.com/v1/subscription/portalFreeAPI keyCreates a Stripe billing portal session for the workspace and returns its URL. In the portal the owner can change or cancel the subscription, update the payment card and download invoices. When they are done, Stripe returns them to the plan page in the dashboard. Only the workspace owner can open it. The route takes no body.
Like Start a subscription, this route answers 404 subscriptions_not_enabled while subscription checkout is switched off.
Response
urlstringThe Stripe billing portal URL.
Errors
| HTTP | Code | When |
|---|---|---|
| 400 | no_stripe_customer | The workspace has never paid through Stripe, so there is no billing history yet. |
| 401 | invalid_api_key | Missing, invalid or revoked API key. |
| 403 | capability_missing | Only the workspace owner can open the portal. |
| 404 | subscriptions_not_enabled | Subscription checkout is not switched on. |
| 500 | portal_failed | Stripe could not create the session. |