Billing

A Stripe Customer Portal link

Returns a single-use, short-lived URL to the Stripe-hosted portal, where a customer can switch plans, update a card, download invoices and cancel at period end. This is the only way any of those happen: the API cannot change or cancel a subscription, by design.

not_found until the account has a Stripe customer, which the first checkout creates.

post/v1/billing/portal

Request

  • Base URL: https://api.galleyrender.com
  • URL: https://api.galleyrender.com/v1/billing/portal
  • Auth: HTTP bearer

Request body

return_urlstring

Where the portal's back link goes. Must be https on galleyrender.com.

Example request

{
  "return_url": "https://galleyrender.com/dashboard"
}

Response

A portal session.

object'portal_session' required
idstring required
urlstring required
accountstring
canstring[]
next_stepstring

Example response

{
  "id": "bps_1UGP…",
  "url": "https://billing.stripe.com/p/session/…",
  "subscription": {
    "plan_name": "Solo",
    "status": "active"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.