Get the project's effective billing terms

import { Photon } from "@photon-ai/api";

const photon = new Photon({
  headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.organizations.billing.getEffectiveTerms({
  path: {
    organizationId: "organizationId",
    projectId: "projectId",
  },
});

import os

from photon_api import Photon
from photon_api.rpc_generated import GetEffectiveTermsInput

photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.organizations.billing.get_effective_terms(
    GetEffectiveTermsInput.model_validate({
        "path": {
            "organizationId": "organizationId",
            "projectId": "projectId",
        },
    })
)

use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
    .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
    .build()?;
let result = client
    .get_effective_terms("organizationId".to_owned(), "projectId".to_owned())
    .await
    .map_err(|error| format!("{error:?}"))?
    .into_inner();

{
  "creditBalance": null,
  "subscriptions": [
    {
      "cancelsAt": null,
      "category": "string",
      "currentPeriodEnd": "string",
      "currentPeriodStart": "string",
      "nextBillingAt": "string",
      "paymentMode": "automatic",
      "plan": {
        "baseAmountCents": 0,
        "categoryDisplayName": null,
        "currency": "string",
        "description": null,
        "entitlements": [
          {}
        ],
        "fixedCharges": [
          {}
        ],
        "interval": "weekly",
        "isDefault": true,
        "minimumCommitment": null,
        "name": "string",
        "payInAdvance": true,
        "planCode": "string",
        "tier": null,
        "tierDisplayName": null,
        "usageCharges": [
          {}
        ],
        "usageThresholds": [
          {}
        ]
      },
      "planSource": "catalog",
      "scheduledPlanChange": null
    }
  ],
  "timeZone": "string"
}

import { Photon } from "@photon-ai/api";

const photon = new Photon({
  headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.organizations.billing.getEffectiveTerms({
  path: {
    organizationId: "organizationId",
    projectId: "projectId",
  },
});

import os

from photon_api import Photon
from photon_api.rpc_generated import GetEffectiveTermsInput

photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.organizations.billing.get_effective_terms(
    GetEffectiveTermsInput.model_validate({
        "path": {
            "organizationId": "organizationId",
            "projectId": "projectId",
        },
    })
)

use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
    .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
    .build()?;
let result = client
    .get_effective_terms("organizationId".to_owned(), "projectId".to_owned())
    .await
    .map_err(|error| format!("{error:?}"))?
    .into_inner();

{
  "creditBalance": null,
  "subscriptions": [
    {
      "cancelsAt": null,
      "category": "string",
      "currentPeriodEnd": "string",
      "currentPeriodStart": "string",
      "nextBillingAt": "string",
      "paymentMode": "automatic",
      "plan": {
        "baseAmountCents": 0,
        "categoryDisplayName": null,
        "currency": "string",
        "description": null,
        "entitlements": [
          {}
        ],
        "fixedCharges": [
          {}
        ],
        "interval": "weekly",
        "isDefault": true,
        "minimumCommitment": null,
        "name": "string",
        "payInAdvance": true,
        "planCode": "string",
        "tier": null,
        "tierDisplayName": null,
        "usageCharges": [
          {}
        ],
        "usageThresholds": [
          {}
        ]
      },
      "planSource": "catalog",
      "scheduledPlanChange": null
    }
  ],
  "timeZone": "string"
}

GET /v1/organizations/{organizationId}/billing/projects/{projectId}/terms Returns what the selected project is billed on now, per category it holds: the plan as its subscription has it, with any override applied, each fixed charge at the subscription’s price and quantity, and resolved entitlements; where the plan comes from; how invoices are paid; the current period and next billing date; and any downgrade or cancellation waiting for the period end. It also returns the credit the paying organization holds on credit notes, such as the unused time of a plan an upgrade replaced; it offsets that organization’s next invoices. Supply both organizationId and projectId; the organization must pay for the project. This operation does not change billing.

TypeScript
Python
Rust

TypeScript

photon.organizations.billing.getEffectiveTerms(input: GetEffectiveTermsInput, options?: RequestOptions): Promise<GetEffectiveTermsOutput>

Python

photon.organizations.billing.get_effective_terms(input: GetEffectiveTermsInput) -> models.GetEffectiveTermsResponse

Rust

client.get_effective_terms(organization_id: String, project_id: String).await -> Result<ResponseValue<types::GetEffectiveTermsResponse>, Error<GetEffectiveTermsError>>

import { Photon } from "@photon-ai/api";

const photon = new Photon({
  headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.organizations.billing.getEffectiveTerms({
  path: {
    organizationId: "organizationId",
    projectId: "projectId",
  },
});

import os

from photon_api import Photon
from photon_api.rpc_generated import GetEffectiveTermsInput

photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.organizations.billing.get_effective_terms(
    GetEffectiveTermsInput.model_validate({
        "path": {
            "organizationId": "organizationId",
            "projectId": "projectId",
        },
    })
)

use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
    .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
    .build()?;
let result = client
    .get_effective_terms("organizationId".to_owned(), "projectId".to_owned())
    .await
    .map_err(|error| format!("{error:?}"))?
    .into_inner();

{
  "creditBalance": null,
  "subscriptions": [
    {
      "cancelsAt": null,
      "category": "string",
      "currentPeriodEnd": "string",
      "currentPeriodStart": "string",
      "nextBillingAt": "string",
      "paymentMode": "automatic",
      "plan": {
        "baseAmountCents": 0,
        "categoryDisplayName": null,
        "currency": "string",
        "description": null,
        "entitlements": [
          {}
        ],
        "fixedCharges": [
          {}
        ],
        "interval": "weekly",
        "isDefault": true,
        "minimumCommitment": null,
        "name": "string",
        "payInAdvance": true,
        "planCode": "string",
        "tier": null,
        "tierDisplayName": null,
        "usageCharges": [
          {}
        ],
        "usageThresholds": [
          {}
        ]
      },
      "planSource": "catalog",
      "scheduledPlanChange": null
    }
  ],
  "timeZone": "string"
}

Parameters

string

required

string

required

The project being billed.

Returns

200 The project’s effective billing terms, per category. GetEffectiveTermsResponse

CreditBalance | null

required

Credit the paying organization holds on credit notes, such as the unused time of a plan an upgrade replaced. It offsets that organization’s next invoices of any kind except one-off invoices. Prepaid wallet credit is separate. Null when it holds none.

array of SubscriptionTerms

required

One entry per category the project holds, by category. Empty means it holds none.

string

required

The IANA time zone the payer is billed in, e.g. America/Los_Angeles. Billing periods start and end at its midnights, so read their calendar dates in it.

⌘I

Get started

Guides

Reference

SDK reference

Get the project's effective billing terms

Parameters

Returns

​Parameters

​Returns

Parameters

Returns