Agency API Agency

Update a billing plan

POST https://api.tamio.com/v2/agency/plans/update/{uuid}

Updates an existing agency billing plan. The UUID and tax category are required. Only the fields you want to change need to be included.

Path Parameters

uuid string*

Body Parameters

tax_category string*

Tax category (always "Agency Billing Plan")

Agency Billing Plan

buyable boolean

Whether this plan can be purchased by clients

shown boolean

Whether this plan is visible to clients

on_sale boolean

Whether this plan is currently on sale

discount_allowed boolean

Whether discount codes can be applied

unlimited_stock boolean

Whether this plan has unlimited availability

trial_period integer

Trial period in days (0 for no trial)

retries integer

Number of payment retry attempts for failed charges (0–3)

cancel_action string

Action to take when subscription fails after all retries

cancelpause

cancel_behaviour string

When cancellation takes effect

immediateend_of_period

descriptor string

Short text that appears on credit card statements

languages object

Multilingual content keyed by language code. Each language object must contain a title.

quotas object

Resource quotas for clients on this plan (same structure as create endpoint)

permissions object

Feature permissions for clients on this plan (same structure as create endpoint)

overages object

Overage pricing when quotas are exceeded. All fields are optional on update; only include fields you want to change.

JSON

{ "overages": { "client_overage": true, "charge_client_overage": true, "storage": 0.5, "datatransfer": 0.1, "transactions": 0.05, "domains": 5, "languages": 3, "currencies": 2, "clients": 10, "newsletters": 0.01, "teammates": 8 } }

client_overage boolean

Whether overage charges are passed to the client

charge_client_overage boolean

Whether to automatically charge clients for overages

storage number

Price per GB for storage overage

datatransfer number

Price per GB for data transfer overage

transactions number

Price per transaction overage

domains number

Price per additional domain

languages number

Price per additional language

currencies number

Price per additional currency

clients number

Price per additional client

newsletters number

Price per additional newsletter send

teammates number

Price per additional teammate

Example

{
  "tax_category": "Agency Billing Plan",
  "buyable": true,
  "trial_period": 30,
  "languages": {
    "en": {
      "title": "Starter Plan Updated"
    }
  },
  "quotas": {
    "products_quota": 200,
    "domains_quota": 5
  }
}

Responses

200 Billing plan updated successfully

Billing plan updated successfully

status integer

product Product

400 Validation or business-logic error.

Code	Description
`1002`	Billing plan not found

401 Unauthorized – invalid or missing Bearer token

Create a billing plan

Delete a billing plan

/agency/plans/update/{uuid}

1 const response = await fetch("https://api.tamio.com/v2/agency/plans/update/{uuid}", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "tax_category": "Agency Billing Plan",
9     "buyable": true,
10     "trial_period": 30,
11     "languages": {
12       "en": {
13         "title": "Starter Plan Updated"
14       }
15     },
16     "quotas": {
17       "products_quota": 200,
18       "domains_quota": 5
19     }
20   })
21 });
22 const data = await response.json();

1 require "uri"
2 require "net/http"
3 require "json"
4 
5 url = URI("https://api.tamio.com/v2/agency/plans/update/{uuid}")
6 
7 https = Net::HTTP.new(url.host, url.port)
8 https.use_ssl = true
9 
10 request = Net::HTTP::Post.new(url)
11 request["Accept"] = "application/json"
12 request["Authorization"] = "Bearer YOUR_API_KEY"
13 request["Content-Type"] = "application/json"
14 request.body = {
15   tax_category: "Agency Billing Plan",
16   buyable: true,
17   trial_period: 30,
18   languages: {
19     en: {
20       title: "Starter Plan Updated"
21     }
22   },
23   quotas: {
24     products_quota: 200,
25     domains_quota: 5
26   }
27 }.to_json
28 
29 response = https.request(request)
30 puts response.read_body

Responses

{
  "status": 200,
  "product": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "object": "product",
    "name": "Starter Plan",
    "description": "Perfect for small businesses",
    "seo_title": "Starter Plan - Best for Small Teams",
    "seo_description": "Get started with our affordable starter plan.",
    "classification": "Agency Billing Plan",
    "type": "billing_plan",
    "currency": "EUR",
    "price": 2999,
    "pricing_model": [
      {
        "currency": "EUR",
        "price": 2999,
        "transaction_fees": 0,
        "transaction_fees_cents": 0,
        "billing_cycle": "month",
        "interval": 1,
        "stripe_price_id": "price_1234567890"
      }
    ],
    "stock": null,
    "created": 1700000000,
    "updated_unix": 1700086400,
    "has_variations": false,
    "has_notes": false,
    "is_moss_product": false,
    "billing_cycle": "month",
    "interval": 1,
    "trial_period": 14,
    "descriptor": "ACME STARTER",
    "retries": 3,
    "cancel_action": "cancel",
    "cancel_behaviour": "end_of_period",
    "charge_shipping_during_trial": true,
    "has_stripe_price": false,
    "is_customer_product": false,
    "on_sale": true,
    "discount_allowed": true,
    "reviews_allowed": false,
    "hide_if_no_stock": true,
    "shown": true,
    "buyable": true,
    "whitelist": null,
    "in_stock": true,
    "unlimited_stock": false,
    "min_units": null,
    "max_units": null,
    "stock_limit_warning": null,
    "allow_negative_stock": false,
    "permissions": {
      "products": {
        "view": true,
        "create": true,
        "edit": true,
        "remove": true
      },
      "invoices": {
        "view": true,
        "create": true,
        "edit": true,
        "remove": true
      },
      "customers": {
        "view": true,
        "create": true,
        "edit": true,
        "remove": true
      }
    },
    "quotas": {
      "automations_quota": 50,
      "transaction_quota": 1000,
      "datatransfer_quota": 10,
      "storage_quota": 5,
      "languages_quota": 3,
      "products_quota": 100,
      "domains_quota": 3,
      "currencies_quota": 5,
      "teammates_quota": 5,
      "api_quota": 1000000,
      "newsletters_quota": 5000,
      "ai_quota": 100,
      "sms_balance": 500
    },
    "overages": {
      "client_overage": true,
      "charge_client_overage": true,
      "storage": 0.5,
      "datatransfer": 0.1,
      "transactions": 0.05,
      "domains": 5,
      "languages": 3,
      "currencies": 2,
      "clients": 10,
      "newsletters": 0.01,
      "teammates": 8
    },
    "active_clients": 12,
    "clients": [
      {
        "id": "660e8400-e29b-41d4-a716-446655440000",
        "name": "Acme Corp",
        "email": "[email protected]"
      }
    ],
    "content": {
      "en": {
        "title": "Starter Plan",
        "description": "Perfect for small businesses",
        "slug": "starter-plan"
      }
    },
    "gallery": []
  }
}

1	const response = await fetch("https://api.tamio.com/v2/agency/plans/update/{uuid}", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"tax_category": "Agency Billing Plan",
9	"buyable": true,
10	"trial_period": 30,
11	"languages": {
12	"en": {
13	"title": "Starter Plan Updated"
14	}
15	},
16	"quotas": {
17	"products_quota": 200,
18	"domains_quota": 5
19	}
20	})
21	});
22	const data = await response.json();

1	require "uri"
2	require "net/http"
3	require "json"
4
5	url = URI("https://api.tamio.com/v2/agency/plans/update/{uuid}")
6
7	https = Net::HTTP.new(url.host, url.port)
8	https.use_ssl = true
9
10	request = Net::HTTP::Post.new(url)
11	request["Accept"] = "application/json"
12	request["Authorization"] = "Bearer YOUR_API_KEY"
13	request["Content-Type"] = "application/json"
14	request.body = {
15	tax_category: "Agency Billing Plan",
16	buyable: true,
17	trial_period: 30,
18	languages: {
19	en: {
20	title: "Starter Plan Updated"
21	}
22	},
23	quotas: {
24	products_quota: 200,
25	domains_quota: 5
26	}
27	}.to_json
28
29	response = https.request(request)
30	puts response.read_body