Get the billing contract for an organizationhidden
hidden
Path parameters
/{id}
stringUUID//
Response
- 200 OK
- //
account_id:
stringUUID,//contract_id:
stringUUID,//currency:
string,//discount_description:
string,//effective_at:
stringISO-8601,//external_customer_id:
string,//name:
string,//notes:
string,//term_end_at:
stringISO-8601,//billing_cadence:
,"annual"+3▾- //The contract is managed on an annual cycle.
"annual" - //The contract is managed on a quarterly cycle.
"quarterly" - //The contract is managed on a monthly cycle.
"monthly" - //The contract does not follow a fixed automated cadence.
"manual"
//commitment_scope:
,"pooled"+1▾- //One shared commitment pool may fund multiple contract items.
"pooled" - //Each contract item effectively manages its own commitment budget.
"per_item"
//:
[[ ... ],//- //
active:
boolean,//display_name:
string,//fixed_fee_amount:
numberUSD Price,//id:
stringUUID,//is_commitment_eligible:
boolean,//billing_unit_granularity:
,"minute"+1▾- //Usage should be normalized or rounded at the minute level.
"minute" - //Usage should be normalized or rounded at the second level.
"second"
//code:
,"enterprise_support"+4▾- //Fixed or recurring enterprise support entitlement.
"enterprise_support" - //Full deployment environment or similar managed environment charge.
"fde" - //GovCloud-specific management or hosting charge.
"govcloud_management" - //Billing for the first successful conversion of a file version.
"file_ingestion_conversion" - //Contract-rated API usage credits.
"licensed_api_credits"
//kind:
,"fixed_fee"+2▾- //A flat amount that does not vary with measured usage.
"fixed_fee" - //Usage is rated by one or more explicit pricing tiers.
"usage_tiered" - //Usage burns down a commitment bucket before any overage path.
"usage_commitment_bucket"
//:
[[ ... ],//- //
id:
stringUUID,//tier_end_exclusive:
numberint64,//tier_start_inclusive:
numberint64,//unit_price:
numberUSD Price//
}
]
unit:
"file"+4▾- //Quantity is counted in files.
"file" - //Quantity is counted in whole or rounded minutes.
"minute" - //Quantity is counted in seconds.
"second" - //Quantity is counted in years.
"year" - //Quantity is counted once per billing period.
"period"
//
}
]
:
[[ ... ],//- //
commitment_amount:
numberUSD Price,//id:
stringUUID,//period_end_at:
stringISO-8601,//period_index:
numberint32,//period_start_at:
stringISO-8601,//rollover_in_amount:
numberUSD Price,//rollover_out_amount:
numberUSD Price,//status:
"open"+1▾- //Period is active and may still accrue usage or adjustments.
"open" - //Period is finalized and should be treated as read-only for billing purposes.
"closed"
//
}
]
provider:
,"stripe"+1▾- //Charges are ultimately collected through Stripe.
"stripe" - //Charges are collected outside Stripe, usually by finance or contract workflow.
"manual_invoice"
//rollover_policy:
,"none"+1▾- //Unused commitment expires at the end of the period.
"none" - //Unused year-one commitment may roll once into year two, but not beyond.
"year1_to_year2_once"
//status:
"draft"+4▾- //Contract terms are still being assembled and should not drive billing yet.
"draft" - //Contract is committed for a future start date and should not drive billing yet.
"scheduled" - //Contract is in force and may be used for rating and funding decisions.
"active" - //Contract finished its intended term and is no longer accruing new periods.
"closed" - //Contract was intentionally terminated before completing its intended term.
"canceled"
//
}
Examples
get
/orgs/{id}/billing/contract200 OK
Response