PUT /api/v1/current_company

Update the company information for currently authenticated user

Request

$ curl -X PUT https://api.payhere.co/api/v1/current_company \
       -H "Accept: application/json" \
       -H "Authorization: Bearer ${api_key_here}"
       -d '{"name": "New company name"}'

require "http"
require "json"

resp = HTTP.auth("Bearer #{api_key_here}")
           .put("https://api.payhere.co/api/v1/current_company", json: { name: "New company name" })

parsed = JSON.parse(resp.body)

Params

  • name - Display name of the company
  • legal_name - Legal name of the company, displayed on receipts
  • address - Company address, displayed on receipts
  • logo - Logo image for the company
  • support_email - Support email, displayed within receipts
  • website - Company website, displayed within receipts
  • button_color - Hex color for the pay button background on payment forms and email receipts (e.g. #ff6600)
  • button_text - Empty (auto detect), "white" or "black" to force to white or black text.

Response

{
  "data": {
    "id": 1,
    "name": "New company name",
    "legal_name": "Alternate Labs Ltd",
    "slug": "altlabs",
    "ready": true,
    "country_code": "GB",
    "button_color": "#db0031",
    "button_text": "white",
    "role": "testing",
    "stripe_connected": true,
    "gocardless_connected": true,
    "currency": "gbp",
    "vat_registered": true,
    "vat_rate": "20.0",
    "created_at": "2018-06-07T21:54:53.617Z",
    "updated_at": "2020-04-05T18:39:28.637Z",
    "type": "companies",
    "plan": "pro",
    "subscription_status": "trial",
    "active_until": "2020-04-08T18:28:12.798Z",
    "testing_access": true,
    "support_email": "hello@example.org",
    "website": "https://alternatelabs.co",
    "address": "123 Anystreet,\r\nAnytime, BT1 1AB",
    "vat_registration_number": "XYZ",
    "vat_mechanism": "always",
    "custom_domain": null,
    "users": [
      {
        "id": 1,
        "display_name": "Pete Test",
        "email": "pete@example.org",
        "role": "user",
        "created_at": "2018-06-07T21:54:53.778Z",
        "updated_at": "2020-04-06T10:37:28.065Z",
        "type": "users"
      }
    ]
  }
}

Errors

  • 401 Unauthorized
  • 400 Bad request - validation erros returned
← GET /GET /stats →