Skip to main content

Log in a user

POST 
/api/v3/user/:user_id/_action/getLoginURL

This fetches a short-lived, one-time-use login URL that you can use to automatically log a user into the ChargeOver customer portal. This link is only valid for a very short amount of time, so you must forward the user to this URL immediately. The user will be immediately and automatically logged into the customer portal.

By default when the user is logged in, they will be dropped on the home page. You can optionally specify a destination attribute to send them to a specific page of the portal after login.

Possible values for destination:

  • subscriptions (for the list of subscriptions)
  • invoices (for the list of invoices)
  • payments (for the list of payments)
  • info (for the "My Info" page with the company/name/phone/etc.)
  • paymethods (for the "Payment Methods" tab with credit card info, etc.)
  • paymethods-creditcard (the "Payment Methods" tab, and prompt the user to save a new credit card)
  • paymethods-ach (the "Payment Methods" tab, and prompt the user to save a new bank account)
  • password (for the "Change My Password" tab)

Request​

Body

    _comment string
    destination string

    Possible values: [subscriptions, invoices, payments, info, paymethods, paymethods-creditcard, paymethods-ach, password]

Responses​

Action completed successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable
    response boolean
Loading...