Skip to main content
GET
/
rr
/
api
/
v1
/
contracts
/
{contract_id}
/
usage
/
{usage_id}
/
allocations
Get Bundle Allocations
curl --request GET \
  --url https://api.meetcampfire.com/rr/api/v1/contracts/{contract_id}/usage/{usage_id}/allocations \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "source_bundle": 123,
  "source_bundle_name": "<string>",
  "total_amount": 0,
  "currency": "<string>",
  "lines": [
    {
      "id": 123,
      "product": 123,
      "product_name": "<string>",
      "product_id_str": "<string>",
      "amount": 0,
      "percentage": "<string>",
      "original_percentage": 0
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "license_term_start_date": "2023-12-25"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
contract_id
integer
required
​
usage_id
integer
required

Response

200 - application/json

Serializer for ContractProductBundle with nested lines.

Used for retrieving and updating contract-specific bundle allocations. When updating, validates that line amounts sum to total_amount.

​
id
integer
required
read-only
​
source_bundle
integer | null
required
read-only

Original ProductBundle template this was created from

​
source_bundle_name
string | null
required
read-only
​
total_amount
number<double>
required
read-only

Total amount to be allocated across products

Required range: -1000000000000000000 < x < 1000000000000000000
​
currency
string
required
read-only
​
lines
object[]
required
​
created_at
string<date-time>
required
read-only
​
last_modified_at
string<date-time>
required
read-only
​
license_term_start_date
string<date> | null

Date the license/service term begins. For SF-ingested mixed bundles, drives the linked subscription start_date and milestone milestone_date. Snapshotted at ingest time for audit.