Create or replace the billing contract for an organization

hidden

Parameters

• id

  string / UUID

  required

• bodyapplication/json

  object

  optional

  Object Properties

  • billing_cadence

    string

    optional

    Possible values

    • annual:  The contract is managed on an annual cycle.
    • quarterly:  The contract is managed on a quarterly cycle.
    • monthly:  The contract is managed on a monthly cycle.
    • manual:  The contract does not follow a fixed automated cadence.

  • commitment_scope

    string

    optional

    Possible values

    • pooled:  One shared commitment pool may fund multiple contract items.
    • per_item:  Each contract item effectively manages its own commitment budget.

  • currency

    string

    optional

  • discount_description

    string

    optional

  • effective_at

    string / ISO-8601

    optional

  • external_customer_id

    string

    optional

  • items

    array

    optional

    Array of

    • active

      boolean

      optional

    • billing_unit_granularity

      string

      optional

      Possible values

      • minute:  Usage should be normalized or rounded at the minute level.
      • second:  Usage should be normalized or rounded at the second level.

    • code

      string

      optional

      Possible values

      • enterprise_support:  Fixed or recurring enterprise support entitlement.
      • fde:  Full deployment environment or similar managed environment charge.
      • govcloud_management:  GovCloud-specific management or hosting charge.
      • file_ingestion_conversion:  Billing for the first successful conversion of a file version.
      • licensed_api_credits:  Contract-rated API usage credits.

    • display_name

      string

      optional

    • fixed_fee_amount

      number / USD Price

      optional

    • is_commitment_eligible

      boolean

      optional

    • kind

      string

      optional

      Possible values

      • fixed_fee:  A flat amount that does not vary with measured usage.
      • usage_tiered:  Usage is rated by one or more explicit pricing tiers.
      • usage_commitment_bucket:  Usage burns down a commitment bucket before any overage path.

    • rate_tiers

      array

      optional

      Array of

      • tier_end_exclusive

        integer

        optional

      • tier_start_inclusive

        integer

        optional

      • unit_price

        number / USD Price

        optional

    • unit

      string

      optional

      Possible values

      • file:  Quantity is counted in files.
      • minute:  Quantity is counted in whole or rounded minutes.
      • second:  Quantity is counted in seconds.
      • year:  Quantity is counted in years.
      • period:  Quantity is counted once per billing period.

  • name

    string

    optional

  • notes

    string

    optional

  • periods

    array

    optional

    Array of

    • commitment_amount

      number / USD Price

      optional

    • period_end_at

      string / ISO-8601

      optional

    • period_index

      integer

      optional

    • period_start_at

      string / ISO-8601

      optional

    • rollover_in_amount

      number / USD Price

      optional

    • rollover_out_amount

      number / USD Price

      optional

    • status

      string

      optional

      Possible values

      • open:  Period is active and may still accrue usage or adjustments.
      • closed:  Period is finalized and should be treated as read-only for billing purposes.

  • provider

    string

    optional

    Possible values

    • stripe:  Charges are ultimately collected through Stripe.
    • manual_invoice:  Charges are collected outside Stripe, usually by finance or contract workflow.

  • rollover_policy

    string

    optional

    Possible values

    • none:  Unused commitment expires at the end of the period.
    • year1_to_year2_once:  Unused year-one commitment may roll once into year two, but not beyond.

  • status

    string

    optional

    Possible values

    • draft:  Contract terms are still being assembled and should not drive billing yet.
    • scheduled:  Contract is committed for a future start date and should not drive billing yet.
    • active:  Contract is in force and may be used for rating and funding decisions.
    • closed:  Contract finished its intended term and is no longer accruing new periods.
    • canceled:  Contract was intentionally terminated before completing its intended term.

  • term_end_at

    string / ISO-8601

    optional

Returns

• 200 OK

  successful operation

  Name

  Type

  Req.

  body

  object

  optional

  Object Properties

  • account_id

    string / UUID

    optional

  • billing_cadence

    string

    optional

    Possible values

    • annual:  The contract is managed on an annual cycle.
    • quarterly:  The contract is managed on a quarterly cycle.
    • monthly:  The contract is managed on a monthly cycle.
    • manual:  The contract does not follow a fixed automated cadence.

  • commitment_scope

    string

    optional

    Possible values

    • pooled:  One shared commitment pool may fund multiple contract items.
    • per_item:  Each contract item effectively manages its own commitment budget.

  • contract_id

    string / UUID

    optional

  • currency

    string

    optional

  • discount_description

    string

    optional

  • effective_at

    string / ISO-8601

    optional

  • external_customer_id

    string

    optional

  • items

    array

    optional

    Array of

    • active

      boolean

      optional

    • billing_unit_granularity

      string

      optional

      Possible values

      • minute:  Usage should be normalized or rounded at the minute level.
      • second:  Usage should be normalized or rounded at the second level.

    • code

      string

      optional

      Possible values

      • enterprise_support:  Fixed or recurring enterprise support entitlement.
      • fde:  Full deployment environment or similar managed environment charge.
      • govcloud_management:  GovCloud-specific management or hosting charge.
      • file_ingestion_conversion:  Billing for the first successful conversion of a file version.
      • licensed_api_credits:  Contract-rated API usage credits.

    • display_name

      string

      optional

    • fixed_fee_amount

      number / USD Price

      optional

    • id

      string / UUID

      optional

    • is_commitment_eligible

      boolean

      optional

    • kind

      string

      optional

      Possible values

      • fixed_fee:  A flat amount that does not vary with measured usage.
      • usage_tiered:  Usage is rated by one or more explicit pricing tiers.
      • usage_commitment_bucket:  Usage burns down a commitment bucket before any overage path.

    • rate_tiers

      array

      optional

      Array of

      • id

        string / UUID

        optional

      • tier_end_exclusive

        integer

        optional

      • tier_start_inclusive

        integer

        optional

      • unit_price

        number / USD Price

        optional

    • unit

      string

      optional

      Possible values

      • file:  Quantity is counted in files.
      • minute:  Quantity is counted in whole or rounded minutes.
      • second:  Quantity is counted in seconds.
      • year:  Quantity is counted in years.
      • period:  Quantity is counted once per billing period.

  • name

    string

    optional

  • notes

    string

    optional

  • periods

    array

    optional

    Array of

    • commitment_amount

      number / USD Price

      optional

    • id

      string / UUID

      optional

    • period_end_at

      string / ISO-8601

      optional

    • period_index

      integer

      optional

    • period_start_at

      string / ISO-8601

      optional

    • rollover_in_amount

      number / USD Price

      optional

    • rollover_out_amount

      number / USD Price

      optional

    • status

      string

      optional

      Possible values

      • open:  Period is active and may still accrue usage or adjustments.
      • closed:  Period is finalized and should be treated as read-only for billing purposes.

  • provider

    string

    optional

    Possible values

    • stripe:  Charges are ultimately collected through Stripe.
    • manual_invoice:  Charges are collected outside Stripe, usually by finance or contract workflow.

  • rollover_policy

    string

    optional

    Possible values

    • none:  Unused commitment expires at the end of the period.
    • year1_to_year2_once:  Unused year-one commitment may roll once into year two, but not beyond.

  • status

    string

    optional

    Possible values

    • draft:  Contract terms are still being assembled and should not drive billing yet.
    • scheduled:  Contract is committed for a future start date and should not drive billing yet.
    • active:  Contract is in force and may be used for rating and funding decisions.
    • closed:  Contract finished its intended term and is no longer accruing new periods.
    • canceled:  Contract was intentionally terminated before completing its intended term.

  • term_end_at

    string / ISO-8601

    optional