Update Spending Limits For Org

PUT

billing

limits

curl --request PUT \
  --url https://api.pulze.ai/v1/billing/limits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "spending_limit_soft": 0,
  "spending_limit_hard": 0
}'

{
  "spending_limit_soft": 0,
  "spending_limit_hard": 0,
  "currency": "usd",
  "balance": 0,
  "last_invoice_date": 123,
  "billing_zip": "<string>",
  "subscription": {
    "max_tokens": 123,
    "max_apps": 123,
    "llm_routing": true,
    "prompts": true,
    "prompt_models": true,
    "personalized_llm_routing": true,
    "fine_tuning": true,
    "support_level": "community",
    "customer_success": true,
    "max_tokens_readable": "<string>",
    "max_apps_readable": "<string>",
    "support_level_readable": "<string>",
    "is_trial": false,
    "is_none": false,
    "tier": "_NONE_",
    "name": "<string>",
    "monthly_price_usd": 123,
    "yearly_price_usd": 123,
    "monthly_discounted_usd": 123,
    "yearly_discounted_usd": 123,
    "monthly_price_id": "<string>",
    "yearly_price_id": "<string>",
    "monthly_price_label": "<string>",
    "yearly_price_label": "<string>",
    "monthly_contact_sales": false,
    "yearly_contact_sales": false,
    "monthly_button_label": "<string>",
    "yearly_button_label": "<string>"
  },
  "subscription_paused": {
    "invoices": [
      {
        "invoice_id": "<string>",
        "invoice_number": "<string>",
        "amount": 123,
        "timestamp": 123,
        "pause_reason": "<string>",
        "invoice_name": "<string>",
        "payment_link": "<string>",
        "severity": 1
      }
    ]
  },
  "trial_end": "2023-11-07T05:31:56Z",
  "trial_ending_soon": false
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

spending_limit_soft

number

default:0

When the balance crosses this value, a warning email will be sent informing the customer

spending_limit_hard

number

default:0

When the balance crosses this value, a high-warning email will be sent informing the customer that services will be disrupted if the balance reaches 0

Response

200

application/json

Successful Response

last_invoice_date

integer

required

The timestamp when the local balance (i.e. the value we keep track of) was synced with stripe (and the customer was billed)

billing_zip

string | null

required

The Zipcode of the address of the Organization

subscription

object

required

Details on the currently active subscription

subscription.max_tokens

integer

required

The maximum number of tokens that can be generated, for each billing period (month)

Required range: x > 0

subscription.max_apps

integer

required

Maximum number of apps that can be created

subscription.prompts

boolean

required

Allows the user to create and use Prompts

subscription.prompt_models

boolean

required

Allows the user to create and use Prompt-based Models

subscription.personalized_llm_routing

boolean

required

Custom scoring of LLMs using KG

subscription.fine_tuning

boolean

required

Allows to fine-tune models

subscription.support_level

enum<string>

required

The level of support this user has access to

Available options:

community,

all

subscription.customer_success

boolean

required

Support from Marketing team (? TBD)

subscription.max_tokens_readable

string

required

A human-readable format of max_tokens. Example: '50bn' or '+100M'

subscription.max_apps_readable

string

required

A human-readable format of max_apps. Example: 'Infinite' or '1000' or 'None'

subscription.support_level_readable

string

required

A human-readable format for the level of support offered

subscription.tier

enum<string>

required

The tier of this subscription

Available options:

_NONE_,

_TRIAL_,

_INTERNAL_,

STARTUP,

GROWTH,

SCALE,

ENTERPRISE

subscription.name

string

required

The name for this subscription

subscription.monthly_price_usd

number | null

required

Price per MONTH -- same as in Stripe, here for display purposes

subscription.yearly_price_usd

number | null

required

Price per YEAR -- same as in Stripe, here for display purposes

subscription.monthly_price_id

string | null

required

The Stripe PriceID for the monthly subscription

subscription.yearly_price_id

string | null

required

The Stripe PriceID for the yearly subscription

subscription.llm_routing

boolean

default:true

Dynamic LLM routing using KG

subscription.is_trial

boolean

default:false

Whether this subscription is a trial. Trials work differently because users can only consume the free credit, but can't go over it

subscription.is_none

boolean

default:false

This is set to TRUE when the user's doesn't have a subscription nor is in a trial. Essentially it means: "No subscription active".

subscription.monthly_discounted_usd

number | null

Price per MONTH -- same as in Stripe, here for display purposes

subscription.yearly_discounted_usd

number | null

Price per YEAR -- same as in Stripe, here for display purposes

subscription.monthly_price_label

string | null

A label to display in lieu of price

subscription.yearly_price_label

string | null

A label to display in lieu of price

subscription.monthly_contact_sales

boolean

default:false

Contact sales to activate

subscription.yearly_contact_sales

boolean

default:false

Contact sales to activate

subscription.monthly_button_label

string | null

If set, it will override any other labels

subscription.yearly_button_label

string | null

If set, it will override any other labels

subscription_paused

object | null

required

Returned to the frontend when the subscription has been paused for any reason.

spending_limit_soft

number

default:0

When the balance crosses this value, a warning email will be sent informing the customer

spending_limit_hard

number

default:0

When the balance crosses this value, a high-warning email will be sent informing the customer that services will be disrupted if the balance reaches 0

currency

enum<string>

default:usd

The currency of the organization

Available options:

usd

balance

number

default:0

The balance in the account. Synced with Stripe periodically

trial_end

string | null

The datetime when the trial ends (or None, if the user is not in a trial)

trial_ending_soon

boolean

default:false

When the trial is coming to an end, we notify the Frontend (calculated on the server side)

Was this page helpful?

Raise issue

curl --request PUT \
  --url https://api.pulze.ai/v1/billing/limits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "spending_limit_soft": 0,
  "spending_limit_hard": 0
}'

{
  "spending_limit_soft": 0,
  "spending_limit_hard": 0,
  "currency": "usd",
  "balance": 0,
  "last_invoice_date": 123,
  "billing_zip": "<string>",
  "subscription": {
    "max_tokens": 123,
    "max_apps": 123,
    "llm_routing": true,
    "prompts": true,
    "prompt_models": true,
    "personalized_llm_routing": true,
    "fine_tuning": true,
    "support_level": "community",
    "customer_success": true,
    "max_tokens_readable": "<string>",
    "max_apps_readable": "<string>",
    "support_level_readable": "<string>",
    "is_trial": false,
    "is_none": false,
    "tier": "_NONE_",
    "name": "<string>",
    "monthly_price_usd": 123,
    "yearly_price_usd": 123,
    "monthly_discounted_usd": 123,
    "yearly_discounted_usd": 123,
    "monthly_price_id": "<string>",
    "yearly_price_id": "<string>",
    "monthly_price_label": "<string>",
    "yearly_price_label": "<string>",
    "monthly_contact_sales": false,
    "yearly_contact_sales": false,
    "monthly_button_label": "<string>",
    "yearly_button_label": "<string>"
  },
  "subscription_paused": {
    "invoices": [
      {
        "invoice_id": "<string>",
        "invoice_number": "<string>",
        "amount": 123,
        "timestamp": 123,
        "pause_reason": "<string>",
        "invoice_name": "<string>",
        "payment_link": "<string>",
        "severity": 1
      }
    ]
  },
  "trial_end": "2023-11-07T05:31:56Z",
  "trial_ending_soon": false
}

Getting Started

Spaces Guide

Tools Guide

Developer Guide

API REFERENCE

COMMUNITY

PULZE ACADEMY

Update Spending Limits For Org

Authorizations

Body

Response