Welcome to Albato Help

Method for setting a user billing plan


IN THIS ARTICLE

This method is intended to set a billing plan (monthly transaction limit) for the specified user.

Authorization: This method should be called with the partner's master account token.

Request:

POST https://api.albato.com/wl/partner-name/set-user-plan

Where partner-name is your company name (partner name) in Albato.

Request parameters:

  • id — An alphanumeric user ID that the partner passes when creating a new user. In most cases, this is the user’s nickname, the part of the email address before @your-domain (for example, john.smith from john.smith@your-domain). Use the same value consistently and insert it into the id field.

  • planId — A billing plan ID to be set for your user

Response parameters:

  • success — Request success indicator. Available values: true or false

Request example via curl:

curl --header "Content-type: application/json" --header "Accept: application/json" --header "Authorization: Basic cEFJjGffUSkV6WFFyWUhBM1RzS2hRHg7iKgReghUiijBfrdTY6" --data '{"id":"test", "planId": 23}' "https://api.albato.com/wl/partner-name/set-user-plan"

Response example:

{ "success": true, "data": [] }

Did this answer your question?