Zum Hauptinhalt springen
POST
/
catalogue
/
product-groups
cURL
curl -X POST \
 /catalogue/product-groups \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{"name": "SaaS Packages", "enabled": true}'
{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "name": "SaaS Packages",
  "enabled": true,
  "forceSameBillingInterval": false,
  "memberships": [
    {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "product": "<unknown>",
      "pricePlans": [
        "<unknown>"
      ],
      "position": 123,
      "label": "Pro",
      "upgradeable": true,
      "downgradeable": true,
      "changeTiming": "immediately",
      "creditType": "full"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Create a new product group for up- and downgrades.

​
Memberships

Each membership represents a tier in the product group. The position field determines the upgrade/downgrade direction:
  • Higher position = upgrade target
  • Lower position = downgrade target

​
Change Timing

  • immediately: Change takes effect right away, credit is issued based on creditType
  • end_of_period: Change takes effect at end of current billing period, no credit issued

​
Credit Types

Only applicable when changeTiming is immediately:
TypeDescription
pro_rataCredit based on remaining days
fullFull period credit
last_invoicedCredit of last invoice amount
noneNo credit

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The new ProductGroup resource

Create or update a product group

​
name
string
erforderlich
Beispiel:

"SaaS Packages"

​
enabled
boolean
erforderlich
Beispiel:

true

​
forceSameBillingInterval
boolean
Beispiel:

false

​
memberships
object[]

Antwort

ProductGroup resource created

A product group for up- and downgrades

​
id
string
Beispiel:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

​
name
string
Beispiel:

"SaaS Packages"

​
enabled
boolean
Beispiel:

true

​
forceSameBillingInterval
boolean

If true, customers can only switch between plans with the same billing interval

Beispiel:

false

​
memberships
object[]
​
createdAt
string<date-time>
​
updatedAt
string<date-time>