Skip to main content
POST
Edit contract billing in place

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

Options for amending a contract whose billing is already live.

includeCurrentInvoice
boolean

Whether the amendment lands on the invoice currently open rather than the next one. A commercial choice, so there is no default.

Response

The contract, which remains active with the amendment applied.

Response object

data
Contract · object
required

A billing contract as reported by the connected billing provider.