Skip to main content
POST
Quote a change

Authorizations

Authorization
string
header
required

An API token from API tokens in the console, sent as Authorization: Bearer pgapi_.... It works for one billing account, and its permissions decide which endpoints it may call.

Path Parameters

service
string
required

Body

application/json

One change to a service, as the console offers it: a new package (product), new option choices (options), a new billing cycle (cycle), an addon to add (addon, with quantity), or an addon's quantity (quantity with addon_service). The ids are the ones GET /services/{service}/change-options gives; a quote says whether the change is possible.

addon_service
string | null

The addon service the change is about (a quantity change); the service itself when left out.

Required string length: 26
product
string | null

The package to move to.

Required string length: 26
options
string[] | null

Option id => value id (select), a number (quantity) or true/false (yes/no). Options not given keep their choice.

cycle
enum<string> | null

How often a service is billed: once (one_time, never renewed), or every month, three months, six months or year.

Available options:
one_time,
monthly,
quarterly,
semi_annually,
annually
addon
string | null

An addon to add.

Required string length: 26
quantity
integer | null
Required range: 1 <= x <= 1000
promo_code
string | null
Maximum string length: 64

Response

ServiceChangeQuoteResource

data
ServiceChangeQuoteResource · object
required