Skip to content
/
Create Project Offering

Create Project Offering

Request

Creates a new Project Offering for the specified Project. Additional configuration for certain Billing Models are optional.

Security
ApiKey
Path
project_idstring, (uuid)required

The ID of the Project, to which this Project Offering belongs.

Body
namestringrequired

The name for the Project Offering.

billing_modelstring(BillingModel)required

The Billing Model for the Project Offering.

Enum:"fixed_bid""time_materials""retainer""non_billable""investment""admin"
billing_model_options(BillingModelOptionsFixedBid (object or null)) or (BillingModelOptionsRetainer (object or null)) or (BillingModelOptionsTimeMaterials (object or null))
One of:

Additional Billing Model configuration for the Project Offering.

external_idsArray of strings or null

Optional list of custom external IDs to associate with the Project Offering at creation time. Each ID must not start with a reserved 'px_' provider prefix and must be unique across all Project Offerings in the organization. Forward slashes (/) are not supported.

service_offering_idstring or null, (uuid)

The ID of an existing Service Offering to copy roles, plan allocations, and tags from. The Project Offering's name and billing model still come from this request.

curl -i -X POST \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{project_id}/offerings' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "billing_model": "fixed_bid",
    "billing_model_options": {
      "service_fee": {
        "currency_code": "string",
        "amount": 0
      },
      "billing_model": "fixed_bid"
    },
    "external_ids": [
      "string"
    ],
    "service_offering_id": "74e05bad-7c5b-47db-a276-199b5b3f22ea"
  }'

Responses

Created

Bodyapplication/json
idstring, (uuid)required

The unique identifier for the Project Offering.

namestringrequired

The name of the Project Offering.

billing_modelstring(BillingModel)required

The billing model applied to the Project Offering. This is restricted by the Project's Project Type. Client projects support Time & Materials, Fixed Bid, and Fixed Retainer billing models while Internal projects only allow Investment and Admin models

Enum:"fixed_bid""time_materials""retainer""non_billable""investment""admin"
billing_model_optionsBillingModelOptionsFixedBid (object) or BillingModelOptionsRetainer (object) or BillingModelOptionsTimeMaterials (object)required
One of:

Additional Billing Model configuration for the Project Offering.

external_idsArray of stringsrequired

All external IDs associated with the Project Offering. Parallax-managed integrations use the delimited format 'px_{provider}:{id}' (e.g., 'px_harvest:12345678901').

tagsArray of stringsrequired

A list of tags assigned to the Project Offering for filtering, categorization, or reporting.

service_offering_idstring or null, (uuid)

The ID of the Service Offering this Project Offering was linked to, if any.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "billing_model": "fixed_bid",
  "billing_model_options": {
    "service_fee": { … },
    "billing_model": "fixed_bid"
  },
  "external_ids": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "service_offering_id": "74e05bad-7c5b-47db-a276-199b5b3f22ea"
}