Payment Organization Subscriptions Retrieve

GET

https://api.respan.ai/payment/organization-subscriptions/:unique_organization_id/

GET

/payment/organization-subscriptions/:unique_organization_id/

$ curl https://api.respan.ai/payment/organization-subscriptions/unique_organization_id/ \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": 1,
3   "created_at": "2024-01-15T09:30:00Z",
4   "log_visibility_cutoff_at": "2024-01-15T09:30:00Z",
5   "project": "string",
6   "subscription_unique_id": "string",
7   "subscribed_at": "2024-01-15T09:30:00Z",
8   "free_trial_end_at": "2024-01-15T09:30:00Z",
9   "plan": "none",
10   "deal_id": "string",
11   "monthly_recurring_revenue": 1.1,
12   "expected_annual_contract_value": 1.1,
13   "customer_ids": [
14     "string"
15   ],
16   "metered_item_id": "string",
17   "seat_based_item_id": "string",
18   "base_item_id": "string",
19   "stripe_customer_id": "string",
20   "usage_report_subscription_id": "string",
21   "subscription_id": "string",
22   "current_period_start": 1.1,
23   "current_period_end": 1.1,
24   "current_usage_period_start": 1.1,
25   "current_usage_period_end": 1.1,
26   "usage_in_period": 1.1,
27   "keywordsai_llm_credentials_usage_in_period": 1.1,
28   "keywordsai_llm_credentials_usage_last_period": 1.1,
29   "logs_in_period": 1,
30   "logs_in_last_period": 1,
31   "logs_three_months_ago": 1,
32   "customer_user_count": 1,
33   "prompt_count": 1,
34   "evals_in_period": 1,
35   "evals_in_last_period": 1,
36   "member_count": 1,
37   "past_billing_periods": [
38     null
39   ],
40   "last_usage_reported": 1.1,
41   "last_reconciled_at": 1.1,
42   "billing_method": "stripe",
43   "billing_period": "monthly",
44   "usage_report_interval": "monthly",
45   "current_period_invoice_amount": 1.1,
46   "last_period_invoice_amount": 1.1,
47   "budget": 1.1,
48   "credit_balance": 1.1,
49   "custom_log_limit": 1,
50   "custom_plan_name": "string",
51   "custom_monthly_cost": 1.1,
52   "custom_yearly_cost": 1.1,
53   "subscription_bool": true,
54   "accumulative_balance": 1.1,
55   "periodic_invoice_amount": 1.1,
56   "org": 1,
57   "company_organization": 1,
58   "billing_subscription": 1,
59   "organization": 1
60 }

Retrieve, update, or delete a specific organization subscription.

Superadmin: Can access any subscription across all organizations. Regular admin: Can only access their organization’s subscription.

Authentication

AuthorizationBearer

JWT access token or Respan API key

Path parameters

unique_organization_idstringRequired

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