//Customize Org

Customizing Your Organization

This tutorial is for organization administrators and covers how to personalize an organization's profile, including branding colors, logos, and credit card processing fee strategies.

Prerequisites

  • You are authenticated as an administrator for the organization.
  • You have the org_uuid of the organization you want to manage.

    • ---

    Step 1: Update Organization Profile & Fees

    You can update the organization's basic details and specify how you want to handle credit card processing fees for your customers.

    Endpoint: PUT /api/organizations/:org_uuid

    Fee Strategies Available:

  • null / "": Absorb fees (default)
  • flat: Charge a flat fee amount (in cents).
  • passthrough: Pass the equivalent Stripe charge fee directly to the user.
  • custom: Define a custom JSON fee logic.

Example Request:

~~~bash curl -X PUT https://api.buttrbase.com/api/organizations/org-uuid-12345 \ -H "Content-Type: application/json" \ -H "Authorization: Bearer " \ -d '{ "name": "Acme Corp", "org_display_name": "Acme Corporation", "fee_strategy": "flat", "flat_fee_amount": 50 }' ~~~

---

Step 2: Set Brand Colors and Name

You can explicitly set a Brand Name and a Primary Color (hex code) that will be used across the dashboard and hosted invoices.

Endpoint: PUT /api/organizations/:org_uuid/branding

Example Request:

~~~bash curl -X PUT https://api.buttrbase.com/api/organizations/org-uuid-12345/branding \ -H "Content-Type: application/json" \ -H "Authorization: Bearer " \ -d '{ "brand_name": "Acme SaaS", "primary_color": "#4f46e5" }' ~~~

---

Step 3: Upload an Organization Logo

You can upload an image to serve as the logo for your organization (e.g., to be displayed on user-facing checkout pages or invoices). This utilizes our fast, zero-dependency S3 integration.

Endpoint: POST /api/organizations/:org_uuid/branding/logo

Example Request using curl:

~~~bash curl -X POST https://api.buttrbase.com/api/organizations/org-uuid-12345/branding/logo \ -H "Authorization: Bearer " \ -F "logo=@/path/to/your/logo.png" ~~~

Expected Response (200 OK):

~~~json { "logo_url": "https://bucket.s3.region.amazonaws.com/orgs/org-uuid-12345/logo.png", "primary_color": "#4f46e5", "brand_name": "Acme SaaS" } ~~~