Skip to main content
POST
Attach subscriptions to contract

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Input for attaching existing custom subscriptions to a contract.

subscriptions
ContractSubscriptionEntry · object[]
subscriptionIds
string[]

Shorthand for attaching existing custom subscriptions by ref ID. Added to what the contract already carries — the set is never replaced. To provision a new subscription into the contract, send it in subscriptions as a newSubscription entry instead.

Shorthand for attaching existing custom subscriptions by ref ID. Added to what the contract already carries — the set is never replaced. To provision a new subscription into the contract, send it in subscriptions as a newSubscription entry instead.

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Response

The contract, including its full set of attached subscriptions.

Response object

data
Contract · object
required

A billing contract as reported by the connected billing provider.