Create a product group

cURL

curl -X POST \
 /catalogue/product-groups \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{"name": "SaaS Packages", "enabled": true}'

import requests

url = "https://coreapi.io/catalogue/product-groups"

payload = {
    "name": "SaaS Packages",
    "enabled": True,
    "forceSameBillingInterval": False,
    "memberships": [
        {
            "product": "/api/products/uuid",
            "pricePlans": ["/api/plans/uuid"],
            "position": 123,
            "upgradeable": True,
            "downgradeable": True,
            "label": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'SaaS Packages',
    enabled: true,
    forceSameBillingInterval: false,
    memberships: [
      {
        product: '/api/products/uuid',
        pricePlans: ['/api/plans/uuid'],
        position: 123,
        upgradeable: true,
        downgradeable: true,
        label: '<string>'
      }
    ]
  })
};

fetch('https://coreapi.io/catalogue/product-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/catalogue/product-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'SaaS Packages',
    'enabled' => true,
    'forceSameBillingInterval' => false,
    'memberships' => [
        [
                'product' => '/api/products/uuid',
                'pricePlans' => [
                                '/api/plans/uuid'
                ],
                'position' => 123,
                'upgradeable' => true,
                'downgradeable' => true,
                'label' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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}'

import requests

url = "https://coreapi.io/catalogue/product-groups"

payload = {
    "name": "SaaS Packages",
    "enabled": True,
    "forceSameBillingInterval": False,
    "memberships": [
        {
            "product": "/api/products/uuid",
            "pricePlans": ["/api/plans/uuid"],
            "position": 123,
            "upgradeable": True,
            "downgradeable": True,
            "label": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'SaaS Packages',
    enabled: true,
    forceSameBillingInterval: false,
    memberships: [
      {
        product: '/api/products/uuid',
        pricePlans: ['/api/plans/uuid'],
        position: 123,
        upgradeable: true,
        downgradeable: true,
        label: '<string>'
      }
    ]
  })
};

fetch('https://coreapi.io/catalogue/product-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/catalogue/product-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'SaaS Packages',
    'enabled' => true,
    'forceSameBillingInterval' => false,
    'memberships' => [
        [
                'product' => '/api/products/uuid',
                'pricePlans' => [
                                '/api/plans/uuid'
                ],
                'position' => 123,
                'upgradeable' => true,
                'downgradeable' => true,
                'label' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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
    }
  ],
  "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:

Type	Description
`pro_rata`	Credit based on remaining days
`full`	Full period credit
`last_invoiced`	Credit of last invoice amount
`none`	No 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[]

Show child attributes

Antwort

ProductGroup resource created

A product group for up- and downgrades

string

read-only

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[]

Show child attributes

createdAt

string<date-time>

read-only

updatedAt

string<date-time>

read-only

Get product groups Get a product group

API documentation

User

Tenant

Customer

Catalogue

Subscription

Invoice

Payment

Dunning

Offer

Checkout

Feature & Entitlement

Analytics

Accounting

Settings

Create a product group

Memberships

Change Timing

Credit Types

Autorisierungen

Body

Antwort

​Memberships

​Change Timing

​Credit Types

Autorisierungen

Body

Antwort

Memberships

Change Timing

Credit Types