Payment Organization Subscriptions Partial Update 2

{
  "id": 1,
  "created_at": "2024-01-15T09:30:00Z",
  "log_visibility_cutoff_at": "2024-01-15T09:30:00Z",
  "project": "string",
  "subscription_unique_id": "string",
  "subscribed_at": "2024-01-15T09:30:00Z",
  "free_trial_end_at": "2024-01-15T09:30:00Z",
  "plan": "none",
  "deal_id": "string",
  "monthly_recurring_revenue": 1.1,
  "expected_annual_contract_value": 1.1,
  "customer_ids": [
    "string"
  ],
  "metered_item_id": "string",
  "seat_based_item_id": "string",
  "base_item_id": "string",
  "stripe_customer_id": "string",
  "usage_report_subscription_id": "string",
  "subscription_id": "string",
  "current_period_start": 1.1,
  "current_period_end": 1.1,
  "current_usage_period_start": 1.1,
  "current_usage_period_end": 1.1,
  "usage_in_period": 1.1,
  "keywordsai_llm_credentials_usage_in_period": 1.1,
  "keywordsai_llm_credentials_usage_last_period": 1.1,
  "logs_in_period": 1,
  "logs_in_last_period": 1,
  "logs_three_months_ago": 1,
  "customer_user_count": 1,
  "prompt_count": 1,
  "evals_in_period": 1,
  "evals_in_last_period": 1,
  "member_count": 1,
  "past_billing_periods": [
    null
  ],
  "last_usage_reported": 1.1,
  "last_reconciled_at": 1.1,
  "billing_method": "stripe",
  "billing_period": "monthly",
  "usage_report_interval": "monthly",
  "current_period_invoice_amount": 1.1,
  "last_period_invoice_amount": 1.1,
  "budget": 1.1,
  "credit_balance": 1.1,
  "custom_log_limit": 1,
  "custom_plan_name": "string",
  "custom_monthly_cost": 1.1,
  "custom_yearly_cost": 1.1,
  "subscription_bool": true,
  "accumulative_balance": 1.1,
  "periodic_invoice_amount": 1.1,
  "org": 1,
  "company_organization": 1,
  "billing_subscription": 1,
  "organization": 1
}

PATCH handler with superadmin lock and field protection.

Checks:

Object lock (is_managed=True -> non-superadmins can’t modify)
Field protection (non-superadmins can’t modify specific fields)

Authentication

AuthorizationBearer

JWT access token or Respan API key

Path parameters

unique_organization_idstringRequired

Request

This endpoint expects an object.

projectstring or nullOptional>=1 character

subscription_unique_idstring or nullOptional<=100 characters

subscribed_atdatetime or nullOptional

free_trial_end_atdatetime or nullOptional

planenumOptional

deal_idstringOptional<=50 characters

monthly_recurring_revenuedoubleOptional

expected_annual_contract_valuedoubleOptional

customer_idslist of stringsOptional

metered_item_idstring or nullOptional<=50 characters

seat_based_item_idstring or nullOptional<=50 characters

base_item_idstring or nullOptional<=50 characters

stripe_customer_idstringOptional<=70 characters

usage_report_subscription_idstringOptional<=50 characters

subscription_idstringOptional<=50 characters

current_period_startdoubleOptional

current_period_enddoubleOptional

current_usage_period_startdoubleOptional

current_usage_period_enddoubleOptional

usage_in_perioddoubleOptional

keywordsai_llm_credentials_usage_in_perioddoubleOptional

keywordsai_llm_credentials_usage_last_perioddoubleOptional

logs_in_periodintegerOptional-2147483648-2147483647

logs_in_last_periodintegerOptional-2147483648-2147483647

logs_three_months_agointegerOptional-2147483648-2147483647

customer_user_countintegerOptional-2147483648-2147483647

prompt_countintegerOptional-2147483648-2147483647

evals_in_periodintegerOptional-2147483648-2147483647

evals_in_last_periodintegerOptional-2147483648-2147483647

member_countintegerOptional-2147483648-2147483647

past_billing_periodslist of anyOptional

last_usage_reporteddoubleOptional

last_reconciled_atdouble or nullOptional

billing_methodenumOptional

stripe - Stripe
invoice - Invoice
other - Other

billing_periodenumOptional

monthly - Monthly
yearly - Yearly

usage_report_intervalenumOptional

monthly - Monthly
yearly - Yearly

current_period_invoice_amountdoubleOptional

last_period_invoice_amountdoubleOptional

budgetdouble or nullOptional

credit_balancedoubleOptional

Current available Keywords AI credit balance in USD

custom_log_limitinteger or nullOptional-2147483648-2147483647

custom_plan_namestringOptional<=50 characters

custom_monthly_costdouble or nullOptional

custom_yearly_costdouble or nullOptional

deprecated_subscription_idsanyOptional

subscription_boolbooleanOptional

custom_subscriptionanyOptional

custom_bundleanyOptional

accumulative_balancedoubleOptional

periodic_invoice_amountdoubleOptional

orginteger or nullOptional

company_organizationinteger or nullOptional

billing_subscriptioninteger or nullOptional

If set, credits and billing are managed by this subscription (company-level billing). NULL means this subscription manages its own billing (is a primary billing subscription).

organizationinteger or nullOptional

Response

idintegerRead-only

created_atdatetime or nullRead-only

log_visibility_cutoff_atdatetime or nullRead-only

projectstring or null

subscription_unique_idstring or null<=100 characters

subscribed_atdatetime or null

free_trial_end_atdatetime or null

planenum

deal_idstring<=50 characters

monthly_recurring_revenuedouble

expected_annual_contract_valuedouble

customer_idslist of strings

metered_item_idstring or null<=50 characters

seat_based_item_idstring or null<=50 characters

base_item_idstring or null<=50 characters

stripe_customer_idstring<=70 characters

usage_report_subscription_idstring<=50 characters

subscription_idstring<=50 characters

current_period_startdouble

current_period_enddouble

current_usage_period_startdouble

current_usage_period_enddouble

usage_in_perioddouble

keywordsai_llm_credentials_usage_in_perioddouble

keywordsai_llm_credentials_usage_last_perioddouble

logs_in_periodinteger-2147483648-2147483647

logs_in_last_periodinteger-2147483648-2147483647

logs_three_months_agointeger-2147483648-2147483647

customer_user_countinteger-2147483648-2147483647

prompt_countinteger-2147483648-2147483647

evals_in_periodinteger-2147483648-2147483647

evals_in_last_periodinteger-2147483648-2147483647

member_countinteger-2147483648-2147483647

past_billing_periodslist of any

last_usage_reporteddouble

last_reconciled_atdouble or null

billing_methodenum

stripe - Stripe
invoice - Invoice
other - Other

billing_periodenum

monthly - Monthly
yearly - Yearly

usage_report_intervalenum

monthly - Monthly
yearly - Yearly

current_period_invoice_amountdouble

last_period_invoice_amountdouble

budgetdouble or null

credit_balancedouble

Current available Keywords AI credit balance in USD

custom_log_limitinteger or null-2147483648-2147483647

custom_plan_namestring<=50 characters

custom_monthly_costdouble or null

custom_yearly_costdouble or null

deprecated_subscription_idsany

subscription_boolboolean

custom_subscriptionany

custom_bundleany

accumulative_balancedouble

periodic_invoice_amountdouble

orginteger or null

company_organizationinteger or null

billing_subscriptioninteger or null

If set, credits and billing are managed by this subscription (company-level billing). NULL means this subscription manages its own billing (is a primary billing subscription).

organizationinteger or null

$	curl -X PATCH https://api.respan.ai/payment/organization-subscriptions/unique_organization_id/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'